From 97612a6bafb40464126794b8d671c48203c26134 Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Wed, 13 May 2020 08:50:07 -0700 Subject: [PATCH] feat!: run the generator --- discovery/abusiveexperiencereport-v1.json | 2 +- discovery/acceleratedmobilepageurl-v1.json | 2 +- discovery/accessapproval-v1.json | 2 +- discovery/accessapproval-v1beta1.json | 2 +- discovery/adexchangebuyer2-v2beta1.json | 14 +- discovery/adexperiencereport-v1.json | 2 +- discovery/admob-v1.json | 2 +- discovery/adsense-v1.4.json | 2 +- discovery/adsensehost-v4.1.json | 2 +- discovery/alertcenter-v1beta1.json | 2 +- discovery/androiddeviceprovisioning-v1.json | 2 +- discovery/androidenterprise-v1.json | 4 +- discovery/androidpublisher-v1.1.json | 4 +- discovery/androidpublisher-v1.json | 4 +- discovery/androidpublisher-v2.json | 4 +- discovery/androidpublisher-v3.json | 4 +- discovery/appsactivity-v1.json | 4 +- discovery/bigquery-v2.json | 284 +++- discovery/bigqueryconnection-v1beta1.json | 10 +- discovery/bigquerydatatransfer-v1.json | 2 +- discovery/bigtableadmin-v1.json | 4 +- discovery/bigtableadmin-v2.json | 20 +- discovery/billingbudgets-v1beta1.json | 2 +- discovery/binaryauthorization-v1.json | 2 +- discovery/binaryauthorization-v1beta1.json | 2 +- discovery/blogger-v2.json | 2 +- discovery/blogger-v3.json | 2 +- discovery/calendar-v3.json | 4 +- discovery/chat-v1.json | 14 +- discovery/classroom-v1.json | 2 +- discovery/cloudasset-v1.json | 2 +- discovery/cloudasset-v1beta1.json | 2 +- discovery/cloudasset-v1p1beta1.json | 2 +- discovery/cloudasset-v1p4beta1.json | 2 +- discovery/cloudbilling-v1.json | 2 +- discovery/cloudbuild-v1.json | 4 +- discovery/cloudbuild-v1alpha1.json | 2 +- discovery/cloudbuild-v1alpha2.json | 2 +- discovery/clouddebugger-v2.json | 4 +- discovery/cloudfunctions-v1.json | 12 +- discovery/cloudfunctions-v1beta2.json | 2 +- discovery/cloudidentity-v1.json | 2 +- discovery/cloudidentity-v1beta1.json | 20 +- discovery/cloudprofiler-v2.json | 2 +- discovery/cloudresourcemanager-v1.json | 10 +- discovery/cloudresourcemanager-v1beta1.json | 10 +- discovery/cloudresourcemanager-v2.json | 10 +- discovery/cloudresourcemanager-v2beta1.json | 10 +- discovery/cloudscheduler-v1.json | 2 +- discovery/cloudscheduler-v1beta1.json | 2 +- discovery/cloudshell-v1.json | 8 +- discovery/cloudshell-v1alpha1.json | 8 +- discovery/cloudtasks-v2.json | 10 +- discovery/cloudtasks-v2beta2.json | 10 +- discovery/cloudtasks-v2beta3.json | 10 +- discovery/cloudtrace-v1.json | 2 +- discovery/cloudtrace-v2.json | 2 +- discovery/cloudtrace-v2beta1.json | 2 +- discovery/commentanalyzer-v1alpha1.json | 459 ------ discovery/container-v1.json | 128 +- discovery/container-v1beta1.json | 132 +- discovery/containeranalysis-v1alpha1.json | 10 +- discovery/containeranalysis-v1beta1.json | 2 +- discovery/content-v2.1.json | 4 +- discovery/content-v2.json | 4 +- discovery/customsearch-v1.json | 1239 ++++++++++------- discovery/datacatalog-v1beta1.json | 24 +- discovery/dialogflow-v2.json | 62 +- discovery/dialogflow-v2beta1.json | 94 +- discovery/discovery-v1.json | 4 +- discovery/displayvideo-v1.json | 7 +- discovery/dlp-v2.json | 6 +- discovery/docs-v1.json | 2 +- discovery/domainsrdap-v1.json | 2 +- discovery/doubleclicksearch-v2.json | 4 +- discovery/drive-v2.json | 4 +- discovery/drive-v3.json | 4 +- discovery/driveactivity-v2.json | 2 +- discovery/factchecktools-v1alpha1.json | 2 +- discovery/fcm-v1.json | 2 +- discovery/firebase-v1beta1.json | 4 +- discovery/firebasedynamiclinks-v1.json | 2 +- discovery/firebaseml-v1beta2.json | 2 +- discovery/firebaserules-v1.json | 2 +- discovery/fitness-v1.json | 4 +- .../gamesConfiguration-v1configuration.json | 2 +- discovery/gameservices-v1beta.json | 198 +-- discovery/genomics-v1.json | 2 +- discovery/genomics-v1alpha2.json | 2 +- discovery/genomics-v2alpha1.json | 2 +- discovery/gmail-v1.json | 4 +- discovery/healthcare-v1.json | 90 +- discovery/healthcare-v1beta1.json | 104 +- discovery/homegraph-v1.json | 2 +- discovery/iamcredentials-v1.json | 2 +- discovery/iap-v1.json | 22 +- discovery/iap-v1beta1.json | 12 +- discovery/index.json | 15 - discovery/indexing-v3.json | 2 +- discovery/jobs-v2.json | 2 +- discovery/jobs-v3.json | 4 +- discovery/jobs-v3p1beta1.json | 2 +- discovery/kgsearch-v1.json | 2 +- discovery/language-v1.json | 2 +- discovery/language-v1beta1.json | 2 +- discovery/language-v1beta2.json | 2 +- discovery/libraryagent-v1.json | 2 +- discovery/lifesciences-v2beta.json | 2 +- discovery/logging-v2.json | 40 +- discovery/manufacturers-v1.json | 2 +- discovery/memcache-v1beta2.json | 16 +- discovery/monitoring-v1.json | 2 +- discovery/monitoring-v3.json | 43 +- discovery/networkmanagement-v1beta1.json | 40 +- discovery/osconfig-v1.json | 34 +- discovery/osconfig-v1beta.json | 20 +- discovery/oslogin-v1.json | 2 +- discovery/oslogin-v1alpha.json | 2 +- discovery/oslogin-v1beta.json | 2 +- discovery/pagespeedonline-v1.json | 419 ------ discovery/people-v1.json | 2 +- discovery/policytroubleshooter-v1.json | 8 +- discovery/policytroubleshooter-v1beta.json | 8 +- discovery/poly-v1.json | 2 +- discovery/prod_tt_sasportal-v1alpha1.json | 2 +- discovery/pubsub-v1.json | 34 +- discovery/pubsub-v1beta1a.json | 2 +- discovery/pubsub-v1beta2.json | 20 +- discovery/recommender-v1beta1.json | 2 +- discovery/remotebuildexecution-v1.json | 8 +- discovery/remotebuildexecution-v1alpha.json | 8 +- discovery/remotebuildexecution-v2.json | 8 +- discovery/run-v1.json | 36 +- discovery/run-v1alpha1.json | 10 +- discovery/run-v1beta1.json | 2 +- discovery/runtimeconfig-v1.json | 2 +- discovery/runtimeconfig-v1beta1.json | 10 +- discovery/sasportal-v1alpha1.json | 2 +- discovery/searchconsole-v1.json | 2 +- discovery/serviceconsumermanagement-v1.json | 4 +- .../serviceconsumermanagement-v1beta1.json | 4 +- discovery/servicecontrol-v1.json | 2 +- discovery/servicedirectory-v1beta1.json | 10 +- discovery/servicemanagement-v1.json | 24 +- discovery/servicenetworking-v1.json | 4 +- discovery/servicenetworking-v1beta.json | 4 +- discovery/serviceusage-v1.json | 6 +- discovery/serviceusage-v1beta1.json | 4 +- discovery/sheets-v4.json | 4 +- discovery/slides-v1.json | 2 +- discovery/spanner-v1.json | 4 +- discovery/speech-v1.json | 2 +- discovery/speech-v1p1beta1.json | 6 +- discovery/speech-v2beta1.json | 2 +- discovery/storage-v1.json | 14 +- discovery/storage-v1beta2.json | 4 +- discovery/storagetransfer-v1.json | 2 +- discovery/streetviewpublish-v1.json | 2 +- discovery/tagmanager-v1.json | 4 +- discovery/tagmanager-v2.json | 4 +- discovery/testing-v1.json | 2 +- discovery/texttospeech-v1.json | 2 +- discovery/texttospeech-v1beta1.json | 2 +- discovery/toolresults-v1beta3.json | 4 +- discovery/translate-v3.json | 2 +- discovery/translate-v3beta1.json | 2 +- discovery/vault-v1.json | 4 +- discovery/youtubeAnalytics-v1.json | 2 +- discovery/youtubeAnalytics-v2.json | 2 +- discovery/youtubereporting-v1.json | 2 +- samples/test/test.samples.customsearch.js | 2 +- src/apis/adexchangebuyer2/v2beta1.ts | 4 + src/apis/bigquery/v2.ts | 579 ++++++++ src/apis/bigqueryconnection/v1beta1.ts | 8 +- src/apis/bigtableadmin/v2.ts | 16 +- src/apis/chat/v1.ts | 12 +- src/apis/cloudbuild/v1.ts | 2 +- src/apis/cloudfunctions/v1.ts | 16 +- src/apis/cloudidentity/v1beta1.ts | 13 + src/apis/cloudresourcemanager/v1.ts | 8 +- src/apis/cloudresourcemanager/v1beta1.ts | 8 +- src/apis/cloudresourcemanager/v2.ts | 8 +- src/apis/cloudresourcemanager/v2beta1.ts | 8 +- src/apis/cloudtasks/v2.ts | 8 +- src/apis/cloudtasks/v2beta2.ts | 8 +- src/apis/cloudtasks/v2beta3.ts | 8 +- src/apis/commentanalyzer/README.md | 47 - src/apis/commentanalyzer/index.ts | 37 - src/apis/commentanalyzer/package.json | 43 - src/apis/commentanalyzer/tsconfig.json | 10 - src/apis/commentanalyzer/v1alpha1.ts | 620 --------- src/apis/commentanalyzer/webpack.config.js | 69 - src/apis/container/v1.ts | 294 ++-- src/apis/container/v1beta1.ts | 302 ++-- src/apis/containeranalysis/v1alpha1.ts | 8 +- src/apis/customsearch/v1.ts | 1127 ++++++++++++--- src/apis/datacatalog/v1beta1.ts | 24 +- src/apis/dialogflow/v2.ts | 57 +- src/apis/dialogflow/v2beta1.ts | 129 +- src/apis/displayvideo/v1.ts | 4 + src/apis/dlp/v2.ts | 4 +- src/apis/firebase/v1beta1.ts | 2 +- src/apis/gameservices/v1beta.ts | 318 ++--- src/apis/healthcare/v1.ts | 215 +-- src/apis/healthcare/v1beta1.ts | 238 +--- src/apis/iap/v1.ts | 24 +- src/apis/iap/v1beta1.ts | 10 +- src/apis/index.ts | 3 - src/apis/jobs/v3.ts | 2 +- src/apis/logging/v2.ts | 38 +- src/apis/memcache/v1beta2.ts | 20 +- src/apis/monitoring/v3.ts | 26 +- src/apis/networkmanagement/v1beta1.ts | 48 +- src/apis/osconfig/v1.ts | 32 +- src/apis/osconfig/v1beta.ts | 18 +- src/apis/pagespeedonline/index.ts | 11 - src/apis/pagespeedonline/v1.ts | 366 ----- src/apis/policytroubleshooter/v1.ts | 6 +- src/apis/policytroubleshooter/v1beta.ts | 6 +- src/apis/pubsub/v1.ts | 54 +- src/apis/pubsub/v1beta2.ts | 30 +- src/apis/remotebuildexecution/v1.ts | 4 + src/apis/remotebuildexecution/v1alpha.ts | 5 + src/apis/remotebuildexecution/v2.ts | 4 + src/apis/run/v1.ts | 35 +- src/apis/run/v1alpha1.ts | 14 +- src/apis/runtimeconfig/v1beta1.ts | 14 +- src/apis/serviceconsumermanagement/v1.ts | 2 +- src/apis/serviceconsumermanagement/v1beta1.ts | 2 +- src/apis/servicedirectory/v1beta1.ts | 8 +- src/apis/servicemanagement/v1.ts | 22 +- src/apis/servicenetworking/v1.ts | 2 +- src/apis/servicenetworking/v1beta.ts | 2 +- src/apis/serviceusage/v1.ts | 8 +- src/apis/serviceusage/v1beta1.ts | 2 +- src/apis/spanner/v1.ts | 2 +- src/apis/speech/v1p1beta1.ts | 4 +- src/apis/storage/v1.ts | 2 + src/apis/vault/v1.ts | 2 +- src/index.ts | 2 - 240 files changed, 4418 insertions(+), 4848 deletions(-) delete mode 100644 discovery/commentanalyzer-v1alpha1.json delete mode 100644 discovery/pagespeedonline-v1.json delete mode 100644 src/apis/commentanalyzer/README.md delete mode 100644 src/apis/commentanalyzer/index.ts delete mode 100644 src/apis/commentanalyzer/package.json delete mode 100644 src/apis/commentanalyzer/tsconfig.json delete mode 100644 src/apis/commentanalyzer/v1alpha1.ts delete mode 100644 src/apis/commentanalyzer/webpack.config.js delete mode 100644 src/apis/pagespeedonline/v1.ts diff --git a/discovery/abusiveexperiencereport-v1.json b/discovery/abusiveexperiencereport-v1.json index 497315157bd..9b72cb89fc0 100644 --- a/discovery/abusiveexperiencereport-v1.json +++ b/discovery/abusiveexperiencereport-v1.json @@ -139,7 +139,7 @@ } } }, - "revision": "20200426", + "revision": "20200504", "rootUrl": "https://abusiveexperiencereport.googleapis.com/", "schemas": { "SiteSummaryResponse": { diff --git a/discovery/acceleratedmobilepageurl-v1.json b/discovery/acceleratedmobilepageurl-v1.json index b52c230a87c..1625bd16737 100644 --- a/discovery/acceleratedmobilepageurl-v1.json +++ b/discovery/acceleratedmobilepageurl-v1.json @@ -115,7 +115,7 @@ } } }, - "revision": "20200502", + "revision": "20200511", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "schemas": { "AmpUrl": { diff --git a/discovery/accessapproval-v1.json b/discovery/accessapproval-v1.json index b36a8692324..4f75ff157bf 100644 --- a/discovery/accessapproval-v1.json +++ b/discovery/accessapproval-v1.json @@ -754,7 +754,7 @@ } } }, - "revision": "20200424", + "revision": "20200501", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalSettings": { diff --git a/discovery/accessapproval-v1beta1.json b/discovery/accessapproval-v1beta1.json index 83738786c24..dd33709c046 100644 --- a/discovery/accessapproval-v1beta1.json +++ b/discovery/accessapproval-v1beta1.json @@ -754,7 +754,7 @@ } } }, - "revision": "20200424", + "revision": "20200501", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalSettings": { diff --git a/discovery/adexchangebuyer2-v2beta1.json b/discovery/adexchangebuyer2-v2beta1.json index 6c89ba0c02e..706a2e85cd9 100644 --- a/discovery/adexchangebuyer2-v2beta1.json +++ b/discovery/adexchangebuyer2-v2beta1.json @@ -2486,7 +2486,7 @@ } } }, - "revision": "20200505", + "revision": "20200509", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { @@ -2660,6 +2660,10 @@ "$ref": "MetricValue", "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)." }, + "reachedQueries": { + "$ref": "MetricValue", + "description": "The number of bids that won the auction and also won the mediation\nwaterfall (if any)." + }, "rowDimensions": { "$ref": "RowDimensions", "description": "The values of all dimensions associated with metric values in this row." @@ -4963,12 +4967,16 @@ "enum": [ "STATUS_UNSPECIFIED", "AD_NOT_RENDERED", - "INVALID_IMPRESSION" + "INVALID_IMPRESSION", + "FATAL_VAST_ERROR", + "LOST_IN_MEDIATION" ], "enumDescriptions": [ "A placeholder for an undefined status.\nThis value will never be returned in responses.", "The buyer was not billed because the ad was not rendered by the\npublisher.", - "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid." + "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid.", + "A video impression was served but a fatal error was reported from the\nclient during playback.", + "The buyer was not billed because the ad was outplaced in the mediation\nwaterfall." ], "type": "string" } diff --git a/discovery/adexperiencereport-v1.json b/discovery/adexperiencereport-v1.json index 06d283f9d06..6c1077caeff 100644 --- a/discovery/adexperiencereport-v1.json +++ b/discovery/adexperiencereport-v1.json @@ -138,7 +138,7 @@ } } }, - "revision": "20200426", + "revision": "20200504", "rootUrl": "https://adexperiencereport.googleapis.com/", "schemas": { "PlatformSummary": { diff --git a/discovery/admob-v1.json b/discovery/admob-v1.json index d3f88f4efe8..1357777d069 100644 --- a/discovery/admob-v1.json +++ b/discovery/admob-v1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20200429", + "revision": "20200512", "rootUrl": "https://admob.googleapis.com/", "schemas": { "Date": { diff --git a/discovery/adsense-v1.4.json b/discovery/adsense-v1.4.json index eec65b553c4..3cf6e4447bb 100644 --- a/discovery/adsense-v1.4.json +++ b/discovery/adsense-v1.4.json @@ -1654,7 +1654,7 @@ } } }, - "revision": "20200505", + "revision": "20200512", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/adsensehost-v4.1.json b/discovery/adsensehost-v4.1.json index 5698def6ce6..4abb5fdabee 100644 --- a/discovery/adsensehost-v4.1.json +++ b/discovery/adsensehost-v4.1.json @@ -1076,7 +1076,7 @@ } } }, - "revision": "20200505", + "revision": "20200513", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/alertcenter-v1beta1.json b/discovery/alertcenter-v1beta1.json index 0a27efd5bcd..42e5f19e9dd 100644 --- a/discovery/alertcenter-v1beta1.json +++ b/discovery/alertcenter-v1beta1.json @@ -423,7 +423,7 @@ } } }, - "revision": "20200502", + "revision": "20200509", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AccountWarning": { diff --git a/discovery/androiddeviceprovisioning-v1.json b/discovery/androiddeviceprovisioning-v1.json index 41661a96669..82e761d717e 100644 --- a/discovery/androiddeviceprovisioning-v1.json +++ b/discovery/androiddeviceprovisioning-v1.json @@ -825,7 +825,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { diff --git a/discovery/androidenterprise-v1.json b/discovery/androidenterprise-v1.json index d340aa17297..fe9d00a74b8 100644 --- a/discovery/androidenterprise-v1.json +++ b/discovery/androidenterprise-v1.json @@ -15,7 +15,7 @@ "description": "Manages the deployment of apps to Android for Work users.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/android/work/play/emm-api", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/60MUgYNvBkaYyKwPOXrNQN9mD0U\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/i4NjzneJMSibgNsZXFFIJfd2Chs\"", "icons": { "x16": "https://www.google.com/images/icons/product/android-16.png", "x32": "https://www.google.com/images/icons/product/android-32.png" @@ -2556,7 +2556,7 @@ } } }, - "revision": "20200427", + "revision": "20200429", "rootUrl": "https://www.googleapis.com/", "schemas": { "Administrator": { diff --git a/discovery/androidpublisher-v1.1.json b/discovery/androidpublisher-v1.1.json index 8d6a40a250f..87b73bbb466 100644 --- a/discovery/androidpublisher-v1.1.json +++ b/discovery/androidpublisher-v1.1.json @@ -15,7 +15,7 @@ "description": "Accesses Android application developers' Google Play accounts.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/android-publisher", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/wHt23iZe8Ye_ZkSeIpNeFO568Sc\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/wwgI4qhm-oeo38AtzHnqe4hFIOc\"", "icons": { "x16": "https://www.google.com/images/icons/product/android-16.png", "x32": "https://www.google.com/images/icons/product/android-32.png" @@ -114,7 +114,7 @@ } } }, - "revision": "20200428", + "revision": "20200505", "rootUrl": "https://www.googleapis.com/", "schemas": { "InappPurchase": { diff --git a/discovery/androidpublisher-v1.json b/discovery/androidpublisher-v1.json index 7a0d970f7bc..256f7a1391b 100644 --- a/discovery/androidpublisher-v1.json +++ b/discovery/androidpublisher-v1.json @@ -6,7 +6,7 @@ "description": "Accesses Android application developers' Google Play accounts.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/android-publisher", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/5DcidHqvUjZnLInf9deRmUk70R8\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/XguakTFQILlzz4m62-V3GT6_Uvo\"", "icons": { "x16": "https://www.google.com/images/icons/product/android-16.png", "x32": "https://www.google.com/images/icons/product/android-32.png" @@ -62,7 +62,7 @@ } }, "protocol": "rest", - "revision": "20200428", + "revision": "20200505", "rootUrl": "https://www.googleapis.com/", "servicePath": "", "title": "Google Play Developer API", diff --git a/discovery/androidpublisher-v2.json b/discovery/androidpublisher-v2.json index 7c61b4b5d1c..ac8e3e8337d 100644 --- a/discovery/androidpublisher-v2.json +++ b/discovery/androidpublisher-v2.json @@ -15,7 +15,7 @@ "description": "Accesses Android application developers' Google Play accounts.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/android-publisher", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/ry3Wzo7q_Cbb0sesBVF_0Z_jfxQ\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/wMks0fahxPxjXD8qD78UX__cDkg\"", "icons": { "x16": "https://www.google.com/images/icons/product/android-16.png", "x32": "https://www.google.com/images/icons/product/android-32.png" @@ -171,7 +171,7 @@ } } }, - "revision": "20200428", + "revision": "20200505", "rootUrl": "https://www.googleapis.com/", "schemas": { "PageInfo": { diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index f448307f42b..1498d853247 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -15,7 +15,7 @@ "description": "Accesses Android application developers' Google Play accounts.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/android-publisher", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/5ocisXdwit5hctWzufQPzR8_VBc\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/SetFLBXGvnz8NnoZq8WRUMdUaG4\"", "icons": { "x16": "https://www.google.com/images/icons/product/android-16.png", "x32": "https://www.google.com/images/icons/product/android-32.png" @@ -2555,7 +2555,7 @@ } } }, - "revision": "20200428", + "revision": "20200505", "rootUrl": "https://www.googleapis.com/", "schemas": { "Apk": { diff --git a/discovery/appsactivity-v1.json b/discovery/appsactivity-v1.json index 5396271401f..ef6e0d8e742 100644 --- a/discovery/appsactivity-v1.json +++ b/discovery/appsactivity-v1.json @@ -14,7 +14,7 @@ "description": "Provides a historical view of activity.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/google-apps/activity/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/8FwHHBTSR3nRjTjSTGz6TCVcKWk\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/YR-AxeO1KbdtGkLlRfHIthDd-DA\"", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -137,7 +137,7 @@ } } }, - "revision": "20200426", + "revision": "20200503", "rootUrl": "https://www.googleapis.com/", "schemas": { "Activity": { diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index 43728c1ca34..d09d493fddb 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -1265,6 +1265,37 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:getIamPolicy", + "httpMethod": "POST", + "id": "bigquery.tables.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "insert": { "description": "Creates a new, empty table in the dataset.", "httpMethod": "POST", @@ -1384,6 +1415,66 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:setIamPolicy", + "httpMethod": "POST", + "id": "bigquery.tables.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:testIamPermissions", + "httpMethod": "POST", + "id": "bigquery.tables.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "update": { "description": "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.", "httpMethod": "PUT", @@ -1428,7 +1519,7 @@ } } }, - "revision": "20200419", + "revision": "20200429", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -1681,6 +1772,54 @@ }, "type": "object" }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, "BigQueryModelTraining": { "id": "BigQueryModelTraining", "properties": { @@ -1855,6 +1994,28 @@ }, "type": "object" }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, "BqmlIterationResult": { "id": "BqmlIterationResult", "properties": { @@ -2599,6 +2760,29 @@ }, "type": "object" }, + "Expr": { + "description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language\nsyntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", + "type": "string" + } + }, + "type": "object" + }, "ExternalDataConfiguration": { "id": "ExternalDataConfiguration", "properties": { @@ -2673,6 +2857,29 @@ }, "type": "object" }, + "GetIamPolicyRequest": { + "description": "Request message for `GetIamPolicy` method.", + "id": "GetIamPolicyRequest", + "properties": { + "options": { + "$ref": "GetPolicyOptions", + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`." + } + }, + "type": "object" + }, + "GetPolicyOptions": { + "description": "Encapsulates settings provided to GetIamPolicy.", + "id": "GetPolicyOptions", + "properties": { + "requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GetQueryResultsResponse": { "id": "GetQueryResultsResponse", "properties": { @@ -3905,6 +4112,37 @@ }, "type": "object" }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "ProjectList": { "id": "ProjectList", "properties": { @@ -4500,6 +4738,22 @@ }, "type": "object" }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + }, + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "StandardSqlDataType": { "description": "The type of a variable, e.g., a function argument.\nExamples:\nINT64: {type_kind=\"INT64\"}\nARRAY: {type_kind=\"ARRAY\", array_element_type=\"STRING\"}\nSTRUCT>:\n {type_kind=\"STRUCT\",\n struct_type={fields=[\n {name=\"x\", type={type_kind=\"STRING\"}},\n {name=\"y\", type={type_kind=\"ARRAY\", array_element_type=\"DATE\"}}\n ]}}", "id": "StandardSqlDataType", @@ -5047,6 +5301,34 @@ }, "type": "object" }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TimePartitioning": { "id": "TimePartitioning", "properties": { diff --git a/discovery/bigqueryconnection-v1beta1.json b/discovery/bigqueryconnection-v1beta1.json index e27470c59b7..131dd6a593e 100644 --- a/discovery/bigqueryconnection-v1beta1.json +++ b/discovery/bigqueryconnection-v1beta1.json @@ -395,7 +395,7 @@ } } }, - "revision": "20200419", + "revision": "20200430", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { @@ -452,7 +452,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -609,7 +609,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -635,7 +635,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -658,7 +658,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index 34398d4fb6d..92c0b24ad87 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -1265,7 +1265,7 @@ } } }, - "revision": "20200408", + "revision": "20200502", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/discovery/bigtableadmin-v1.json b/discovery/bigtableadmin-v1.json index 999501fa19f..b8d71e7952b 100644 --- a/discovery/bigtableadmin-v1.json +++ b/discovery/bigtableadmin-v1.json @@ -96,7 +96,7 @@ }, "protocol": "rest", "resources": {}, - "revision": "20200421", + "revision": "20200424", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "Cluster": { @@ -288,7 +288,7 @@ "enumDescriptions": [ "The type of the instance is unspecified. If set when creating an\ninstance, a `PRODUCTION` instance will be created. If set when updating\nan instance, the type will be left unchanged.", "An instance meant for production use. `serve_nodes` must be set\non the cluster.", - "The instance is meant for development and testing purposes only; it has\nno performance or uptime guarantees and is not covered by SLA.\nAfter a development instance is created, it can be upgraded by\nupdating the instance to type `PRODUCTION`. An instance created\nas a production instance cannot be changed to a development instance.\nWhen creating a development instance, `serve_nodes` on the cluster must\nnot be set." + "DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces\na higher minimum node count than DEVELOPMENT." ], "type": "string" } diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index 7595f2de668..79dc6f1ccdd 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -143,7 +143,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^operations/.+$", + "pattern": "^operations/.*$", "required": true, "type": "string" } @@ -173,7 +173,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^operations/.+$", + "pattern": "^operations/.*$", "required": true, "type": "string" } @@ -203,7 +203,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^operations/.+$", + "pattern": "^operations/.*$", "required": true, "type": "string" } @@ -245,7 +245,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^operations/projects/.+$", + "pattern": "^operations/projects/.*$", "required": true, "type": "string" }, @@ -961,7 +961,7 @@ "backups": { "methods": { "getIamPolicy": { - "description": "Gets the access control policy for a Table or Backup resource.\nReturns an empty policy if the resource exists but does not have a policy\nset.", + "description": "Gets the access control policy for a Table resource.\nReturns an empty policy if the resource exists but does not have a policy\nset.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}:getIamPolicy", "httpMethod": "POST", "id": "bigtableadmin.projects.instances.clusters.backups.getIamPolicy", @@ -993,7 +993,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on a Table or Backup resource.\nReplaces any existing policy.", + "description": "Sets the access control policy on a Table resource.\nReplaces any existing policy.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}:setIamPolicy", "httpMethod": "POST", "id": "bigtableadmin.projects.instances.clusters.backups.setIamPolicy", @@ -1262,7 +1262,7 @@ ] }, "getIamPolicy": { - "description": "Gets the access control policy for a Table or Backup resource.\nReturns an empty policy if the resource exists but does not have a policy\nset.", + "description": "Gets the access control policy for a Table resource.\nReturns an empty policy if the resource exists but does not have a policy\nset.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:getIamPolicy", "httpMethod": "POST", "id": "bigtableadmin.projects.instances.tables.getIamPolicy", @@ -1379,7 +1379,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on a Table or Backup resource.\nReplaces any existing policy.", + "description": "Sets the access control policy on a Table resource.\nReplaces any existing policy.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:setIamPolicy", "httpMethod": "POST", "id": "bigtableadmin.projects.instances.tables.setIamPolicy", @@ -1531,7 +1531,7 @@ } } }, - "revision": "20200421", + "revision": "20200424", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2010,7 +2010,7 @@ "enumDescriptions": [ "The type of the instance is unspecified. If set when creating an\ninstance, a `PRODUCTION` instance will be created. If set when updating\nan instance, the type will be left unchanged.", "An instance meant for production use. `serve_nodes` must be set\non the cluster.", - "The instance is meant for development and testing purposes only; it has\nno performance or uptime guarantees and is not covered by SLA.\nAfter a development instance is created, it can be upgraded by\nupdating the instance to type `PRODUCTION`. An instance created\nas a production instance cannot be changed to a development instance.\nWhen creating a development instance, `serve_nodes` on the cluster must\nnot be set." + "DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces\na higher minimum node count than DEVELOPMENT." ], "type": "string" } diff --git a/discovery/billingbudgets-v1beta1.json b/discovery/billingbudgets-v1beta1.json index 1c3f4d24709..0d698c28966 100644 --- a/discovery/billingbudgets-v1beta1.json +++ b/discovery/billingbudgets-v1beta1.json @@ -256,7 +256,7 @@ } } }, - "revision": "20200426", + "revision": "20200502", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": { diff --git a/discovery/binaryauthorization-v1.json b/discovery/binaryauthorization-v1.json index f2f82bc07f6..b3bed0a8841 100644 --- a/discovery/binaryauthorization-v1.json +++ b/discovery/binaryauthorization-v1.json @@ -494,7 +494,7 @@ } } }, - "revision": "20200501", + "revision": "20200508", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/discovery/binaryauthorization-v1beta1.json b/discovery/binaryauthorization-v1beta1.json index cb73ab92ce1..b4b0c377fb5 100644 --- a/discovery/binaryauthorization-v1beta1.json +++ b/discovery/binaryauthorization-v1beta1.json @@ -494,7 +494,7 @@ } } }, - "revision": "20200501", + "revision": "20200508", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/discovery/blogger-v2.json b/discovery/blogger-v2.json index 61028b080e4..9a414641334 100644 --- a/discovery/blogger-v2.json +++ b/discovery/blogger-v2.json @@ -401,7 +401,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/discovery/blogger-v3.json b/discovery/blogger-v3.json index fe1b34d028f..156823deae2 100644 --- a/discovery/blogger-v3.json +++ b/discovery/blogger-v3.json @@ -1556,7 +1556,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/discovery/calendar-v3.json b/discovery/calendar-v3.json index b077ae18ddc..577c6e68f22 100644 --- a/discovery/calendar-v3.json +++ b/discovery/calendar-v3.json @@ -26,7 +26,7 @@ "description": "Manipulates events and other calendar data.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/google-apps/calendar/firstapp", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/ec22hi9jBIRxWxCoPiZbFINc_VE\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/9DzaytSdmaQ1zkNc9P_nvRDhSF0\"", "icons": { "x16": "http://www.google.com/images/icons/product/calendar-16.png", "x32": "http://www.google.com/images/icons/product/calendar-32.png" @@ -1724,7 +1724,7 @@ } } }, - "revision": "20200428", + "revision": "20200503", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index d6ba4de6448..a2f87a88689 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -317,7 +317,7 @@ } } }, - "revision": "20200425", + "revision": "20200508", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -970,8 +970,16 @@ "description": "Resource name of the space, in the form \"spaces/*\".\n\nExample: spaces/AAAAMpdlehYs", "type": "string" }, + "singleUserBotDm": { + "description": "Whether the space is a DM between a bot and a single human.", + "type": "boolean" + }, + "threaded": { + "description": "Whether the messages are threaded in this space.", + "type": "boolean" + }, "type": { - "description": "Output only. The type of a space.", + "description": "Output only. The type of a space.\nThis is deprecated. Use `single_user_bot_dm` instead.", "enum": [ "TYPE_UNSPECIFIED", "ROOM", @@ -979,7 +987,7 @@ ], "enumDescriptions": [ "", - "A chat space where memberships are free to change. Messages in rooms are\nthreaded.", + "Multi-user spaces such as rooms and DMs between humans.", "1:1 Direct Message between a human and a bot, where all messages are\nflat." ], "type": "string" diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 24be68df0a3..a0521d356da 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -2153,7 +2153,7 @@ } } }, - "revision": "20200429", + "revision": "20200509", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "Announcement": { diff --git a/discovery/cloudasset-v1.json b/discovery/cloudasset-v1.json index f31bac59c95..a5679e62e57 100644 --- a/discovery/cloudasset-v1.json +++ b/discovery/cloudasset-v1.json @@ -357,7 +357,7 @@ } } }, - "revision": "20200410", + "revision": "20200508", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "Asset": { diff --git a/discovery/cloudasset-v1beta1.json b/discovery/cloudasset-v1beta1.json index cbfd597ec68..8335e9303b7 100644 --- a/discovery/cloudasset-v1beta1.json +++ b/discovery/cloudasset-v1beta1.json @@ -401,7 +401,7 @@ } } }, - "revision": "20200410", + "revision": "20200508", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "Asset": { diff --git a/discovery/cloudasset-v1p1beta1.json b/discovery/cloudasset-v1p1beta1.json index 5b125a487db..52129052169 100644 --- a/discovery/cloudasset-v1p1beta1.json +++ b/discovery/cloudasset-v1p1beta1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20200410", + "revision": "20200508", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/cloudasset-v1p4beta1.json b/discovery/cloudasset-v1p4beta1.json index db80eca48e8..a2446dce3ff 100644 --- a/discovery/cloudasset-v1p4beta1.json +++ b/discovery/cloudasset-v1p4beta1.json @@ -221,7 +221,7 @@ } } }, - "revision": "20200410", + "revision": "20200508", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { diff --git a/discovery/cloudbilling-v1.json b/discovery/cloudbilling-v1.json index 9d81e0f42e7..a9752e1b2fc 100644 --- a/discovery/cloudbilling-v1.json +++ b/discovery/cloudbilling-v1.json @@ -495,7 +495,7 @@ } } }, - "revision": "20200503", + "revision": "20200509", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index a0ea314ac59..598f255c181 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -574,7 +574,7 @@ } } }, - "revision": "20200410", + "revision": "20200506", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { @@ -1282,7 +1282,7 @@ "type": "string" }, "commentControl": { - "description": "Whether to block builds on a \"/gcbrun\" comment from a repository admin or\ncollaborator.", + "description": "Configure builds to run only when a repository owner or collaborator\ncomments `/gcbrun`.", "enum": [ "COMMENTS_DISABLED", "COMMENTS_ENABLED" diff --git a/discovery/cloudbuild-v1alpha1.json b/discovery/cloudbuild-v1alpha1.json index e31c2fc6a35..2ac2c355bd5 100644 --- a/discovery/cloudbuild-v1alpha1.json +++ b/discovery/cloudbuild-v1alpha1.json @@ -245,7 +245,7 @@ } } }, - "revision": "20200410", + "revision": "20200506", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { diff --git a/discovery/cloudbuild-v1alpha2.json b/discovery/cloudbuild-v1alpha2.json index 9cc06699afd..7e02090c1ea 100644 --- a/discovery/cloudbuild-v1alpha2.json +++ b/discovery/cloudbuild-v1alpha2.json @@ -256,7 +256,7 @@ } } }, - "revision": "20200410", + "revision": "20200506", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { diff --git a/discovery/clouddebugger-v2.json b/discovery/clouddebugger-v2.json index b30e243e54e..0182c75a596 100644 --- a/discovery/clouddebugger-v2.json +++ b/discovery/clouddebugger-v2.json @@ -439,7 +439,7 @@ } } }, - "revision": "20200410", + "revision": "20200501", "rootUrl": "https://clouddebugger.googleapis.com/", "schemas": { "AliasContext": { @@ -669,7 +669,7 @@ "CANARY_MODE_DEFAULT_DISABLED" ], "enumDescriptions": [ - "Before \"use_breakpoint_canary\" is deprecated:\n CANARY_MODE_UNSPECIFIED = use_breakpoint_canary ?\n CANARY_MODE_DEFAULT_ENABLED :\n CANARY_MODE_DEFAULT_DISABLED;\nAfter \"use_breakpoint_canary\" is deprecated:\n CANARY_MODE_UNSPECIFIED = CANARY_MODE_DEFAULT_ENABLED;", + "CANARY_MODE_UNSPECIFIED is equivalent to CANARY_MODE_ALWAYS_DISABLED so\nthat if the debuggee is not configured to use the canary feature, the\nfeature will be disabled.", "Always enable breakpoint canary regardless of the value of breakpoint's\ncanary option.", "Always disable breakpoint canary regardless of the value of breakpoint's\ncanary option.", "Depends on the breakpoint's canary option. Enable canary by default if\nthe breakpoint's canary option is not specified.", diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index 89e8fafcc60..4c47de48954 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -392,7 +392,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -546,7 +546,7 @@ } } }, - "revision": "20200430", + "revision": "20200510", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -603,7 +603,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1120,7 +1120,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -1143,7 +1143,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1165,7 +1165,7 @@ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." }, "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/cloudfunctions-v1beta2.json b/discovery/cloudfunctions-v1beta2.json index 56dd97c6692..e4e918aae5e 100644 --- a/discovery/cloudfunctions-v1beta2.json +++ b/discovery/cloudfunctions-v1beta2.json @@ -453,7 +453,7 @@ } } }, - "revision": "20200430", + "revision": "20200510", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "CallFunctionRequest": { diff --git a/discovery/cloudidentity-v1.json b/discovery/cloudidentity-v1.json index cbd6c42e334..411100e4b55 100644 --- a/discovery/cloudidentity-v1.json +++ b/discovery/cloudidentity-v1.json @@ -512,7 +512,7 @@ } } }, - "revision": "20200428", + "revision": "20200509", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "EntityKey": { diff --git a/discovery/cloudidentity-v1beta1.json b/discovery/cloudidentity-v1beta1.json index 0498963f3f4..cc606e62a30 100644 --- a/discovery/cloudidentity-v1beta1.json +++ b/discovery/cloudidentity-v1beta1.json @@ -550,7 +550,7 @@ } } }, - "revision": "20200428", + "revision": "20200509", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AndroidAttributes": { @@ -1164,6 +1164,24 @@ }, "type": "object" }, + "ListClientStatesResponse": { + "description": "Response message that is returned in LRO result of ListClientStates\nOperation.", + "id": "ListClientStatesResponse", + "properties": { + "clientStates": { + "description": "Client states meeting the list restrictions.", + "items": { + "$ref": "ClientState" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results. Empty if there are no more\nresults.", + "type": "string" + } + }, + "type": "object" + }, "ListDeviceUsersResponse": { "description": "Response message that is returned in LRO result of ListDeviceUsers Operation.", "id": "ListDeviceUsersResponse", diff --git a/discovery/cloudprofiler-v2.json b/discovery/cloudprofiler-v2.json index 89e2c98b83a..9370921b03e 100644 --- a/discovery/cloudprofiler-v2.json +++ b/discovery/cloudprofiler-v2.json @@ -216,7 +216,7 @@ } } }, - "revision": "20200413", + "revision": "20200504", "rootUrl": "https://cloudprofiler.googleapis.com/", "schemas": { "CreateProfileRequest": { diff --git a/discovery/cloudresourcemanager-v1.json b/discovery/cloudresourcemanager-v1.json index 942d2e2a9da..afa8fc8b5dd 100644 --- a/discovery/cloudresourcemanager-v1.json +++ b/discovery/cloudresourcemanager-v1.json @@ -1171,7 +1171,7 @@ } } }, - "revision": "20200415", + "revision": "20200504", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { @@ -1239,7 +1239,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1489,7 +1489,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1816,7 +1816,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -1839,7 +1839,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/cloudresourcemanager-v1beta1.json b/discovery/cloudresourcemanager-v1beta1.json index 52a036a3659..a5b7179e956 100644 --- a/discovery/cloudresourcemanager-v1beta1.json +++ b/discovery/cloudresourcemanager-v1beta1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20200415", + "revision": "20200504", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { @@ -634,7 +634,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -783,7 +783,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -880,7 +880,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -903,7 +903,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/cloudresourcemanager-v2.json b/discovery/cloudresourcemanager-v2.json index 19a7e7eb3aa..5f7f9286771 100644 --- a/discovery/cloudresourcemanager-v2.json +++ b/discovery/cloudresourcemanager-v2.json @@ -450,7 +450,7 @@ } } }, - "revision": "20200415", + "revision": "20200504", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -507,7 +507,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -668,7 +668,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -740,7 +740,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -763,7 +763,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/cloudresourcemanager-v2beta1.json b/discovery/cloudresourcemanager-v2beta1.json index 99ed164ee1c..9aa02e13252 100644 --- a/discovery/cloudresourcemanager-v2beta1.json +++ b/discovery/cloudresourcemanager-v2beta1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20200415", + "revision": "20200504", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -507,7 +507,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -668,7 +668,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -740,7 +740,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -763,7 +763,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/cloudscheduler-v1.json b/discovery/cloudscheduler-v1.json index 37acafec028..677bcbeedea 100644 --- a/discovery/cloudscheduler-v1.json +++ b/discovery/cloudscheduler-v1.json @@ -418,7 +418,7 @@ } } }, - "revision": "20200414", + "revision": "20200505", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/discovery/cloudscheduler-v1beta1.json b/discovery/cloudscheduler-v1beta1.json index 2e8eb962225..2cd5b1a6869 100644 --- a/discovery/cloudscheduler-v1beta1.json +++ b/discovery/cloudscheduler-v1beta1.json @@ -418,7 +418,7 @@ } } }, - "revision": "20200414", + "revision": "20200505", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/discovery/cloudshell-v1.json b/discovery/cloudshell-v1.json index 7f181b09676..4344ecd60bb 100644 --- a/discovery/cloudshell-v1.json +++ b/discovery/cloudshell-v1.json @@ -229,7 +229,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -300,13 +300,15 @@ "STATE_UNSPECIFIED", "DISABLED", "STARTING", - "RUNNING" + "RUNNING", + "DELETING" ], "enumDescriptions": [ "The environment's states is unknown.", "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", "The environment is being started but is not yet ready to accept\nconnections.", - "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started." + "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started.", + "The environment is being deleted and can't be connected to." ], "type": "string" }, diff --git a/discovery/cloudshell-v1alpha1.json b/discovery/cloudshell-v1alpha1.json index 3f3c6cd61c8..78f229598c0 100644 --- a/discovery/cloudshell-v1alpha1.json +++ b/discovery/cloudshell-v1alpha1.json @@ -288,7 +288,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AuthorizeEnvironmentRequest": { @@ -384,13 +384,15 @@ "STATE_UNSPECIFIED", "DISABLED", "STARTING", - "RUNNING" + "RUNNING", + "DELETING" ], "enumDescriptions": [ "The environment's states is unknown.", "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", "The environment is being started but is not yet ready to accept\nconnections.", - "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started." + "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started.", + "The environment is being deleted and can't be connected to." ], "type": "string" }, diff --git a/discovery/cloudtasks-v2.json b/discovery/cloudtasks-v2.json index 62c76599410..ef6d1aa7ae4 100644 --- a/discovery/cloudtasks-v2.json +++ b/discovery/cloudtasks-v2.json @@ -675,7 +675,7 @@ } } }, - "revision": "20200414", + "revision": "20200505", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { @@ -784,7 +784,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -870,7 +870,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1057,7 +1057,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -1073,7 +1073,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/cloudtasks-v2beta2.json b/discovery/cloudtasks-v2beta2.json index 6be83b697ec..317ce53cadb 100644 --- a/discovery/cloudtasks-v2beta2.json +++ b/discovery/cloudtasks-v2beta2.json @@ -793,7 +793,7 @@ } } }, - "revision": "20200414", + "revision": "20200505", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { @@ -921,7 +921,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1033,7 +1033,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1184,7 +1184,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -1200,7 +1200,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/cloudtasks-v2beta3.json b/discovery/cloudtasks-v2beta3.json index fbd8cb832a0..12be4c91994 100644 --- a/discovery/cloudtasks-v2beta3.json +++ b/discovery/cloudtasks-v2beta3.json @@ -675,7 +675,7 @@ } } }, - "revision": "20200414", + "revision": "20200505", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { @@ -795,7 +795,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -881,7 +881,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1068,7 +1068,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -1084,7 +1084,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/cloudtrace-v1.json b/discovery/cloudtrace-v1.json index 181eb83e34d..edcd39c8775 100644 --- a/discovery/cloudtrace-v1.json +++ b/discovery/cloudtrace-v1.json @@ -251,7 +251,7 @@ } } }, - "revision": "20200414", + "revision": "20200504", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/cloudtrace-v2.json b/discovery/cloudtrace-v2.json index 1c466d4d72e..313ae1b837b 100644 --- a/discovery/cloudtrace-v2.json +++ b/discovery/cloudtrace-v2.json @@ -181,7 +181,7 @@ } } }, - "revision": "20200414", + "revision": "20200504", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": { diff --git a/discovery/cloudtrace-v2beta1.json b/discovery/cloudtrace-v2beta1.json index d091e499e57..a33281a4870 100644 --- a/discovery/cloudtrace-v2beta1.json +++ b/discovery/cloudtrace-v2beta1.json @@ -273,7 +273,7 @@ } } }, - "revision": "20200414", + "revision": "20200504", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/commentanalyzer-v1alpha1.json b/discovery/commentanalyzer-v1alpha1.json deleted file mode 100644 index 1c9366139eb..00000000000 --- a/discovery/commentanalyzer-v1alpha1.json +++ /dev/null @@ -1,459 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/userinfo.email": { - "description": "View your email address" - } - } - } - }, - "basePath": "", - "baseUrl": "https://commentanalyzer.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Comment Analyzer", - "description": "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.", - "discoveryVersion": "v1", - "documentationLink": "https://github.com/conversationai/perspectiveapi/blob/master/README.md", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "commentanalyzer:v1alpha1", - "kind": "discovery#restDescription", - "mtlsRootUrl": "https://commentanalyzer.mtls.googleapis.com/", - "name": "commentanalyzer", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "description": "Data format for response.", - "enum": [ - "json", - "media", - "proto" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], - "location": "query", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", - "location": "query", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "comments": { - "methods": { - "analyze": { - "description": "Analyzes the provided text and returns scores for requested attributes.", - "flatPath": "v1alpha1/comments:analyze", - "httpMethod": "POST", - "id": "commentanalyzer.comments.analyze", - "parameterOrder": [], - "parameters": {}, - "path": "v1alpha1/comments:analyze", - "request": { - "$ref": "AnalyzeCommentRequest" - }, - "response": { - "$ref": "AnalyzeCommentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "suggestscore": { - "description": "Suggest comment scores as training data.", - "flatPath": "v1alpha1/comments:suggestscore", - "httpMethod": "POST", - "id": "commentanalyzer.comments.suggestscore", - "parameterOrder": [], - "parameters": {}, - "path": "v1alpha1/comments:suggestscore", - "request": { - "$ref": "SuggestCommentScoreRequest" - }, - "response": { - "$ref": "SuggestCommentScoreResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/userinfo.email" - ] - } - } - } - }, - "revision": "20200426", - "rootUrl": "https://commentanalyzer.googleapis.com/", - "schemas": { - "AnalyzeCommentRequest": { - "description": "The comment analysis request message.\nLINT.IfChange", - "id": "AnalyzeCommentRequest", - "properties": { - "clientToken": { - "description": "Opaque token that is echoed from the request to the response.", - "type": "string" - }, - "comment": { - "$ref": "TextEntry", - "description": "The comment to analyze." - }, - "communityId": { - "description": "Optional identifier associating this AnalyzeCommentRequest with a\nparticular client's community. Different communities may have different\nnorms and rules. Specifying this value enables us to explore building\ncommunity-specific models for clients.", - "type": "string" - }, - "context": { - "$ref": "Context", - "description": "The context of the comment." - }, - "doNotStore": { - "description": "Do not store the comment or context sent in this request. By default, the\nservice may store comments/context for debugging purposes.", - "type": "boolean" - }, - "languages": { - "description": "The language(s) of the comment and context. If none are specified, we\nattempt to automatically detect the language. Specifying multiple languages\nmeans the text contains multiple lanugages. Both ISO and BCP-47 language\ncodes are accepted.\n\nThe server returns an error if no language was specified and language\ndetection fails. The server also returns an error if the languages (either\nspecified by the caller, or auto-detected) are not *all* supported by the\nservice.", - "items": { - "type": "string" - }, - "type": "array" - }, - "requestedAttributes": { - "additionalProperties": { - "$ref": "AttributeParameters" - }, - "description": "Specification of requested attributes. The AttributeParameters serve as\nconfiguration for each associated attribute. The map keys are attribute\nnames. The available attributes may be different on each RFE installation,\nand can be seen by calling ListAttributes (see above).\nFor the prod installation, known as Perspective API, at\nblade:commentanalyzer-esf and commentanalyzer.googleapis.com, see\ngo/checker-models (internal) and\nhttps://github.com/conversationai/perspectiveapi/blob/master/2-api/models.md#all-attribute-types.", - "type": "object" - }, - "sessionId": { - "description": "Session ID. Used to join related RPCs into a single session. For example,\nan interactive tool that calls both the AnalyzeComment and\nSuggestCommentScore RPCs should set all invocations of both RPCs to the\nsame Session ID, typically a random 64-bit integer.", - "type": "string" - }, - "spanAnnotations": { - "description": "An advisory parameter that will return span annotations if the model\nis capable of providing scores with sub-comment resolution. This will\nlikely increase the size of the returned message.", - "type": "boolean" - } - }, - "type": "object" - }, - "AnalyzeCommentResponse": { - "description": "The comment analysis response message.", - "id": "AnalyzeCommentResponse", - "properties": { - "attributeScores": { - "additionalProperties": { - "$ref": "AttributeScores" - }, - "description": "Scores for the requested attributes. The map keys are attribute names (same\nas the requested_attribute field in AnalyzeCommentRequest, for example\n\"ATTACK_ON_AUTHOR\", \"INFLAMMATORY\", etc).", - "type": "object" - }, - "clientToken": { - "description": "Same token from the original AnalyzeCommentRequest.", - "type": "string" - }, - "detectedLanguages": { - "description": "Contains the languages detected from the text content, sorted in order of\nlikelihood.", - "items": { - "type": "string" - }, - "type": "array" - }, - "languages": { - "description": "The language(s) used by CommentAnalyzer service to choose which Model to\nuse when analyzing the comment. Might better be called\n\"effective_languages\". The logic used to make the choice is as follows:\n if !Request.languages.empty()\n effective_languages = Request.languages\n else\n effective_languages = detected_languages[0]", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ArticleAndParentComment": { - "description": "A type of context specific to a comment left on a single-threaded comment\nmessage board, where comments are either a top level comment or the child of\na top level comment.", - "id": "ArticleAndParentComment", - "properties": { - "article": { - "$ref": "TextEntry", - "description": "The source content about which the comment was made (article text, article\nsummary, video transcript, etc)." - }, - "parentComment": { - "$ref": "TextEntry", - "description": "Refers to text that is a direct parent of the source comment, such as in a\none-deep threaded message board. This field will only be present for\ncomments that are replies to other comments and will not be populated for\ndirect comments on the article_text." - } - }, - "type": "object" - }, - "AttributeParameters": { - "description": "Configurable parameters for attribute scoring.", - "id": "AttributeParameters", - "properties": { - "scoreThreshold": { - "description": "Don't return scores for this attribute that are below this threshold. If\nunset, a default threshold will be applied. A FloatValue wrapper is used to\ndistinguish between 0 vs. default/unset.", - "format": "float", - "type": "number" - }, - "scoreType": { - "description": "What type of scores to return. If unset, defaults to probability scores.", - "enum": [ - "SCORE_TYPE_UNSPECIFIED", - "PROBABILITY", - "STD_DEV_SCORE", - "PERCENTILE", - "RAW" - ], - "enumDescriptions": [ - "Unspecified. Defaults to PROBABILITY scores if available, and otherwise\nRAW. Every model has a RAW score.", - "Probability scores are in the range [0, 1] and indicate level of confidence\nin the attribute label.", - "Standard deviation scores are in the range (-inf, +inf).", - "Percentile scores are in the range [0, 1] and indicate the percentile of\nthe raw score, normalized with a test dataset. This is not generally\nrecommended, as the normalization is dependent on the dataset used, which\nmay not match other usecases.", - "Raw scores are the raw values from the model, and may take any value. This\nis primarily for debugging/testing, and not generally recommended." - ], - "type": "string" - } - }, - "type": "object" - }, - "AttributeScores": { - "description": "This holds score values for a single attribute. It contains both per-span\nscores as well as an overall summary score..", - "id": "AttributeScores", - "properties": { - "spanScores": { - "description": "Per-span scores.", - "items": { - "$ref": "SpanScore" - }, - "type": "array" - }, - "summaryScore": { - "$ref": "Score", - "description": "Overall score for comment as a whole." - } - }, - "type": "object" - }, - "Context": { - "description": "Context is typically something that a Comment is referencing or replying to\n(such as an article, or previous comment).\nNote: Populate only ONE OF the following fields. The oneof syntax cannot be\nused because that would require nesting entries inside another message and\nbreaking backwards compatibility. The server will return an error if more\nthan one of the following fields is present.", - "id": "Context", - "properties": { - "articleAndParentComment": { - "$ref": "ArticleAndParentComment", - "description": "Information about the source for which the original comment was made, and\nany parent comment info." - }, - "entries": { - "description": "A list of messages. For example, a linear comments section or forum thread.", - "items": { - "$ref": "TextEntry" - }, - "type": "array" - } - }, - "type": "object" - }, - "Score": { - "description": "Analysis scores are described by a value and a ScoreType.", - "id": "Score", - "properties": { - "type": { - "description": "The type of the above value.", - "enum": [ - "SCORE_TYPE_UNSPECIFIED", - "PROBABILITY", - "STD_DEV_SCORE", - "PERCENTILE", - "RAW" - ], - "enumDescriptions": [ - "Unspecified. Defaults to PROBABILITY scores if available, and otherwise\nRAW. Every model has a RAW score.", - "Probability scores are in the range [0, 1] and indicate level of confidence\nin the attribute label.", - "Standard deviation scores are in the range (-inf, +inf).", - "Percentile scores are in the range [0, 1] and indicate the percentile of\nthe raw score, normalized with a test dataset. This is not generally\nrecommended, as the normalization is dependent on the dataset used, which\nmay not match other usecases.", - "Raw scores are the raw values from the model, and may take any value. This\nis primarily for debugging/testing, and not generally recommended." - ], - "type": "string" - }, - "value": { - "description": "Score value. Semantics described by type below.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "SpanScore": { - "description": "This is a single score for a given span of text.", - "id": "SpanScore", - "properties": { - "begin": { - "description": "\"begin\" and \"end\" describe the span of the original text that the attribute\nscore applies to. The values are the UTF-16 codepoint range. \"end\" is\nexclusive. For example, with the text \"Hi there\", the begin/end pair (0,2)\ndescribes the text \"Hi\".\n\nIf \"begin\" and \"end\" are unset, the score applies to the full text.", - "format": "int32", - "type": "integer" - }, - "end": { - "format": "int32", - "type": "integer" - }, - "score": { - "$ref": "Score", - "description": "The score value." - } - }, - "type": "object" - }, - "SuggestCommentScoreRequest": { - "description": "The comment score suggestion request message.", - "id": "SuggestCommentScoreRequest", - "properties": { - "attributeScores": { - "additionalProperties": { - "$ref": "AttributeScores" - }, - "description": "Attribute scores for the comment. The map keys are attribute names, same as\nthe requested_attribute field in AnalyzeCommentRequest (for example\n\"ATTACK_ON_AUTHOR\", \"INFLAMMATORY\", etc.). This field has the same type as\nthe `attribute_scores` field in AnalyzeCommentResponse.\n\nTo specify an overall attribute score for the entire comment as a whole,\nuse the `summary_score` field of the mapped AttributeScores object. To\nspecify scores on specific subparts of the comment, use the `span_scores`\nfield. All SpanScore objects must have begin and end fields set.\n\nAll Score objects must be explicitly set (for binary classification, use\nthe score values 0 and 1). If Score objects don't include a ScoreType,\n`PROBABILITY` is assumed.\n\n`attribute_scores` must not be empty. The mapped AttributeScores objects\nalso must not be empty. An `INVALID_ARGUMENT` error is returned for all\nmalformed requests.", - "type": "object" - }, - "clientToken": { - "description": "Opaque token that is echoed from the request to the response.", - "type": "string" - }, - "comment": { - "$ref": "TextEntry", - "description": "The comment being scored." - }, - "communityId": { - "description": "Optional identifier associating this comment score suggestion with a\nparticular sub-community. Different communities may have different norms\nand rules. Specifying this value enables training community-specific\nmodels.", - "type": "string" - }, - "context": { - "$ref": "Context", - "description": "The context of the comment." - }, - "languages": { - "description": "The language(s) of the comment and context. If none are specified, we\nattempt to automatically detect the language. Both ISO and BCP-47 language\ncodes are accepted.", - "items": { - "type": "string" - }, - "type": "array" - }, - "sessionId": { - "description": "Session ID. Used to join related RPCs into a single session. For example,\nan interactive tool that calls both the AnalyzeComment and\nSuggestCommentScore RPCs should set all invocations of both RPCs to the\nsame Session ID, typically a random 64-bit integer.", - "type": "string" - } - }, - "type": "object" - }, - "SuggestCommentScoreResponse": { - "description": "The comment score suggestion response message.", - "id": "SuggestCommentScoreResponse", - "properties": { - "clientToken": { - "description": "Same token from the original SuggestCommentScoreRequest.", - "type": "string" - }, - "detectedLanguages": { - "description": "The list of languages detected from the comment text.", - "items": { - "type": "string" - }, - "type": "array" - }, - "requestedLanguages": { - "description": "The list of languages provided in the request.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "TextEntry": { - "description": "Represents a body of text.", - "id": "TextEntry", - "properties": { - "text": { - "description": "UTF-8 encoded text.", - "type": "string" - }, - "type": { - "description": "Type of the text field.", - "enum": [ - "TEXT_TYPE_UNSPECIFIED", - "PLAIN_TEXT", - "HTML" - ], - "enumDescriptions": [ - "The content type is not specified. Text will be interpreted as plain text\nby default.", - "Plain text.", - "HTML." - ], - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Perspective Comment Analyzer API", - "version": "v1alpha1", - "version_module": true -} \ No newline at end of file diff --git a/discovery/container-v1.json b/discovery/container-v1.json index c908053af49..9aea0b3f81c 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -137,7 +137,7 @@ "type": "string" }, "parent": { - "description": "The parent project where subnetworks are usable.\nSpecified in the format 'projects/*'.", + "description": "The parent project where subnetworks are usable.\nSpecified in the format `projects/*`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -168,7 +168,7 @@ ], "parameters": { "name": { - "description": "The name (project and location) of the server config to get,\nspecified in the format 'projects/*/locations/*'.", + "description": "The name (project and location) of the server config to get,\nspecified in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -207,7 +207,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -235,7 +235,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.", + "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -268,7 +268,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -308,7 +308,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -343,7 +343,7 @@ ], "parameters": { "parent": { - "description": "The cluster (project, location, cluster id) to get keys for. Specified in\nthe format 'projects/*/locations/*/clusters/*'.", + "description": "The cluster (project, location, cluster id) to get keys for. Specified in\nthe format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -365,7 +365,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format `projects/*/locations/*`.\nLocation \"-\" matches all zones and all regions.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -400,7 +400,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -428,7 +428,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -456,7 +456,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -484,7 +484,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -512,7 +512,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -540,7 +540,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -568,7 +568,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -596,7 +596,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -624,7 +624,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -652,7 +652,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -680,7 +680,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -708,7 +708,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -740,7 +740,7 @@ ], "parameters": { "parent": { - "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n'projects/*/locations/*/clusters/*'.", + "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n`projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -773,7 +773,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -818,7 +818,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -863,7 +863,7 @@ "type": "string" }, "parent": { - "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -898,7 +898,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -926,7 +926,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -954,7 +954,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -982,7 +982,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -1010,7 +1010,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -1042,7 +1042,7 @@ ], "parameters": { "parent": { - "description": "The cluster (project, location, cluster id) to get the discovery document\nfor. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The cluster (project, location, cluster id) to get the discovery document\nfor. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -1070,7 +1070,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format `projects/*/locations/*/operations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, @@ -1098,7 +1098,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format `projects/*/locations/*/operations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, @@ -1138,7 +1138,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format `projects/*/locations/*`.\nLocation \"-\" matches all zones and all regions.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1180,7 +1180,7 @@ ], "parameters": { "name": { - "description": "The name (project and location) of the server config to get,\nspecified in the format 'projects/*/locations/*'.", + "description": "The name (project and location) of the server config to get,\nspecified in the format `projects/*/locations/*`.", "location": "query", "type": "string" }, @@ -1343,7 +1343,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" }, @@ -1386,7 +1386,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" }, @@ -1463,7 +1463,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format `projects/*/locations/*`.\nLocation \"-\" matches all zones and all regions.", "location": "query", "type": "string" }, @@ -2010,7 +2010,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "query", "type": "string" }, @@ -2060,7 +2060,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "query", "type": "string" }, @@ -2109,7 +2109,7 @@ "type": "string" }, "parent": { - "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" }, @@ -2385,7 +2385,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format `projects/*/locations/*/operations/*`.", "location": "query", "type": "string" }, @@ -2427,7 +2427,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format `projects/*/locations/*`.\nLocation \"-\" matches all zones and all regions.", "location": "query", "type": "string" }, @@ -2459,7 +2459,7 @@ } } }, - "revision": "20200416", + "revision": "20200425", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2588,7 +2588,7 @@ "id": "CancelOperationRequest", "properties": { "name": { - "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format `projects/*/locations/*/operations/*`.", "type": "string" }, "operationId": { @@ -3006,7 +3006,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -3040,7 +3040,7 @@ "description": "Required. A [cluster\nresource](https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters)" }, "parent": { - "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.", + "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format `projects/*/locations/*`.", "type": "string" }, "projectId": { @@ -3067,7 +3067,7 @@ "description": "Required. The node pool to create." }, "parent": { - "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n'projects/*/locations/*/clusters/*'.", + "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n`projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4185,7 +4185,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodePoolId": { @@ -4271,7 +4271,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4298,7 +4298,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4332,7 +4332,7 @@ "type": "boolean" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4362,7 +4362,7 @@ "type": "array" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4389,7 +4389,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4416,7 +4416,7 @@ "description": "Required. The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy." }, "name": { - "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4455,7 +4455,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4486,7 +4486,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4509,7 +4509,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "networkPolicy": { @@ -4540,7 +4540,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodePoolId": { @@ -4571,7 +4571,7 @@ "description": "Required. NodeManagement configuration for the node pool." }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodePoolId": { @@ -4598,7 +4598,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodeCount": { @@ -4656,7 +4656,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4731,7 +4731,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4762,7 +4762,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4796,7 +4796,7 @@ "type": "array" }, "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodePoolId": { diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index 77299a833da..592c7b82887 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -137,7 +137,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent project where subnetworks are usable.\nSpecified in the format 'projects/*'.", + "description": "Required. The parent project where subnetworks are usable.\nSpecified in the format `projects/*`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -168,7 +168,7 @@ ], "parameters": { "name": { - "description": "The name (project and location) of the server config to get,\nspecified in the format 'projects/*/locations/*'.", + "description": "The name (project and location) of the server config to get,\nspecified in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -203,7 +203,7 @@ ], "parameters": { "parent": { - "description": "Required. Contains the name of the resource requested.\nSpecified in the format 'projects/*'.", + "description": "Required. Contains the name of the resource requested.\nSpecified in the format `projects/*`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -232,7 +232,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -260,7 +260,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.", + "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -293,7 +293,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -333,7 +333,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -368,7 +368,7 @@ ], "parameters": { "parent": { - "description": "The cluster (project, location, cluster id) to get keys for. Specified in\nthe format 'projects/*/locations/*/clusters/*'.", + "description": "The cluster (project, location, cluster id) to get keys for. Specified in\nthe format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -390,7 +390,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format `projects/*/locations/*`.\nLocation \"-\" matches all zones and all regions.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -425,7 +425,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -453,7 +453,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -481,7 +481,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -509,7 +509,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -537,7 +537,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -565,7 +565,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -593,7 +593,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -621,7 +621,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -649,7 +649,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -677,7 +677,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -705,7 +705,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -733,7 +733,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -765,7 +765,7 @@ ], "parameters": { "parent": { - "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n'projects/*/locations/*/clusters/*'.", + "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n`projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -798,7 +798,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -843,7 +843,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -888,7 +888,7 @@ "type": "string" }, "parent": { - "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -923,7 +923,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -951,7 +951,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -979,7 +979,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -1007,7 +1007,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -1035,7 +1035,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -1067,7 +1067,7 @@ ], "parameters": { "parent": { - "description": "The cluster (project, location, cluster id) to get the discovery document\nfor. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The cluster (project, location, cluster id) to get the discovery document\nfor. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -1095,7 +1095,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format `projects/*/locations/*/operations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, @@ -1123,7 +1123,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format `projects/*/locations/*/operations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, @@ -1163,7 +1163,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format `projects/*/locations/*`.\nLocation \"-\" matches all zones and all regions.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1205,7 +1205,7 @@ ], "parameters": { "name": { - "description": "The name (project and location) of the server config to get,\nspecified in the format 'projects/*/locations/*'.", + "description": "The name (project and location) of the server config to get,\nspecified in the format `projects/*/locations/*`.", "location": "query", "type": "string" }, @@ -1368,7 +1368,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" }, @@ -1411,7 +1411,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" }, @@ -1488,7 +1488,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format `projects/*/locations/*`.\nLocation \"-\" matches all zones and all regions.", "location": "query", "type": "string" }, @@ -2035,7 +2035,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "query", "type": "string" }, @@ -2085,7 +2085,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "location": "query", "type": "string" }, @@ -2134,7 +2134,7 @@ "type": "string" }, "parent": { - "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" }, @@ -2410,7 +2410,7 @@ ], "parameters": { "name": { - "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format `projects/*/locations/*/operations/*`.", "location": "query", "type": "string" }, @@ -2452,7 +2452,7 @@ ], "parameters": { "parent": { - "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format `projects/*/locations/*`.\nLocation \"-\" matches all zones and all regions.", "location": "query", "type": "string" }, @@ -2484,7 +2484,7 @@ } } }, - "revision": "20200416", + "revision": "20200425", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2652,7 +2652,7 @@ "id": "CancelOperationRequest", "properties": { "name": { - "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format `projects/*/locations/*/operations/*`.", "type": "string" }, "operationId": { @@ -3151,7 +3151,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -3196,7 +3196,7 @@ "description": "Required. A [cluster\nresource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.zones.clusters)" }, "parent": { - "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.", + "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format `projects/*/locations/*`.", "type": "string" }, "projectId": { @@ -3223,7 +3223,7 @@ "description": "Required. The node pool to create." }, "parent": { - "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n'projects/*/locations/*/clusters/*'.", + "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n`projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -3689,7 +3689,7 @@ "id": "Location", "properties": { "name": { - "description": "Contains the name of the resource requested.\nSpecified in the format 'projects/*/locations/*'.", + "description": "Contains the name of the resource requested.\nSpecified in the format `projects/*/locations/*`.", "type": "string" }, "recommended": { @@ -4538,7 +4538,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodePoolId": { @@ -4635,7 +4635,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4662,7 +4662,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4696,7 +4696,7 @@ "type": "boolean" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4726,7 +4726,7 @@ "type": "array" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4753,7 +4753,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4780,7 +4780,7 @@ "description": "Required. The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy." }, "name": { - "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4819,7 +4819,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4850,7 +4850,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -4873,7 +4873,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "networkPolicy": { @@ -4904,7 +4904,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodePoolId": { @@ -4935,7 +4935,7 @@ "description": "Required. NodeManagement configuration for the node pool." }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodePoolId": { @@ -4962,7 +4962,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodeCount": { @@ -5020,7 +5020,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -5114,7 +5114,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -5145,7 +5145,7 @@ "type": "string" }, "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "projectId": { @@ -5179,7 +5179,7 @@ "type": "array" }, "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n`projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "nodePoolId": { diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index 19a17ea1b62..5730c5a8da9 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -1206,7 +1206,7 @@ } } }, - "revision": "20200417", + "revision": "20200508", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "Artifact": { @@ -1287,7 +1287,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1836,7 +1836,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -2495,7 +2495,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -2511,7 +2511,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index dca3e45dfce..57da71ede96 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -853,7 +853,7 @@ } } }, - "revision": "20200501", + "revision": "20200508", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json index e19e4add0c5..c741c530d74 100644 --- a/discovery/content-v2.1.json +++ b/discovery/content-v2.1.json @@ -15,7 +15,7 @@ "description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/shopping-content", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/q87MOfWk98inmRTn0zaIDzGrAuU\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/7c3KYKLrlwx3Kl7VS3SQ1eP9osM\"", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -3608,7 +3608,7 @@ } } }, - "revision": "20200421", + "revision": "20200508", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/content-v2.json b/discovery/content-v2.json index 485795b5e92..b28928f27b2 100644 --- a/discovery/content-v2.json +++ b/discovery/content-v2.json @@ -15,7 +15,7 @@ "description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/shopping-content", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/rgSkg8lMwYWw6t8zxIovlBT9JjA\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/d-2pRwrRO0TgJDuvP8432gBRz7Y\"", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -3162,7 +3162,7 @@ } } }, - "revision": "20200421", + "revision": "20200508", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/customsearch-v1.json b/discovery/customsearch-v1.json index 7c03bd2cdca..32b6b5ed53e 100644 --- a/discovery/customsearch-v1.json +++ b/discovery/customsearch-v1.json @@ -1,33 +1,60 @@ { - "basePath": "/customsearch/", - "baseUrl": "https://www.googleapis.com/customsearch/", - "batchPath": "batch/customsearch/v1", + "basePath": "", + "baseUrl": "https://customsearch.googleapis.com/", + "batchPath": "batch", "description": "Searches over a website or collection of websites", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/custom-search/v1/using_rest", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/DuDrBlvHLFXE8uorI6UhfoH-kUs\"", + "documentationLink": "https://developers.google.com/custom-search/v1/introduction", "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "customsearch:v1", "kind": "discovery#restDescription", + "mtlsRootUrl": "https://customsearch.mtls.googleapis.com/", "name": "customsearch", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, "alt": { "default": "json", - "description": "Data format for the response.", + "description": "Data format for response.", "enum": [ - "json" + "json", + "media", + "proto" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -50,12 +77,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -65,118 +97,93 @@ "cse": { "methods": { "list": { - "description": "Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.", + "description": "Returns metadata about the search performed, metadata about the custom\nsearch engine used for the search, and the search results.", + "flatPath": "customsearch/v1", "httpMethod": "GET", "id": "search.cse.list", - "parameterOrder": [ - "q" - ], + "parameterOrder": [], "parameters": { "c2coff": { - "description": "Turns off the translation between zh-CN and zh-TW.", + "description": "Enables or disables [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).\n\nThe default value for this parameter is 0 (zero), meaning that the feature\nis enabled. Supported values are:\n\n* `1`: Disabled\n\n* `0`: Enabled (default)", "location": "query", "type": "string" }, "cr": { - "description": "Country restrict(s).", + "description": "Restricts search results to documents originating in a particular country.\nYou may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators)\nin the cr parameter's value.\n\nGoogle Search determines the country of a document by analyzing:\n\n* the top-level domain (TLD) of the document's URL\n\n* the geographic location of the Web server's IP address\n\nSee the [Country Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)\npage for a list of valid values for this parameter.", "location": "query", "type": "string" }, "cx": { - "description": "The custom search engine ID to scope this search query", + "description": "The custom search engine ID to use for this request.", "location": "query", "type": "string" }, "dateRestrict": { - "description": "Specifies all search results are from a time period", + "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", "location": "query", "type": "string" }, "exactTerms": { - "description": "Identifies a phrase that all documents in the search results must contain", + "description": "Identifies a phrase that all documents in the search results must contain.", "location": "query", "type": "string" }, "excludeTerms": { - "description": "Identifies a word or phrase that should not appear in any documents in the search results", + "description": "Identifies a word or phrase that should not appear in any documents in the\nsearch results.", "location": "query", "type": "string" }, "fileType": { - "description": "Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...", + "description": "Restricts results to files of a specified extension. A list of file types\nindexable by Google can be found in Search Console [Help\nCenter](https://support.google.com/webmasters/answer/35287).", "location": "query", "type": "string" }, "filter": { - "description": "Controls turning on or off the duplicate content filter.", - "enum": [ - "0", - "1" - ], - "enumDescriptions": [ - "Turns off duplicate content filter.", - "Turns on duplicate content filter." - ], + "description": "Controls turning on or off the duplicate content filter.\n\n* See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Note that host\ncrowding filtering applies only to multi-site searches.\n\n* By default, Google applies filtering to all search results to improve the\nquality of those results.\n\nAcceptable values are:\n\n* `0`: Turns off duplicate content filter.\n\n* `1`: Turns on duplicate content filter.", "location": "query", "type": "string" }, "gl": { - "description": "Geolocation of end user.", + "description": "Geolocation of end user.\n\n* The `gl` parameter value is a two-letter country code. The `gl` parameter\nboosts search results whose country of origin matches the parameter value.\nSee the [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes)\npage for a list of valid values.\n\n* Specifying a `gl` parameter value should lead to more relevant results.\nThis is particularly true for international customers and, even more\nspecifically, for customers in English- speaking countries other than the\nUnited States.", "location": "query", "type": "string" }, "googlehost": { - "description": "The local Google domain to use to perform the search.", + "description": "**Deprecated**. Use the `gl` parameter for a similar effect.\n\nThe local Google domain (for example, google.com, google.de, or\ngoogle.fr) to use to perform the search.", "location": "query", "type": "string" }, "highRange": { - "description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query", + "description": "Specifies the ending value for a search range.\n\n* Use `lowRange` and `highRange` to append an inclusive search range of\n`lowRange...highRange` to the query.", "location": "query", "type": "string" }, "hl": { - "description": "Sets the user interface language.", + "description": "Sets the user interface language.\n\n* Explicitly setting this parameter improves the performance and the\nquality of your search results.\n\n* See the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and (Supported Interface\nLanguages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages]\nfor a list of supported languages.", "location": "query", "type": "string" }, "hq": { - "description": "Appends the extra query terms to the query.", + "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical AND operator.", "location": "query", "type": "string" }, "imgColorType": { - "description": "Returns black and white, grayscale, or color images: mono, gray, and color.", + "description": "Returns black and white, grayscale, transparent, or color images.\nAcceptable values are:\n\n* `\"color\"`\n\n* `\"gray\"`\n\n* `\"mono\"`: black and white\n\n* `\"trans\"`: transparent background", "enum": [ - "color", + "imgColorTypeUndefined", + "mono", "gray", - "mono" - ], - "enumDescriptions": [ "color", - "gray", - "mono" + "trans" ], "location": "query", "type": "string" }, "imgDominantColor": { - "description": "Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.", + "description": "Returns images of a specific dominant color. Acceptable values are:\n\n* `\"black\"`\n\n* `\"blue\"`\n\n* `\"brown\"`\n\n* `\"gray\"`\n\n* `\"green\"`\n\n* `\"orange\"`\n\n* `\"pink\"`\n\n* `\"purple\"`\n\n* `\"red\"`\n\n* `\"teal\"`\n\n* `\"white\"`\n\n* `\"yellow\"`", "enum": [ - "black", - "blue", - "brown", - "gray", - "green", - "orange", - "pink", - "purple", - "red", - "teal", - "white", - "yellow" - ], - "enumDescriptions": [ + "imgDominantColorUndefined", "black", "blue", "brown", @@ -194,224 +201,124 @@ "type": "string" }, "imgSize": { - "description": "Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.", + "description": "Returns images of a specified size. Acceptable values are:\n\n* `\"huge\"`\n\n* `\"icon\"`\n\n* `\"large\"`\n\n* `\"medium\"`\n\n* `\"small\"`\n\n* `\"xlarge\"`\n\n* `\"xxlarge\"`", "enum": [ - "huge", - "icon", - "large", - "medium", - "small", - "xlarge", - "xxlarge" - ], - "enumDescriptions": [ - "huge", - "icon", - "large", - "medium", - "small", - "xlarge", - "xxlarge" + "imgSizeUndefined", + "HUGE", + "ICON", + "LARGE", + "MEDIUM", + "SMALL", + "XLARGE", + "XXLARGE" ], "location": "query", "type": "string" }, "imgType": { - "description": "Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.", + "description": "Returns images of a type. Acceptable values are:\n\n* `\"clipart\"`\n\n* `\"face\"`\n\n* `\"lineart\"`\n\n* `\"stock\"`\n\n* `\"photo\"`\n\n* `\"animated\"`", "enum": [ + "imgTypeUndefined", "clipart", "face", "lineart", - "news", - "photo" - ], - "enumDescriptions": [ - "clipart", - "face", - "lineart", - "news", - "photo" + "stock", + "photo", + "animated" ], "location": "query", "type": "string" }, "linkSite": { - "description": "Specifies that all search results should contain a link to a particular URL", + "description": "Specifies that all search results should contain a link to a particular\nURL.", "location": "query", "type": "string" }, "lowRange": { - "description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query", + "description": "Specifies the starting value for a search range. Use `lowRange` and\n`highRange` to append an inclusive search range of `lowRange...highRange`\nto the query.", "location": "query", "type": "string" }, "lr": { - "description": "The language restriction for the search results", - "enum": [ - "lang_ar", - "lang_bg", - "lang_ca", - "lang_cs", - "lang_da", - "lang_de", - "lang_el", - "lang_en", - "lang_es", - "lang_et", - "lang_fi", - "lang_fr", - "lang_hr", - "lang_hu", - "lang_id", - "lang_is", - "lang_it", - "lang_iw", - "lang_ja", - "lang_ko", - "lang_lt", - "lang_lv", - "lang_nl", - "lang_no", - "lang_pl", - "lang_pt", - "lang_ro", - "lang_ru", - "lang_sk", - "lang_sl", - "lang_sr", - "lang_sv", - "lang_tr", - "lang_zh-CN", - "lang_zh-TW" - ], - "enumDescriptions": [ - "Arabic", - "Bulgarian", - "Catalan", - "Czech", - "Danish", - "German", - "Greek", - "English", - "Spanish", - "Estonian", - "Finnish", - "French", - "Croatian", - "Hungarian", - "Indonesian", - "Icelandic", - "Italian", - "Hebrew", - "Japanese", - "Korean", - "Lithuanian", - "Latvian", - "Dutch", - "Norwegian", - "Polish", - "Portuguese", - "Romanian", - "Russian", - "Slovak", - "Slovenian", - "Serbian", - "Swedish", - "Turkish", - "Chinese (Simplified)", - "Chinese (Traditional)" - ], + "description": "Restricts the search to documents written in a particular language (e.g.,\n`lr=lang_ja`).\n\nAcceptable values are:\n\n* `\"lang_ar\"`: Arabic\n\n* `\"lang_bg\"`: Bulgarian\n\n* `\"lang_ca\"`: Catalan\n\n* `\"lang_cs\"`: Czech\n\n* `\"lang_da\"`: Danish\n\n* `\"lang_de\"`: German\n\n* `\"lang_el\"`: Greek\n\n* `\"lang_en\"`: English\n\n* `\"lang_es\"`: Spanish\n\n* `\"lang_et\"`: Estonian\n\n* `\"lang_fi\"`: Finnish\n\n* `\"lang_fr\"`: French\n\n* `\"lang_hr\"`: Croatian\n\n* `\"lang_hu\"`: Hungarian\n\n* `\"lang_id\"`: Indonesian\n\n* `\"lang_is\"`: Icelandic\n\n* `\"lang_it\"`: Italian\n\n* `\"lang_iw\"`: Hebrew\n\n* `\"lang_ja\"`: Japanese\n\n* `\"lang_ko\"`: Korean\n\n* `\"lang_lt\"`: Lithuanian\n\n* `\"lang_lv\"`: Latvian\n\n* `\"lang_nl\"`: Dutch\n\n* `\"lang_no\"`: Norwegian\n\n* `\"lang_pl\"`: Polish\n\n* `\"lang_pt\"`: Portuguese\n\n* `\"lang_ro\"`: Romanian\n\n* `\"lang_ru\"`: Russian\n\n* `\"lang_sk\"`: Slovak\n\n* `\"lang_sl\"`: Slovenian\n\n* `\"lang_sr\"`: Serbian\n\n* `\"lang_sv\"`: Swedish\n\n* `\"lang_tr\"`: Turkish\n\n* `\"lang_zh-CN\"`: Chinese (Simplified)\n\n* `\"lang_zh-TW\"`: Chinese (Traditional)", "location": "query", "type": "string" }, "num": { - "default": "10", - "description": "Number of search results to return", - "format": "uint32", + "description": "Number of search results to return.\n\n* Valid values are integers between 1 and 10, inclusive.", + "format": "int32", "location": "query", "type": "integer" }, "orTerms": { - "description": "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", + "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the additional\nsearch terms.", "location": "query", "type": "string" }, "q": { "description": "Query", "location": "query", - "required": true, "type": "string" }, "relatedSite": { - "description": "Specifies that all search results should be pages that are related to the specified URL", + "description": "Specifies that all search results should be pages that are related to the\nspecified URL.", "location": "query", "type": "string" }, "rights": { - "description": "Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.", + "description": "Filters based on licensing. Supported values include: `cc_publicdomain`,\n`cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and\ncombinations of these. See [typical\ncombinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).", "location": "query", "type": "string" }, "safe": { - "default": "off", - "description": "Search safety level", + "description": "Search safety level. Acceptable values are:\n\n* `\"active\"`: Enables SafeSearch filtering.\n\n* `\"off\"`: Disables SafeSearch filtering. (default)", "enum": [ + "safeUndefined", "active", "high", "medium", "off" ], - "enumDescriptions": [ - "Enables safe search filtering.", - "(Deprecated) Same as active.", - "(Deprecated) Same as active.", - "Disables safe search filtering." - ], "location": "query", "type": "string" }, "searchType": { - "description": "Specifies the search type: image.", + "description": "Specifies the search type: `image`. If unspecified, results are limited to\nwebpages.\n\nAcceptable values are:\n\n* `\"image\"`: custom image search.", "enum": [ + "searchTypeUndefined", "image" ], - "enumDescriptions": [ - "custom image search" - ], "location": "query", "type": "string" }, "siteSearch": { - "description": "Specifies all search results should be pages from a given site", + "description": "Specifies a given site which should always be included or excluded from\nresults (see `siteSearchFilter` parameter, below).", "location": "query", "type": "string" }, "siteSearchFilter": { - "description": "Controls whether to include or exclude results from the site named in the as_sitesearch parameter", + "description": "Controls whether to include or exclude results from the site named in the\n`siteSearch` parameter.\n\nAcceptable values are:\n\n* `\"e\"`: exclude\n\n* `\"i\"`: include", "enum": [ + "siteSearchFilterUndefined", "e", "i" ], - "enumDescriptions": [ - "exclude", - "include" - ], "location": "query", "type": "string" }, "sort": { - "description": "The sort expression to apply to the results", + "description": "The sort expression to apply to the results.", "location": "query", "type": "string" }, "start": { - "description": "The index of the first result to return", + "description": "The index of the first result to return. The default number of results per\npage is 10, so `&start=11` would start at the top of the second page of\nresults. **Note**: The JSON API will never return more than 100 results,\neven if more than 100 documents match the query, so setting the sum of\n`start + num` to a number greater than 100 will produce an error. Also note\nthat the maximum value for `num` is 10.", "format": "uint32", "location": "query", "type": "integer" } }, - "path": "v1", + "path": "customsearch/v1", "response": { "$ref": "Search" } @@ -421,118 +328,93 @@ "siterestrict": { "methods": { "list": { - "description": "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.", + "description": "Returns metadata about the search performed, metadata about the custom\nsearch engine used for the search, and the search results. Uses a small set\nof url patterns.", + "flatPath": "customsearch/v1/siterestrict", "httpMethod": "GET", "id": "search.cse.siterestrict.list", - "parameterOrder": [ - "q" - ], + "parameterOrder": [], "parameters": { "c2coff": { - "description": "Turns off the translation between zh-CN and zh-TW.", + "description": "Enables or disables [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).\n\nThe default value for this parameter is 0 (zero), meaning that the feature\nis enabled. Supported values are:\n\n* `1`: Disabled\n\n* `0`: Enabled (default)", "location": "query", "type": "string" }, "cr": { - "description": "Country restrict(s).", + "description": "Restricts search results to documents originating in a particular country.\nYou may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators)\nin the cr parameter's value.\n\nGoogle Search determines the country of a document by analyzing:\n\n* the top-level domain (TLD) of the document's URL\n\n* the geographic location of the Web server's IP address\n\nSee the [Country Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)\npage for a list of valid values for this parameter.", "location": "query", "type": "string" }, "cx": { - "description": "The custom search engine ID to scope this search query", + "description": "The custom search engine ID to use for this request.", "location": "query", "type": "string" }, "dateRestrict": { - "description": "Specifies all search results are from a time period", + "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", "location": "query", "type": "string" }, "exactTerms": { - "description": "Identifies a phrase that all documents in the search results must contain", + "description": "Identifies a phrase that all documents in the search results must contain.", "location": "query", "type": "string" }, "excludeTerms": { - "description": "Identifies a word or phrase that should not appear in any documents in the search results", + "description": "Identifies a word or phrase that should not appear in any documents in the\nsearch results.", "location": "query", "type": "string" }, "fileType": { - "description": "Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...", + "description": "Restricts results to files of a specified extension. A list of file types\nindexable by Google can be found in Search Console [Help\nCenter](https://support.google.com/webmasters/answer/35287).", "location": "query", "type": "string" }, "filter": { - "description": "Controls turning on or off the duplicate content filter.", - "enum": [ - "0", - "1" - ], - "enumDescriptions": [ - "Turns off duplicate content filter.", - "Turns on duplicate content filter." - ], + "description": "Controls turning on or off the duplicate content filter.\n\n* See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Note that host\ncrowding filtering applies only to multi-site searches.\n\n* By default, Google applies filtering to all search results to improve the\nquality of those results.\n\nAcceptable values are:\n\n* `0`: Turns off duplicate content filter.\n\n* `1`: Turns on duplicate content filter.", "location": "query", "type": "string" }, "gl": { - "description": "Geolocation of end user.", + "description": "Geolocation of end user.\n\n* The `gl` parameter value is a two-letter country code. The `gl` parameter\nboosts search results whose country of origin matches the parameter value.\nSee the [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes)\npage for a list of valid values.\n\n* Specifying a `gl` parameter value should lead to more relevant results.\nThis is particularly true for international customers and, even more\nspecifically, for customers in English- speaking countries other than the\nUnited States.", "location": "query", "type": "string" }, "googlehost": { - "description": "The local Google domain to use to perform the search.", + "description": "**Deprecated**. Use the `gl` parameter for a similar effect.\n\nThe local Google domain (for example, google.com, google.de, or\ngoogle.fr) to use to perform the search.", "location": "query", "type": "string" }, "highRange": { - "description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query", + "description": "Specifies the ending value for a search range.\n\n* Use `lowRange` and `highRange` to append an inclusive search range of\n`lowRange...highRange` to the query.", "location": "query", "type": "string" }, "hl": { - "description": "Sets the user interface language.", + "description": "Sets the user interface language.\n\n* Explicitly setting this parameter improves the performance and the\nquality of your search results.\n\n* See the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and (Supported Interface\nLanguages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages]\nfor a list of supported languages.", "location": "query", "type": "string" }, "hq": { - "description": "Appends the extra query terms to the query.", + "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical AND operator.", "location": "query", "type": "string" }, "imgColorType": { - "description": "Returns black and white, grayscale, or color images: mono, gray, and color.", + "description": "Returns black and white, grayscale, transparent, or color images.\nAcceptable values are:\n\n* `\"color\"`\n\n* `\"gray\"`\n\n* `\"mono\"`: black and white\n\n* `\"trans\"`: transparent background", "enum": [ - "color", + "imgColorTypeUndefined", + "mono", "gray", - "mono" - ], - "enumDescriptions": [ "color", - "gray", - "mono" + "trans" ], "location": "query", "type": "string" }, "imgDominantColor": { - "description": "Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.", + "description": "Returns images of a specific dominant color. Acceptable values are:\n\n* `\"black\"`\n\n* `\"blue\"`\n\n* `\"brown\"`\n\n* `\"gray\"`\n\n* `\"green\"`\n\n* `\"orange\"`\n\n* `\"pink\"`\n\n* `\"purple\"`\n\n* `\"red\"`\n\n* `\"teal\"`\n\n* `\"white\"`\n\n* `\"yellow\"`", "enum": [ - "black", - "blue", - "brown", - "gray", - "green", - "orange", - "pink", - "purple", - "red", - "teal", - "white", - "yellow" - ], - "enumDescriptions": [ + "imgDominantColorUndefined", "black", "blue", "brown", @@ -550,222 +432,124 @@ "type": "string" }, "imgSize": { - "description": "Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.", + "description": "Returns images of a specified size. Acceptable values are:\n\n* `\"huge\"`\n\n* `\"icon\"`\n\n* `\"large\"`\n\n* `\"medium\"`\n\n* `\"small\"`\n\n* `\"xlarge\"`\n\n* `\"xxlarge\"`", "enum": [ - "huge", - "icon", - "large", - "medium", - "small", - "xlarge", - "xxlarge" - ], - "enumDescriptions": [ - "huge", - "icon", - "large", - "medium", - "small", - "xlarge", - "xxlarge" + "imgSizeUndefined", + "HUGE", + "ICON", + "LARGE", + "MEDIUM", + "SMALL", + "XLARGE", + "XXLARGE" ], "location": "query", "type": "string" }, "imgType": { - "description": "Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.", + "description": "Returns images of a type. Acceptable values are:\n\n* `\"clipart\"`\n\n* `\"face\"`\n\n* `\"lineart\"`\n\n* `\"stock\"`\n\n* `\"photo\"`\n\n* `\"animated\"`", "enum": [ + "imgTypeUndefined", "clipart", "face", "lineart", - "news", - "photo" - ], - "enumDescriptions": [ - "clipart", - "face", - "lineart", - "news", - "photo" + "stock", + "photo", + "animated" ], "location": "query", "type": "string" }, "linkSite": { - "description": "Specifies that all search results should contain a link to a particular URL", + "description": "Specifies that all search results should contain a link to a particular\nURL.", "location": "query", "type": "string" }, "lowRange": { - "description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query", + "description": "Specifies the starting value for a search range. Use `lowRange` and\n`highRange` to append an inclusive search range of `lowRange...highRange`\nto the query.", "location": "query", "type": "string" }, "lr": { - "description": "The language restriction for the search results", - "enum": [ - "lang_ar", - "lang_bg", - "lang_ca", - "lang_cs", - "lang_da", - "lang_de", - "lang_el", - "lang_en", - "lang_es", - "lang_et", - "lang_fi", - "lang_fr", - "lang_hr", - "lang_hu", - "lang_id", - "lang_is", - "lang_it", - "lang_iw", - "lang_ja", - "lang_ko", - "lang_lt", - "lang_lv", - "lang_nl", - "lang_no", - "lang_pl", - "lang_pt", - "lang_ro", - "lang_ru", - "lang_sk", - "lang_sl", - "lang_sr", - "lang_sv", - "lang_tr", - "lang_zh-CN", - "lang_zh-TW" - ], - "enumDescriptions": [ - "Arabic", - "Bulgarian", - "Catalan", - "Czech", - "Danish", - "German", - "Greek", - "English", - "Spanish", - "Estonian", - "Finnish", - "French", - "Croatian", - "Hungarian", - "Indonesian", - "Icelandic", - "Italian", - "Hebrew", - "Japanese", - "Korean", - "Lithuanian", - "Latvian", - "Dutch", - "Norwegian", - "Polish", - "Portuguese", - "Romanian", - "Russian", - "Slovak", - "Slovenian", - "Serbian", - "Swedish", - "Turkish", - "Chinese (Simplified)", - "Chinese (Traditional)" - ], + "description": "Restricts the search to documents written in a particular language (e.g.,\n`lr=lang_ja`).\n\nAcceptable values are:\n\n* `\"lang_ar\"`: Arabic\n\n* `\"lang_bg\"`: Bulgarian\n\n* `\"lang_ca\"`: Catalan\n\n* `\"lang_cs\"`: Czech\n\n* `\"lang_da\"`: Danish\n\n* `\"lang_de\"`: German\n\n* `\"lang_el\"`: Greek\n\n* `\"lang_en\"`: English\n\n* `\"lang_es\"`: Spanish\n\n* `\"lang_et\"`: Estonian\n\n* `\"lang_fi\"`: Finnish\n\n* `\"lang_fr\"`: French\n\n* `\"lang_hr\"`: Croatian\n\n* `\"lang_hu\"`: Hungarian\n\n* `\"lang_id\"`: Indonesian\n\n* `\"lang_is\"`: Icelandic\n\n* `\"lang_it\"`: Italian\n\n* `\"lang_iw\"`: Hebrew\n\n* `\"lang_ja\"`: Japanese\n\n* `\"lang_ko\"`: Korean\n\n* `\"lang_lt\"`: Lithuanian\n\n* `\"lang_lv\"`: Latvian\n\n* `\"lang_nl\"`: Dutch\n\n* `\"lang_no\"`: Norwegian\n\n* `\"lang_pl\"`: Polish\n\n* `\"lang_pt\"`: Portuguese\n\n* `\"lang_ro\"`: Romanian\n\n* `\"lang_ru\"`: Russian\n\n* `\"lang_sk\"`: Slovak\n\n* `\"lang_sl\"`: Slovenian\n\n* `\"lang_sr\"`: Serbian\n\n* `\"lang_sv\"`: Swedish\n\n* `\"lang_tr\"`: Turkish\n\n* `\"lang_zh-CN\"`: Chinese (Simplified)\n\n* `\"lang_zh-TW\"`: Chinese (Traditional)", "location": "query", "type": "string" }, "num": { - "default": "10", - "description": "Number of search results to return", - "format": "uint32", + "description": "Number of search results to return.\n\n* Valid values are integers between 1 and 10, inclusive.", + "format": "int32", "location": "query", "type": "integer" }, "orTerms": { - "description": "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", + "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the additional\nsearch terms.", "location": "query", "type": "string" }, "q": { "description": "Query", "location": "query", - "required": true, "type": "string" }, "relatedSite": { - "description": "Specifies that all search results should be pages that are related to the specified URL", + "description": "Specifies that all search results should be pages that are related to the\nspecified URL.", "location": "query", "type": "string" }, "rights": { - "description": "Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.", + "description": "Filters based on licensing. Supported values include: `cc_publicdomain`,\n`cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and\ncombinations of these. See [typical\ncombinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).", "location": "query", "type": "string" }, "safe": { - "default": "off", - "description": "Search safety level", + "description": "Search safety level. Acceptable values are:\n\n* `\"active\"`: Enables SafeSearch filtering.\n\n* `\"off\"`: Disables SafeSearch filtering. (default)", "enum": [ + "safeUndefined", + "active", "high", "medium", "off" ], - "enumDescriptions": [ - "Enables highest level of safe search filtering.", - "Enables moderate safe search filtering.", - "Disables safe search filtering." - ], "location": "query", "type": "string" }, "searchType": { - "description": "Specifies the search type: image.", + "description": "Specifies the search type: `image`. If unspecified, results are limited to\nwebpages.\n\nAcceptable values are:\n\n* `\"image\"`: custom image search.", "enum": [ + "searchTypeUndefined", "image" ], - "enumDescriptions": [ - "custom image search" - ], "location": "query", "type": "string" }, "siteSearch": { - "description": "Specifies all search results should be pages from a given site", + "description": "Specifies a given site which should always be included or excluded from\nresults (see `siteSearchFilter` parameter, below).", "location": "query", "type": "string" }, "siteSearchFilter": { - "description": "Controls whether to include or exclude results from the site named in the as_sitesearch parameter", + "description": "Controls whether to include or exclude results from the site named in the\n`siteSearch` parameter.\n\nAcceptable values are:\n\n* `\"e\"`: exclude\n\n* `\"i\"`: include", "enum": [ + "siteSearchFilterUndefined", "e", "i" ], - "enumDescriptions": [ - "exclude", - "include" - ], "location": "query", "type": "string" }, "sort": { - "description": "The sort expression to apply to the results", + "description": "The sort expression to apply to the results.", "location": "query", "type": "string" }, "start": { - "description": "The index of the first result to return", + "description": "The index of the first result to return. The default number of results per\npage is 10, so `&start=11` would start at the top of the second page of\nresults. **Note**: The JSON API will never return more than 100 results,\neven if more than 100 documents match the query, so setting the sum of\n`start + num` to a number greater than 100 will produce an error. Also note\nthat the maximum value for `num` is 10.", "format": "uint32", "location": "query", "type": "integer" } }, - "path": "v1/siterestrict", + "path": "customsearch/v1/siterestrict", "response": { "$ref": "Search" } @@ -775,54 +559,32 @@ } } }, - "revision": "20181001", - "rootUrl": "https://www.googleapis.com/", + "revision": "20200511", + "rootUrl": "https://customsearch.googleapis.com/", "schemas": { - "Context": { - "id": "Context", - "properties": { - "facets": { - "items": { - "items": { - "properties": { - "anchor": { - "type": "string" - }, - "label": { - "type": "string" - }, - "label_with_op": { - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "type": "array" - }, - "title": { - "type": "string" - } - }, - "type": "object" - }, "Promotion": { + "description": "Promotion result.", "id": "Promotion", "properties": { "bodyLines": { + "description": "An array of block objects for this promotion. See [Google WebSearch\nProtocol\nreference](https://developers.google.com/custom-search/docs/xml_results)\nfor more information.", "items": { + "description": "Block object belonging to a promotion.", "properties": { "htmlTitle": { + "description": "The block object's text in HTML, if it has text.", "type": "string" }, "link": { + "description": "The anchor text of the block object's link, if it has a link.", "type": "string" }, "title": { + "description": "The block object's text, if it has text.", "type": "string" }, "url": { + "description": "The URL of the block object's link, if it has one.", "type": "string" } }, @@ -831,21 +593,27 @@ "type": "array" }, "displayLink": { + "description": "An abridged version of this search's result URL, e.g. www.example.com.", "type": "string" }, "htmlTitle": { + "description": "The title of the promotion, in HTML.", "type": "string" }, "image": { + "description": "Image belonging to a promotion.", "properties": { "height": { + "description": "Image height in pixels.", "format": "int32", "type": "integer" }, "source": { + "description": "URL of the image for this promotion link.", "type": "string" }, "width": { + "description": "Image width in pixels.", "format": "int32", "type": "integer" } @@ -853,181 +621,81 @@ "type": "object" }, "link": { + "description": "The URL of the promotion.", "type": "string" }, "title": { - "type": "string" - } - }, - "type": "object" - }, - "Query": { - "id": "Query", - "properties": { - "count": { - "format": "int32", - "type": "integer" - }, - "cr": { - "type": "string" - }, - "cx": { - "type": "string" - }, - "dateRestrict": { - "type": "string" - }, - "disableCnTwTranslation": { - "type": "string" - }, - "exactTerms": { - "type": "string" - }, - "excludeTerms": { - "type": "string" - }, - "fileType": { - "type": "string" - }, - "filter": { - "type": "string" - }, - "gl": { - "type": "string" - }, - "googleHost": { - "type": "string" - }, - "highRange": { - "type": "string" - }, - "hl": { - "type": "string" - }, - "hq": { - "type": "string" - }, - "imgColorType": { - "type": "string" - }, - "imgDominantColor": { - "type": "string" - }, - "imgSize": { - "type": "string" - }, - "imgType": { - "type": "string" - }, - "inputEncoding": { - "type": "string" - }, - "language": { - "type": "string" - }, - "linkSite": { - "type": "string" - }, - "lowRange": { - "type": "string" - }, - "orTerms": { - "type": "string" - }, - "outputEncoding": { - "type": "string" - }, - "relatedSite": { - "type": "string" - }, - "rights": { - "type": "string" - }, - "safe": { - "type": "string" - }, - "searchTerms": { - "type": "string" - }, - "searchType": { - "type": "string" - }, - "siteSearch": { - "type": "string" - }, - "siteSearchFilter": { - "type": "string" - }, - "sort": { - "type": "string" - }, - "startIndex": { - "format": "int32", - "type": "integer" - }, - "startPage": { - "format": "int32", - "type": "integer" - }, - "title": { - "type": "string" - }, - "totalResults": { - "format": "int64", + "description": "The title of the promotion.", "type": "string" } }, "type": "object" }, "Result": { + "description": "A custom search result.", "id": "Result", "properties": { "cacheId": { + "description": "Indicates the ID of Google's cached version of the search result.", "type": "string" }, "displayLink": { + "description": "An abridged version of this search result’s URL, e.g. www.example.com.", "type": "string" }, "fileFormat": { + "description": "The file format of the search result.", "type": "string" }, "formattedUrl": { + "description": "The URL displayed after the snippet for each search result.", "type": "string" }, "htmlFormattedUrl": { + "description": "The HTML-formatted URL displayed after the snippet for each search result.", "type": "string" }, "htmlSnippet": { + "description": "The snippet of the search result, in HTML.", "type": "string" }, "htmlTitle": { + "description": "The title of the search result, in HTML.", "type": "string" }, "image": { + "description": "Image belonging to a custom search result.", "properties": { "byteSize": { + "description": "The size of the image, in pixels.", "format": "int32", "type": "integer" }, "contextLink": { + "description": "A URL pointing to the webpage hosting the image.", "type": "string" }, "height": { + "description": "The height of the image, in pixels.", "format": "int32", "type": "integer" }, "thumbnailHeight": { + "description": "The height of the thumbnail image, in pixels.", "format": "int32", "type": "integer" }, "thumbnailLink": { + "description": "A URL to the thumbnail image.", "type": "string" }, "thumbnailWidth": { + "description": "The width of the thumbnail image, in pixels.", "format": "int32", "type": "integer" }, "width": { + "description": "The width of the image, in pixels.", "format": "int32", "type": "integer" } @@ -1035,19 +703,24 @@ "type": "object" }, "kind": { - "default": "customsearch#result", + "description": "A unique identifier for the type of current object. For this API, it is\n`customsearch#result.`", "type": "string" }, "labels": { + "description": "Encapsulates all information about [refinement\nlabels](https://developers.google.com/custom-search/docs/xml_results).", "items": { + "description": "Refinement label associated with a custom search result.", "properties": { "displayName": { + "description": "The display name of a refinement label. This is the name you should\ndisplay in your user interface.", "type": "string" }, "label_with_op": { + "description": "Refinement label and the associated refinement operation.", "type": "string" }, "name": { + "description": "The name of a refinement label, which you can use to refine searches.\nDon't display this in your user interface; instead, use displayName.", "type": "string" } }, @@ -1056,101 +729,588 @@ "type": "array" }, "link": { + "description": "The full URL to which the search result is pointing, e.g.\nhttp://www.example.com/foo/bar.", "type": "string" }, "mime": { + "description": "The MIME type of the search result.", "type": "string" }, "pagemap": { "additionalProperties": { - "items": { - "additionalProperties": { - "type": "any" - }, - "type": "object" - }, - "type": "array" + "description": "Properties of the object.", + "type": "any" }, + "description": "Contains\n[PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps)\ninformation for this search result.", "type": "object" }, "snippet": { + "description": "The snippet of the search result, in plain text.", "type": "string" }, "title": { + "description": "The title of the search result, in plain text.", "type": "string" } }, "type": "object" }, "Search": { + "description": "Response to a custom search request.", "id": "Search", "properties": { "context": { - "$ref": "Context" + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Metadata and refinements associated with the given search engine,\nincluding:\n\n* The name of the search engine that was used for the query.\n\n* A set of [facet\nobjects](https://developers.google.com/custom-search/docs/refinements#create)\n(refinements) you can use for refining a search.", + "type": "object" }, "items": { + "description": "The current set of custom search results.", "items": { "$ref": "Result" }, "type": "array" }, "kind": { - "default": "customsearch#search", + "description": "Unique identifier for the type of current object. For this API, it is\ncustomsearch#search.", "type": "string" }, "promotions": { + "description": "The set of\n[promotions](https://developers.google.com/custom-search/docs/promotions).\nPresent only if the custom search engine's configuration files define any\npromotions for the given query.", "items": { "$ref": "Promotion" }, "type": "array" }, "queries": { - "additionalProperties": { - "items": { - "$ref": "Query" + "description": "Query metadata for the previous, current, and next pages of results.", + "properties": { + "nextPage": { + "description": "Metadata representing the next page of results, if applicable.", + "items": { + "description": "Custom search request metadata.", + "properties": { + "count": { + "description": "Number of search results returned in this set.", + "format": "int32", + "type": "integer" + }, + "cr": { + "description": "Restricts search results to documents originating in a particular\ncountry. You may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)\nin the `cr` parameter's value.\n\nGoogle WebSearch determines the country of a document by analyzing the\nfollowing:\n\n* The top-level domain (TLD) of the document's URL.\n\n* The geographic location of the web server's IP address.\n\nSee [Country (cr) Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results#countryCollections)\nfor a list of valid values for this parameter.", + "type": "string" + }, + "cx": { + "description": "The identifier of a custom search engine created using the Custom Search\n[Control Panel](https://cse.google.com/). This is a custom property not\ndefined in the OpenSearch spec. This parameter is **required**.", + "type": "string" + }, + "dateRestrict": { + "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", + "type": "string" + }, + "disableCnTwTranslation": { + "description": "Enables or disables the [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)\nfeature.\n\nSupported values are:\n\n* `0`: enabled (default)\n\n* `1`: disabled", + "type": "string" + }, + "exactTerms": { + "description": "Identifies a phrase that all documents in the search results must\ncontain.", + "type": "string" + }, + "excludeTerms": { + "description": "Identifies a word or phrase that should not appear in any documents in\nthe search results.", + "type": "string" + }, + "fileType": { + "description": "Restricts results to files of a specified extension. Filetypes supported\nby Google include:\n\n* Adobe Portable Document Format (`pdf`)\n\n* Adobe PostScript (`ps`)\n\n* Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)\n\n* Lotus WordPro (`lwp`)\n\n* Macwrite (`mw`)\n\n* Microsoft Excel (`xls`)\n\n* Microsoft PowerPoint (`ppt`)\n\n* Microsoft Word (`doc`)\n\n* Microsoft Works (`wks`, `wps`, `wdb`)\n\n* Microsoft Write (`wri`)\n\n* Rich Text Format (`rtf`)\n\n* Shockwave Flash (`swf`)\n\n* Text (`ans`, `txt`).\n\nAdditional filetypes may be added in the future. An up-to-date list can\nalways be found in Google's [file type\nFAQ](https://support.google.com/webmasters/answer/35287).", + "type": "string" + }, + "filter": { + "description": "Activates or deactivates the automatic filtering of Google search\nresults. See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Valid values\nfor this parameter are:\n\n* `0`: Disabled\n\n* `1`: Enabled (default)\n\n**Note**: By default, Google applies filtering to all search results to\nimprove the quality of those results.", + "type": "string" + }, + "gl": { + "description": "Boosts search results whose country of origin matches the parameter\nvalue. See [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)\nfor a list of valid values.\n\nSpecifying a `gl` parameter value in WebSearch requests should improve\nthe relevance of results. This is particularly true for international\ncustomers and, even more specifically, for customers in English-speaking\ncountries other than the United States.", + "type": "string" + }, + "googleHost": { + "description": "Specifies the Google domain (for example, google.com, google.de, or\ngoogle.fr) to which the search should be limited.", + "type": "string" + }, + "highRange": { + "description": "Specifies the ending value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "type": "string" + }, + "hl": { + "description": "Specifies the interface language (host language) of your user interface.\nExplicitly setting this parameter improves the performance and the\nquality of your search results.\n\nSee the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and [Supported Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)\nfor a list of supported languages.", + "type": "string" + }, + "hq": { + "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical `AND` operator.", + "type": "string" + }, + "imgColorType": { + "description": "Restricts results to images of a specified color type. Supported values\n are:\n\n* `mono` (black and white)\n\n* `gray` (grayscale)\n\n* `color` (color)", + "type": "string" + }, + "imgDominantColor": { + "description": "Restricts results to images with a specific dominant color. Supported\nvalues are:\n\n* `red`\n\n* `orange`\n\n* `yellow`\n\n* `green`\n\n* `teal`\n\n* `blue`\n\n* `purple`\n\n* `pink`\n\n* `white`\n\n* `gray`\n\n* `black`\n\n* `brown`", + "type": "string" + }, + "imgSize": { + "description": "Restricts results to images of a specified size. Supported values are:\n\n* `icon` (small)\n\n* `small | medium | large | xlarge` (medium)\n\n* `xxlarge` (large)\n\n* `huge` (extra-large)", + "type": "string" + }, + "imgType": { + "description": "Restricts results to images of a specified type. Supported values are:\n\n* `clipart` (Clip art)\n\n* `face` (Face)\n\n* `lineart` (Line drawing)\n\n* `photo` (Photo)\n\n* `animated` (Animated)\n\n* `stock` (Stock)", + "type": "string" + }, + "inputEncoding": { + "description": "The character encoding supported for search requests.", + "type": "string" + }, + "language": { + "description": "The language of the search results.", + "type": "string" + }, + "linkSite": { + "description": "Specifies that all results should contain a link to a specific URL.", + "type": "string" + }, + "lowRange": { + "description": "Specifies the starting value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "type": "string" + }, + "orTerms": { + "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the\nadditional search terms. You can also use the [Boolean\nOR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)\nquery term for this type of query.", + "type": "string" + }, + "outputEncoding": { + "description": "The character encoding supported for search results.", + "type": "string" + }, + "relatedSite": { + "description": "Specifies that all search results should be pages that are related to the\nspecified URL. The parameter value should be a URL.", + "type": "string" + }, + "rights": { + "description": "Filters based on licensing. Supported values include:\n\n* `cc_publicdomain`\n\n* `cc_attribute`\n\n* `cc_sharealike`\n\n* `cc_noncommercial`\n\n* `cc_nonderived`", + "type": "string" + }, + "safe": { + "description": "Specifies the [SafeSearch\nlevel](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)\nused for filtering out adult results. This is a custom property not\ndefined in the OpenSearch spec. Valid parameter values are:\n\n* `\"off\"`: Disable SafeSearch\n\n* `\"active\"`: Enable SafeSearch", + "type": "string" + }, + "searchTerms": { + "description": "The search terms entered by the user.", + "type": "string" + }, + "searchType": { + "description": "Allowed values are `web` or `image`. If unspecified, results are limited\nto webpages.", + "type": "string" + }, + "siteSearch": { + "description": "Restricts results to URLs from a specified site.", + "type": "string" + }, + "siteSearchFilter": { + "description": "Specifies whether to include or exclude results from the site named in\nthe `sitesearch` parameter. Supported values are:\n\n* `i`: include content from site\n\n* `e`: exclude content from site", + "type": "string" + }, + "sort": { + "description": "Specifies that results should be sorted according to the specified\nexpression. For example, sort by date.", + "type": "string" + }, + "startIndex": { + "description": "The index of the current set of search results into the total set of\nresults, where the index of the first result is 1.", + "format": "int32", + "type": "integer" + }, + "startPage": { + "description": "The page number of this set of results, where the page length is set by\nthe `count` property.", + "format": "int32", + "type": "integer" + }, + "title": { + "description": "A description of the query.", + "type": "string" + }, + "totalResults": { + "description": "Estimated number of total search results. May not be accurate.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" }, - "type": "array" + "previousPage": { + "description": "Metadata representing the previous page of results, if applicable.", + "items": { + "description": "Custom search request metadata.", + "properties": { + "count": { + "description": "Number of search results returned in this set.", + "format": "int32", + "type": "integer" + }, + "cr": { + "description": "Restricts search results to documents originating in a particular\ncountry. You may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)\nin the `cr` parameter's value.\n\nGoogle WebSearch determines the country of a document by analyzing the\nfollowing:\n\n* The top-level domain (TLD) of the document's URL.\n\n* The geographic location of the web server's IP address.\n\nSee [Country (cr) Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results#countryCollections)\nfor a list of valid values for this parameter.", + "type": "string" + }, + "cx": { + "description": "The identifier of a custom search engine created using the Custom Search\n[Control Panel](https://cse.google.com/). This is a custom property not\ndefined in the OpenSearch spec. This parameter is **required**.", + "type": "string" + }, + "dateRestrict": { + "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", + "type": "string" + }, + "disableCnTwTranslation": { + "description": "Enables or disables the [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)\nfeature.\n\nSupported values are:\n\n* `0`: enabled (default)\n\n* `1`: disabled", + "type": "string" + }, + "exactTerms": { + "description": "Identifies a phrase that all documents in the search results must\ncontain.", + "type": "string" + }, + "excludeTerms": { + "description": "Identifies a word or phrase that should not appear in any documents in\nthe search results.", + "type": "string" + }, + "fileType": { + "description": "Restricts results to files of a specified extension. Filetypes supported\nby Google include:\n\n* Adobe Portable Document Format (`pdf`)\n\n* Adobe PostScript (`ps`)\n\n* Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)\n\n* Lotus WordPro (`lwp`)\n\n* Macwrite (`mw`)\n\n* Microsoft Excel (`xls`)\n\n* Microsoft PowerPoint (`ppt`)\n\n* Microsoft Word (`doc`)\n\n* Microsoft Works (`wks`, `wps`, `wdb`)\n\n* Microsoft Write (`wri`)\n\n* Rich Text Format (`rtf`)\n\n* Shockwave Flash (`swf`)\n\n* Text (`ans`, `txt`).\n\nAdditional filetypes may be added in the future. An up-to-date list can\nalways be found in Google's [file type\nFAQ](https://support.google.com/webmasters/answer/35287).", + "type": "string" + }, + "filter": { + "description": "Activates or deactivates the automatic filtering of Google search\nresults. See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Valid values\nfor this parameter are:\n\n* `0`: Disabled\n\n* `1`: Enabled (default)\n\n**Note**: By default, Google applies filtering to all search results to\nimprove the quality of those results.", + "type": "string" + }, + "gl": { + "description": "Boosts search results whose country of origin matches the parameter\nvalue. See [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)\nfor a list of valid values.\n\nSpecifying a `gl` parameter value in WebSearch requests should improve\nthe relevance of results. This is particularly true for international\ncustomers and, even more specifically, for customers in English-speaking\ncountries other than the United States.", + "type": "string" + }, + "googleHost": { + "description": "Specifies the Google domain (for example, google.com, google.de, or\ngoogle.fr) to which the search should be limited.", + "type": "string" + }, + "highRange": { + "description": "Specifies the ending value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "type": "string" + }, + "hl": { + "description": "Specifies the interface language (host language) of your user interface.\nExplicitly setting this parameter improves the performance and the\nquality of your search results.\n\nSee the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and [Supported Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)\nfor a list of supported languages.", + "type": "string" + }, + "hq": { + "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical `AND` operator.", + "type": "string" + }, + "imgColorType": { + "description": "Restricts results to images of a specified color type. Supported values\n are:\n\n* `mono` (black and white)\n\n* `gray` (grayscale)\n\n* `color` (color)", + "type": "string" + }, + "imgDominantColor": { + "description": "Restricts results to images with a specific dominant color. Supported\nvalues are:\n\n* `red`\n\n* `orange`\n\n* `yellow`\n\n* `green`\n\n* `teal`\n\n* `blue`\n\n* `purple`\n\n* `pink`\n\n* `white`\n\n* `gray`\n\n* `black`\n\n* `brown`", + "type": "string" + }, + "imgSize": { + "description": "Restricts results to images of a specified size. Supported values are:\n\n* `icon` (small)\n\n* `small | medium | large | xlarge` (medium)\n\n* `xxlarge` (large)\n\n* `huge` (extra-large)", + "type": "string" + }, + "imgType": { + "description": "Restricts results to images of a specified type. Supported values are:\n\n* `clipart` (Clip art)\n\n* `face` (Face)\n\n* `lineart` (Line drawing)\n\n* `photo` (Photo)\n\n* `animated` (Animated)\n\n* `stock` (Stock)", + "type": "string" + }, + "inputEncoding": { + "description": "The character encoding supported for search requests.", + "type": "string" + }, + "language": { + "description": "The language of the search results.", + "type": "string" + }, + "linkSite": { + "description": "Specifies that all results should contain a link to a specific URL.", + "type": "string" + }, + "lowRange": { + "description": "Specifies the starting value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "type": "string" + }, + "orTerms": { + "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the\nadditional search terms. You can also use the [Boolean\nOR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)\nquery term for this type of query.", + "type": "string" + }, + "outputEncoding": { + "description": "The character encoding supported for search results.", + "type": "string" + }, + "relatedSite": { + "description": "Specifies that all search results should be pages that are related to the\nspecified URL. The parameter value should be a URL.", + "type": "string" + }, + "rights": { + "description": "Filters based on licensing. Supported values include:\n\n* `cc_publicdomain`\n\n* `cc_attribute`\n\n* `cc_sharealike`\n\n* `cc_noncommercial`\n\n* `cc_nonderived`", + "type": "string" + }, + "safe": { + "description": "Specifies the [SafeSearch\nlevel](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)\nused for filtering out adult results. This is a custom property not\ndefined in the OpenSearch spec. Valid parameter values are:\n\n* `\"off\"`: Disable SafeSearch\n\n* `\"active\"`: Enable SafeSearch", + "type": "string" + }, + "searchTerms": { + "description": "The search terms entered by the user.", + "type": "string" + }, + "searchType": { + "description": "Allowed values are `web` or `image`. If unspecified, results are limited\nto webpages.", + "type": "string" + }, + "siteSearch": { + "description": "Restricts results to URLs from a specified site.", + "type": "string" + }, + "siteSearchFilter": { + "description": "Specifies whether to include or exclude results from the site named in\nthe `sitesearch` parameter. Supported values are:\n\n* `i`: include content from site\n\n* `e`: exclude content from site", + "type": "string" + }, + "sort": { + "description": "Specifies that results should be sorted according to the specified\nexpression. For example, sort by date.", + "type": "string" + }, + "startIndex": { + "description": "The index of the current set of search results into the total set of\nresults, where the index of the first result is 1.", + "format": "int32", + "type": "integer" + }, + "startPage": { + "description": "The page number of this set of results, where the page length is set by\nthe `count` property.", + "format": "int32", + "type": "integer" + }, + "title": { + "description": "A description of the query.", + "type": "string" + }, + "totalResults": { + "description": "Estimated number of total search results. May not be accurate.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "request": { + "description": "Metadata representing the current request.", + "items": { + "description": "Custom search request metadata.", + "properties": { + "count": { + "description": "Number of search results returned in this set.", + "format": "int32", + "type": "integer" + }, + "cr": { + "description": "Restricts search results to documents originating in a particular\ncountry. You may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)\nin the `cr` parameter's value.\n\nGoogle WebSearch determines the country of a document by analyzing the\nfollowing:\n\n* The top-level domain (TLD) of the document's URL.\n\n* The geographic location of the web server's IP address.\n\nSee [Country (cr) Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results#countryCollections)\nfor a list of valid values for this parameter.", + "type": "string" + }, + "cx": { + "description": "The identifier of a custom search engine created using the Custom Search\n[Control Panel](https://cse.google.com/). This is a custom property not\ndefined in the OpenSearch spec. This parameter is **required**.", + "type": "string" + }, + "dateRestrict": { + "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", + "type": "string" + }, + "disableCnTwTranslation": { + "description": "Enables or disables the [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)\nfeature.\n\nSupported values are:\n\n* `0`: enabled (default)\n\n* `1`: disabled", + "type": "string" + }, + "exactTerms": { + "description": "Identifies a phrase that all documents in the search results must\ncontain.", + "type": "string" + }, + "excludeTerms": { + "description": "Identifies a word or phrase that should not appear in any documents in\nthe search results.", + "type": "string" + }, + "fileType": { + "description": "Restricts results to files of a specified extension. Filetypes supported\nby Google include:\n\n* Adobe Portable Document Format (`pdf`)\n\n* Adobe PostScript (`ps`)\n\n* Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)\n\n* Lotus WordPro (`lwp`)\n\n* Macwrite (`mw`)\n\n* Microsoft Excel (`xls`)\n\n* Microsoft PowerPoint (`ppt`)\n\n* Microsoft Word (`doc`)\n\n* Microsoft Works (`wks`, `wps`, `wdb`)\n\n* Microsoft Write (`wri`)\n\n* Rich Text Format (`rtf`)\n\n* Shockwave Flash (`swf`)\n\n* Text (`ans`, `txt`).\n\nAdditional filetypes may be added in the future. An up-to-date list can\nalways be found in Google's [file type\nFAQ](https://support.google.com/webmasters/answer/35287).", + "type": "string" + }, + "filter": { + "description": "Activates or deactivates the automatic filtering of Google search\nresults. See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Valid values\nfor this parameter are:\n\n* `0`: Disabled\n\n* `1`: Enabled (default)\n\n**Note**: By default, Google applies filtering to all search results to\nimprove the quality of those results.", + "type": "string" + }, + "gl": { + "description": "Boosts search results whose country of origin matches the parameter\nvalue. See [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)\nfor a list of valid values.\n\nSpecifying a `gl` parameter value in WebSearch requests should improve\nthe relevance of results. This is particularly true for international\ncustomers and, even more specifically, for customers in English-speaking\ncountries other than the United States.", + "type": "string" + }, + "googleHost": { + "description": "Specifies the Google domain (for example, google.com, google.de, or\ngoogle.fr) to which the search should be limited.", + "type": "string" + }, + "highRange": { + "description": "Specifies the ending value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "type": "string" + }, + "hl": { + "description": "Specifies the interface language (host language) of your user interface.\nExplicitly setting this parameter improves the performance and the\nquality of your search results.\n\nSee the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and [Supported Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)\nfor a list of supported languages.", + "type": "string" + }, + "hq": { + "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical `AND` operator.", + "type": "string" + }, + "imgColorType": { + "description": "Restricts results to images of a specified color type. Supported values\n are:\n\n* `mono` (black and white)\n\n* `gray` (grayscale)\n\n* `color` (color)", + "type": "string" + }, + "imgDominantColor": { + "description": "Restricts results to images with a specific dominant color. Supported\nvalues are:\n\n* `red`\n\n* `orange`\n\n* `yellow`\n\n* `green`\n\n* `teal`\n\n* `blue`\n\n* `purple`\n\n* `pink`\n\n* `white`\n\n* `gray`\n\n* `black`\n\n* `brown`", + "type": "string" + }, + "imgSize": { + "description": "Restricts results to images of a specified size. Supported values are:\n\n* `icon` (small)\n\n* `small | medium | large | xlarge` (medium)\n\n* `xxlarge` (large)\n\n* `huge` (extra-large)", + "type": "string" + }, + "imgType": { + "description": "Restricts results to images of a specified type. Supported values are:\n\n* `clipart` (Clip art)\n\n* `face` (Face)\n\n* `lineart` (Line drawing)\n\n* `photo` (Photo)\n\n* `animated` (Animated)\n\n* `stock` (Stock)", + "type": "string" + }, + "inputEncoding": { + "description": "The character encoding supported for search requests.", + "type": "string" + }, + "language": { + "description": "The language of the search results.", + "type": "string" + }, + "linkSite": { + "description": "Specifies that all results should contain a link to a specific URL.", + "type": "string" + }, + "lowRange": { + "description": "Specifies the starting value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "type": "string" + }, + "orTerms": { + "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the\nadditional search terms. You can also use the [Boolean\nOR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)\nquery term for this type of query.", + "type": "string" + }, + "outputEncoding": { + "description": "The character encoding supported for search results.", + "type": "string" + }, + "relatedSite": { + "description": "Specifies that all search results should be pages that are related to the\nspecified URL. The parameter value should be a URL.", + "type": "string" + }, + "rights": { + "description": "Filters based on licensing. Supported values include:\n\n* `cc_publicdomain`\n\n* `cc_attribute`\n\n* `cc_sharealike`\n\n* `cc_noncommercial`\n\n* `cc_nonderived`", + "type": "string" + }, + "safe": { + "description": "Specifies the [SafeSearch\nlevel](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)\nused for filtering out adult results. This is a custom property not\ndefined in the OpenSearch spec. Valid parameter values are:\n\n* `\"off\"`: Disable SafeSearch\n\n* `\"active\"`: Enable SafeSearch", + "type": "string" + }, + "searchTerms": { + "description": "The search terms entered by the user.", + "type": "string" + }, + "searchType": { + "description": "Allowed values are `web` or `image`. If unspecified, results are limited\nto webpages.", + "type": "string" + }, + "siteSearch": { + "description": "Restricts results to URLs from a specified site.", + "type": "string" + }, + "siteSearchFilter": { + "description": "Specifies whether to include or exclude results from the site named in\nthe `sitesearch` parameter. Supported values are:\n\n* `i`: include content from site\n\n* `e`: exclude content from site", + "type": "string" + }, + "sort": { + "description": "Specifies that results should be sorted according to the specified\nexpression. For example, sort by date.", + "type": "string" + }, + "startIndex": { + "description": "The index of the current set of search results into the total set of\nresults, where the index of the first result is 1.", + "format": "int32", + "type": "integer" + }, + "startPage": { + "description": "The page number of this set of results, where the page length is set by\nthe `count` property.", + "format": "int32", + "type": "integer" + }, + "title": { + "description": "A description of the query.", + "type": "string" + }, + "totalResults": { + "description": "Estimated number of total search results. May not be accurate.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } }, "type": "object" }, "searchInformation": { + "description": "Metadata about a search operation.", "properties": { "formattedSearchTime": { + "description": "The time taken for the server to return search results, formatted\naccording to locale style.", "type": "string" }, "formattedTotalResults": { + "description": "The total number of search results, formatted according to locale style.", "type": "string" }, "searchTime": { + "description": "The time taken for the server to return search results.", "format": "double", "type": "number" }, "totalResults": { - "format": "int64", + "description": "The total number of search results returned by the query.", "type": "string" } }, "type": "object" }, "spelling": { + "description": "Spell correction information for a query.", "properties": { "correctedQuery": { + "description": "The corrected query.", "type": "string" }, "htmlCorrectedQuery": { + "description": "The corrected query, formatted in HTML.", "type": "string" } }, "type": "object" }, "url": { + "description": "OpenSearch template and URL.", "properties": { "template": { - "default": "https://www.googleapis.com/customsearch/v1?q={searchTerms}&num={count?}&start={startIndex?}&lr={language?}&safe={safe?}&cx={cx?}&sort={sort?}&filter={filter?}&gl={gl?}&cr={cr?}&googlehost={googleHost?}&c2coff={disableCnTwTranslation?}&hq={hq?}&hl={hl?}&siteSearch={siteSearch?}&siteSearchFilter={siteSearchFilter?}&exactTerms={exactTerms?}&excludeTerms={excludeTerms?}&linkSite={linkSite?}&orTerms={orTerms?}&relatedSite={relatedSite?}&dateRestrict={dateRestrict?}&lowRange={lowRange?}&highRange={highRange?}&searchType={searchType}&fileType={fileType?}&rights={rights?}&imgSize={imgSize?}&imgType={imgType?}&imgColorType={imgColorType?}&imgDominantColor={imgDominantColor?}&alt=json", + "description": "The actual [OpenSearch\ntemplate](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax)\nfor this API.", "type": "string" }, "type": { - "default": "application/json", + "description": "The MIME type of the OpenSearch URL template for the Custom Search API.", "type": "string" } }, @@ -1160,7 +1320,8 @@ "type": "object" } }, - "servicePath": "customsearch/", - "title": "CustomSearch API", - "version": "v1" + "servicePath": "", + "title": "Custom Search API", + "version": "v1", + "version_module": true } \ No newline at end of file diff --git a/discovery/datacatalog-v1beta1.json b/discovery/datacatalog-v1beta1.json index e6406ca91b6..7ecd52b7e9f 100644 --- a/discovery/datacatalog-v1beta1.json +++ b/discovery/datacatalog-v1beta1.json @@ -1385,7 +1385,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of project that the newly created taxonomies will\nbelong to.", + "description": "Required. Resource name of project that the imported taxonomies will belong to.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1774,7 +1774,7 @@ } } }, - "revision": "20200422", + "revision": "20200430", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2148,7 +2148,7 @@ "properties": { "inlineSource": { "$ref": "GoogleCloudDatacatalogV1beta1InlineSource", - "description": "Inline source used for taxonomies import" + "description": "Inline source used for taxonomies to be imported." } }, "type": "object" @@ -2375,6 +2375,13 @@ "type": "string" }, "type": "array" + }, + "restrictedLocations": { + "description": "Optional. The list of locations to search within.\n1. If empty, search will be performed in all locations;\n2. If any of the locations are NOT in the valid locations list, error\nwill be returned;\n3. Otherwise, search only the given locations for matching results.\nTypical usage is to leave this field empty. When a location is\nunreachable as returned in the `SearchCatalogResponse.unreachable` field,\nusers can repeat the search request with this parameter set to get\nadditional information on the error.\n\nValid locations:\n * asia-east1\n * asia-east2\n * asia-northeast1\n * asia-northeast2\n * asia-northeast3\n * asia-south1\n * asia-southeast1\n * australia-southeast1\n * eu\n * europe-north1\n * europe-west1\n * europe-west2\n * europe-west3\n * europe-west4\n * europe-west6\n * global\n * northamerica-northeast1\n * southamerica-east1\n * us\n * us-central1\n * us-east1\n * us-east4\n * us-west1\n * us-west2", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2393,6 +2400,13 @@ "$ref": "GoogleCloudDatacatalogV1beta1SearchCatalogResult" }, "type": "array" + }, + "unreachable": { + "description": "Unreachable locations. Search result does not include data from those\nlocations. Users can get additional information on the error by repeating\nthe search request with a more restrictive parameter -- setting the value\nfor `SearchDataCatalogRequest.scope.include_locations`.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2450,6 +2464,10 @@ "displayName": { "description": "Required. Display name of the policy tag. Max 200 bytes when encoded in UTF-8.", "type": "string" + }, + "policyTag": { + "description": "Resource name of the policy tag.\n\nThis field will be ignored when calling ImportTaxonomies.", + "type": "string" } }, "type": "object" diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 7076d96a6ae..aa417414cf2 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -2049,7 +2049,7 @@ } } }, - "revision": "20200428", + "revision": "20200512", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowV2Agent": { @@ -2703,7 +2703,7 @@ "type": "object" }, "uri": { - "description": "Required. The fulfillment URI for receiving POST requests.", + "description": "Required. The fulfillment URI for receiving POST requests.\nIt must use https protocol.", "type": "string" }, "username": { @@ -4197,7 +4197,7 @@ "id": "GoogleCloudDialogflowV2SpeechContext", "properties": { "boost": { - "description": "Optional. Boost for this context compared to other contexts:\n* If the boost is positive, Dialogflow will increase the probability that\n the phrases in this context are recognized over similar sounding phrases.\n* If the boost is unspecified or non-positive, Dialogflow will not apply\n any boost.\n\nDialogflow recommends that you use boosts in the range (0, 20] and that you\nfind a value that fits your use case with binary search.", + "description": "Optional. Boost for this context compared to other contexts:\n\n* If the boost is positive, Dialogflow will increase the probability that\n the phrases in this context are recognized over similar sounding phrases.\n* If the boost is unspecified or non-positive, Dialogflow will not apply\n any boost.\n\nDialogflow recommends that you use boosts in the range (0, 20] and that you\nfind a value that fits your use case with binary search.", "format": "float", "type": "number" }, @@ -4371,21 +4371,21 @@ "properties": { "followupEventInput": { "$ref": "GoogleCloudDialogflowV2EventInput", - "description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields." + "description": "Optional. Invokes the supplied events.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields." }, "fulfillmentMessages": { - "description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.", + "description": "Optional. The rich response messages intended for the end-user.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_messages sent to the integration or API caller.", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessage" }, "type": "array" }, "fulfillmentText": { - "description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.", + "description": "Optional. The text response message intended for the end-user.\nIt is recommended to use `fulfillment_messages.text.text[0]` instead.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_text sent to the integration or API caller.", "type": "string" }, "outputContexts": { - "description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.", + "description": "Optional. The collection of output contexts that will overwrite currently\nactive contexts for the session and reset their lifespans.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.output_contexts sent to the integration or API caller.", "items": { "$ref": "GoogleCloudDialogflowV2Context" }, @@ -4396,18 +4396,18 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. This field can be used to pass custom data from your webhook to the API\ncaller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\n`QueryResult.webhook_payload` sent to the API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "description": "Optional. This field can be used to pass custom data from your webhook to the\nintegration or API caller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_payload sent to the integration or API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "type": "object" }, "sessionEntityTypes": { - "description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query. Setting the session entity types inside\nwebhook overwrites the session entity types that have been set through\n`DetectIntentRequest.query_params.session_entity_types`.", + "description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session. Setting this data from a webhook overwrites\nthe session entity types that have been set using `detectIntent`,\n`streamingDetectIntent` or SessionEntityType management methods.", "items": { "$ref": "GoogleCloudDialogflowV2SessionEntityType" }, "type": "array" }, "source": { - "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.", + "description": "Optional. A custom field used to identify the webhook source.\nArbitrary strings are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_source sent to the integration or API caller.", "type": "string" } }, @@ -4671,7 +4671,7 @@ "type": "array" }, "followupIntentInfo": { - "description": "Read-only. Information about all followup intents that have this intent as\na direct or indirect parent. We populate this field only in the output.", + "description": "Output only. Information about all followup intents that have this intent as\na direct or indirect parent. We populate this field only in the output.", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo" }, @@ -4704,7 +4704,7 @@ "type": "boolean" }, "name": { - "description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects//agent/intents/`.", + "description": "Optional. The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects//agent/intents/`.", "type": "string" }, "outputContexts": { @@ -4722,11 +4722,11 @@ "type": "array" }, "parentFollowupIntentName": { - "description": "Read-only after creation. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or\nBatchUpdateIntents, in order to make this\nintent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects//agent/intents/`.", + "description": "Optional. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or\nBatchUpdateIntents, in order to make this\nintent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects//agent/intents/`.", "type": "string" }, "priority": { - "description": "The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.", + "description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.", "format": "int32", "type": "integer" }, @@ -4735,7 +4735,7 @@ "type": "boolean" }, "rootFollowupIntentName": { - "description": "Read-only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent. We populate this field only in the output.\n\nFormat: `projects//agent/intents/`.", + "description": "Output only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent.\n\nFormat: `projects//agent/intents/`.", "type": "string" }, "trainingPhrases": { @@ -5873,7 +5873,7 @@ "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { "state": { - "description": "Required. The current state of this operation.", + "description": "Required. Output only. The current state of this operation.", "enum": [ "STATE_UNSPECIFIED", "PENDING", @@ -6116,21 +6116,21 @@ }, "followupEventInput": { "$ref": "GoogleCloudDialogflowV2beta1EventInput", - "description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields." + "description": "Optional. Invokes the supplied events.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields." }, "fulfillmentMessages": { - "description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.", + "description": "Optional. The rich response messages intended for the end-user.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_messages sent to the integration or API caller.", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" }, "type": "array" }, "fulfillmentText": { - "description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.", + "description": "Optional. The text response message intended for the end-user.\nIt is recommended to use `fulfillment_messages.text.text[0]` instead.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_text sent to the integration or API caller.", "type": "string" }, "outputContexts": { - "description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.", + "description": "Optional. The collection of output contexts that will overwrite currently\nactive contexts for the session and reset their lifespans.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.output_contexts sent to the integration or API caller.", "items": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, @@ -6141,18 +6141,34 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. This field can be used to pass custom data from your webhook to the API\ncaller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\n`QueryResult.webhook_payload` sent to the API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "description": "Optional. This field can be used to pass custom data from your webhook to the\nintegration or API caller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_payload sent to the integration or API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "type": "object" }, "sessionEntityTypes": { - "description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query. Setting the session entity types inside\nwebhook overwrites the session entity types that have been set through\n`DetectIntentRequest.query_params.session_entity_types`.", + "description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session. Setting this data from a webhook overwrites\nthe session entity types that have been set using `detectIntent`,\n`streamingDetectIntent` or SessionEntityType management methods.", "items": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "type": "array" }, "source": { - "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.", + "description": "Optional. A custom field used to identify the webhook source.\nArbitrary strings are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_source sent to the integration or API caller.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1ExportAgentResponse": { + "description": "The response message for Agents.ExportAgent.", + "id": "GoogleCloudDialogflowV3alpha1ExportAgentResponse", + "properties": { + "agentContent": { + "description": "Uncompressed raw byte content for agent.", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in ExportAgentRequest.", "type": "string" } }, diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index dd6429acb85..60b04d242c6 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -346,7 +346,7 @@ ] }, "search": { - "description": "Returns the list of agents.\n\nSince there is at most one conversational agent per project, this method is\nuseful primarily for listing all agents across projects the caller has\naccess to. One can achieve that with a wildcard project collection id \"-\".\nRefer to [List\nSub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).", + "description": "Returns the list of agents.\nSince there is at most one conversational agent per project, this method is\nuseful primarily for listing all agents across projects the caller has\naccess to. One can achieve that with a wildcard project collection id \"-\".\nRefer to [List\nSub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).", "flatPath": "v2beta1/projects/{projectsId}/agent:search", "httpMethod": "GET", "id": "dialogflow.projects.agent.search", @@ -451,7 +451,7 @@ "entityTypes": { "methods": { "batchDelete": { - "description": "Deletes entity types in the specified agent.\n\nOperation ", + "description": "Deletes entity types in the specified agent.\nOperation ", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchDelete", "httpMethod": "POST", "id": "dialogflow.projects.agent.entityTypes.batchDelete", @@ -480,7 +480,7 @@ ] }, "batchUpdate": { - "description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation ", + "description": "Updates/Creates multiple entity types in the specified agent.\nOperation ", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchUpdate", "httpMethod": "POST", "id": "dialogflow.projects.agent.entityTypes.batchUpdate", @@ -1442,7 +1442,7 @@ "type": "string" }, "name": { - "description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects//agent/intents/`.", + "description": "Optional. The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects//agent/intents/`.", "location": "path", "pattern": "^projects/[^/]+/agent/intents/[^/]+$", "required": true, @@ -1643,7 +1643,7 @@ ], "parameters": { "parent": { - "description": "Required. The knoweldge base to create a document for.\nFormat: `projects//knowledgeBases/`.", + "description": "The knoweldge base to create a document for.\nFormat: `projects//knowledgeBases/`.", "location": "path", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", "required": true, @@ -1672,7 +1672,7 @@ ], "parameters": { "name": { - "description": "The name of the document to delete.\nFormat: `projects//knowledgeBases//documents/`.", + "description": "Required. The name of the document to delete.\nFormat: `projects//knowledgeBases//documents/`.", "location": "path", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", "required": true, @@ -1761,7 +1761,7 @@ ], "parameters": { "name": { - "description": "The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects//knowledgeBases//documents/`.", + "description": "Optional. The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects//knowledgeBases//documents/`.", "location": "path", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", "required": true, @@ -1796,7 +1796,7 @@ ], "parameters": { "name": { - "description": "The name of the document to reload.\nFormat: `projects//knowledgeBases//documents/`", + "description": "Required. The name of the document to reload.\nFormat: `projects//knowledgeBases//documents/`", "location": "path", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", "required": true, @@ -2370,7 +2370,7 @@ ], "parameters": { "parent": { - "description": "Required. The knoweldge base to create a document for.\nFormat: `projects//knowledgeBases/`.", + "description": "The knoweldge base to create a document for.\nFormat: `projects//knowledgeBases/`.", "location": "path", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", "required": true, @@ -2399,7 +2399,7 @@ ], "parameters": { "name": { - "description": "The name of the document to delete.\nFormat: `projects//knowledgeBases//documents/`.", + "description": "Required. The name of the document to delete.\nFormat: `projects//knowledgeBases//documents/`.", "location": "path", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "required": true, @@ -2488,7 +2488,7 @@ ], "parameters": { "name": { - "description": "The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects//knowledgeBases//documents/`.", + "description": "Optional. The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects//knowledgeBases//documents/`.", "location": "path", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "required": true, @@ -2523,7 +2523,7 @@ ], "parameters": { "name": { - "description": "The name of the document to reload.\nFormat: `projects//knowledgeBases//documents/`", + "description": "Required. The name of the document to reload.\nFormat: `projects//knowledgeBases//documents/`", "location": "path", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "required": true, @@ -2821,7 +2821,7 @@ "entityTypes": { "methods": { "batchDelete": { - "description": "Deletes entity types in the specified agent.\n\nOperation ", + "description": "Deletes entity types in the specified agent.\nOperation ", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes:batchDelete", "httpMethod": "POST", "id": "dialogflow.projects.locations.agent.entityTypes.batchDelete", @@ -2850,7 +2850,7 @@ ] }, "batchUpdate": { - "description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation ", + "description": "Updates/Creates multiple entity types in the specified agent.\nOperation ", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes:batchUpdate", "httpMethod": "POST", "id": "dialogflow.projects.locations.agent.entityTypes.batchUpdate", @@ -3812,7 +3812,7 @@ "type": "string" }, "name": { - "description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects//agent/intents/`.", + "description": "Optional. The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects//agent/intents/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$", "required": true, @@ -4417,7 +4417,7 @@ } } }, - "revision": "20200428", + "revision": "20200512", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowV2AnnotatedMessagePart": { @@ -5806,21 +5806,21 @@ "properties": { "followupEventInput": { "$ref": "GoogleCloudDialogflowV2EventInput", - "description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields." + "description": "Optional. Invokes the supplied events.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields." }, "fulfillmentMessages": { - "description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.", + "description": "Optional. The rich response messages intended for the end-user.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_messages sent to the integration or API caller.", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessage" }, "type": "array" }, "fulfillmentText": { - "description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.", + "description": "Optional. The text response message intended for the end-user.\nIt is recommended to use `fulfillment_messages.text.text[0]` instead.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_text sent to the integration or API caller.", "type": "string" }, "outputContexts": { - "description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.", + "description": "Optional. The collection of output contexts that will overwrite currently\nactive contexts for the session and reset their lifespans.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.output_contexts sent to the integration or API caller.", "items": { "$ref": "GoogleCloudDialogflowV2Context" }, @@ -5831,18 +5831,18 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. This field can be used to pass custom data from your webhook to the API\ncaller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\n`QueryResult.webhook_payload` sent to the API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "description": "Optional. This field can be used to pass custom data from your webhook to the\nintegration or API caller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_payload sent to the integration or API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "type": "object" }, "sessionEntityTypes": { - "description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query. Setting the session entity types inside\nwebhook overwrites the session entity types that have been set through\n`DetectIntentRequest.query_params.session_entity_types`.", + "description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session. Setting this data from a webhook overwrites\nthe session entity types that have been set using `detectIntent`,\n`streamingDetectIntent` or SessionEntityType management methods.", "items": { "$ref": "GoogleCloudDialogflowV2SessionEntityType" }, "type": "array" }, "source": { - "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.", + "description": "Optional. A custom field used to identify the webhook source.\nArbitrary strings are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_source sent to the integration or API caller.", "type": "string" } }, @@ -6288,7 +6288,7 @@ "type": "string" }, "name": { - "description": "The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects//knowledgeBases//documents/`.", + "description": "Optional. The document resource name.\nThe name must be empty when creating a document.\nFormat: `projects//knowledgeBases//documents/`.", "type": "string" }, "rawContent": { @@ -6560,7 +6560,7 @@ "type": "object" }, "uri": { - "description": "Required. The fulfillment URI for receiving POST requests.", + "description": "Required. The fulfillment URI for receiving POST requests.\nIt must use https protocol.", "type": "string" }, "username": { @@ -6736,7 +6736,7 @@ "type": "array" }, "followupIntentInfo": { - "description": "Read-only. Information about all followup intents that have this intent as\na direct or indirect parent. We populate this field only in the output.", + "description": "Output only. Information about all followup intents that have this intent as\na direct or indirect parent. We populate this field only in the output.", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo" }, @@ -6769,7 +6769,7 @@ "type": "boolean" }, "name": { - "description": "The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects//agent/intents/`.", + "description": "Optional. The unique identifier of this intent.\nRequired for Intents.UpdateIntent and Intents.BatchUpdateIntents\nmethods.\nFormat: `projects//agent/intents/`.", "type": "string" }, "outputContexts": { @@ -6787,11 +6787,11 @@ "type": "array" }, "parentFollowupIntentName": { - "description": "Read-only after creation. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or\nBatchUpdateIntents, in order to make this\nintent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects//agent/intents/`.", + "description": "Optional. The unique identifier of the parent intent in the\nchain of followup intents. You can set this field when creating an intent,\nfor example with CreateIntent or\nBatchUpdateIntents, in order to make this\nintent a followup intent.\n\nIt identifies the parent followup intent.\nFormat: `projects//agent/intents/`.", "type": "string" }, "priority": { - "description": "The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.", + "description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities.\n\n- If the supplied value is unspecified or 0, the service\n translates the value to 500,000, which corresponds to the\n `Normal` priority in the console.\n- If the supplied value is negative, the intent is ignored\n in runtime detect intent requests.", "format": "int32", "type": "integer" }, @@ -6800,7 +6800,7 @@ "type": "boolean" }, "rootFollowupIntentName": { - "description": "Read-only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent. We populate this field only in the output.\n\nFormat: `projects//agent/intents/`.", + "description": "Output only. The unique identifier of the root intent in the chain of\nfollowup intents. It identifies the correct followup intents chain for\nthis intent.\n\nFormat: `projects//agent/intents/`.", "type": "string" }, "trainingPhrases": { @@ -7971,7 +7971,7 @@ "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { "state": { - "description": "Required. The current state of this operation.", + "description": "Required. Output only. The current state of this operation.", "enum": [ "STATE_UNSPECIFIED", "PENDING", @@ -8478,7 +8478,7 @@ "id": "GoogleCloudDialogflowV2beta1SpeechContext", "properties": { "boost": { - "description": "Optional. Boost for this context compared to other contexts:\n* If the boost is positive, Dialogflow will increase the probability that\n the phrases in this context are recognized over similar sounding phrases.\n* If the boost is unspecified or non-positive, Dialogflow will not apply\n any boost.\n\nDialogflow recommends that you use boosts in the range (0, 20] and that you\nfind a value that fits your use case with binary search.", + "description": "Optional. Boost for this context compared to other contexts:\n\n* If the boost is positive, Dialogflow will increase the probability that\n the phrases in this context are recognized over similar sounding phrases.\n* If the boost is unspecified or non-positive, Dialogflow will not apply\n any boost.\n\nDialogflow recommends that you use boosts in the range (0, 20] and that you\nfind a value that fits your use case with binary search.", "format": "float", "type": "number" }, @@ -8678,21 +8678,21 @@ }, "followupEventInput": { "$ref": "GoogleCloudDialogflowV2beta1EventInput", - "description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields." + "description": "Optional. Invokes the supplied events.\nWhen this field is set, Dialogflow ignores the `fulfillment_text`,\n`fulfillment_messages`, and `payload` fields." }, "fulfillmentMessages": { - "description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.", + "description": "Optional. The rich response messages intended for the end-user.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_messages sent to the integration or API caller.", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" }, "type": "array" }, "fulfillmentText": { - "description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.", + "description": "Optional. The text response message intended for the end-user.\nIt is recommended to use `fulfillment_messages.text.text[0]` instead.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.fulfillment_text sent to the integration or API caller.", "type": "string" }, "outputContexts": { - "description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.", + "description": "Optional. The collection of output contexts that will overwrite currently\nactive contexts for the session and reset their lifespans.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.output_contexts sent to the integration or API caller.", "items": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, @@ -8703,18 +8703,34 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. This field can be used to pass custom data from your webhook to the API\ncaller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\n`QueryResult.webhook_payload` sent to the API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "description": "Optional. This field can be used to pass custom data from your webhook to the\nintegration or API caller. Arbitrary JSON objects are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_payload sent to the integration or API caller.\nThis field is also used by the\n[Google Assistant\nintegration](https://cloud.google.com/dialogflow/docs/integrations/aog)\nfor rich response messages.\nSee the format definition at [Google Assistant Dialogflow webhook\nformat](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "type": "object" }, "sessionEntityTypes": { - "description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session of this query. Setting the session entity types inside\nwebhook overwrites the session entity types that have been set through\n`DetectIntentRequest.query_params.session_entity_types`.", + "description": "Optional. Additional session entity types to replace or extend developer\nentity types with. The entity synonyms apply to all languages and persist\nfor the session. Setting this data from a webhook overwrites\nthe session entity types that have been set using `detectIntent`,\n`streamingDetectIntent` or SessionEntityType management methods.", "items": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "type": "array" }, "source": { - "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.", + "description": "Optional. A custom field used to identify the webhook source.\nArbitrary strings are supported.\nWhen provided, Dialogflow uses this field to populate\nQueryResult.webhook_source sent to the integration or API caller.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1ExportAgentResponse": { + "description": "The response message for Agents.ExportAgent.", + "id": "GoogleCloudDialogflowV3alpha1ExportAgentResponse", + "properties": { + "agentContent": { + "description": "Uncompressed raw byte content for agent.", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in ExportAgentRequest.", "type": "string" } }, diff --git a/discovery/discovery-v1.json b/discovery/discovery-v1.json index f3846415af6..d7b707810d3 100644 --- a/discovery/discovery-v1.json +++ b/discovery/discovery-v1.json @@ -5,7 +5,7 @@ "description": "Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/discovery/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/SDw4N-pwDNV0euYg0y6-NjkJu1A\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/SkonogyFkVaMzpxWkF9B9P1QZ1Q\"", "icons": { "x16": "http://www.google.com/images/icons/feature/filing_cabinet_search-g16.png", "x32": "http://www.google.com/images/icons/feature/filing_cabinet_search-g32.png" @@ -116,7 +116,7 @@ } } }, - "revision": "20200414", + "revision": "20200429", "rootUrl": "https://www.googleapis.com/", "schemas": { "DirectoryList": { diff --git a/discovery/displayvideo-v1.json b/discovery/displayvideo-v1.json index fd9928f7d78..34c4b1fd93c 100644 --- a/discovery/displayvideo-v1.json +++ b/discovery/displayvideo-v1.json @@ -2796,7 +2796,7 @@ } } }, - "revision": "20200430", + "revision": "20200512", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -6668,6 +6668,11 @@ "format": "int64", "type": "string" }, + "campaignBudgetId": { + "description": "The ID of the campaign budget linked to this insertion order budget\nsegment.", + "format": "int64", + "type": "string" + }, "dateRange": { "$ref": "DateRange", "description": "Required. The start and end date settings of the budget segment. They are resolved\nrelative to the parent advertiser's time zone.\n\n* When creating a new budget segment, both `start_date` and `end_date`\nmust be in the future.\n* An existing budget segment with a `start_date` in the past has a mutable\n`end_date` but an immutable `start_date`.\n* `end_date` must be the `start_date` or later, both before the year 2037." diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 28ce486cbf6..7d8f9a9003c 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -4848,11 +4848,11 @@ }, "lowerBound": { "$ref": "GooglePrivacyDlpV2Value", - "description": "Required. Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value “-10”." + "description": "Required. Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value \"-10\"." }, "upperBound": { "$ref": "GooglePrivacyDlpV2Value", - "description": "Required. Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value “89+”." + "description": "Required. Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value \"89+\"." } }, "type": "object" @@ -5999,7 +5999,7 @@ ], "enumDescriptions": [ "Unused", - "General file metadata provided by GCS." + "General file metadata provided by Cloud Storage." ], "type": "string" } diff --git a/discovery/docs-v1.json b/discovery/docs-v1.json index 609707dd849..3be56db631e 100644 --- a/discovery/docs-v1.json +++ b/discovery/docs-v1.json @@ -210,7 +210,7 @@ } } }, - "revision": "20200429", + "revision": "20200508", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { diff --git a/discovery/domainsrdap-v1.json b/discovery/domainsrdap-v1.json index 5799e7bf5de..2cea6adc6e7 100644 --- a/discovery/domainsrdap-v1.json +++ b/discovery/domainsrdap-v1.json @@ -289,7 +289,7 @@ } } }, - "revision": "20200504", + "revision": "20200509", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/discovery/doubleclicksearch-v2.json b/discovery/doubleclicksearch-v2.json index 75dbb54f704..17e3d1d9ff3 100644 --- a/discovery/doubleclicksearch-v2.json +++ b/discovery/doubleclicksearch-v2.json @@ -14,7 +14,7 @@ "description": "Reports and modifies your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions).", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/doubleclick-search/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/l7De0SvrRCiNQOHLH-iZ_wHgEAg\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/WcR8RMCcVAmjGjEh84HY6FwWT8A\"", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -350,7 +350,7 @@ } } }, - "revision": "20200414", + "revision": "20200505", "rootUrl": "https://www.googleapis.com/", "schemas": { "Availability": { diff --git a/discovery/drive-v2.json b/discovery/drive-v2.json index 2eec3a6830d..237e3c85e51 100644 --- a/discovery/drive-v2.json +++ b/discovery/drive-v2.json @@ -38,7 +38,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/KCYZbfuowVghIgfO0xcetlVhLhw\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/YHQWlCS_UdYiRxWbR3ICljRAiNg\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -3442,7 +3442,7 @@ } } }, - "revision": "20200417", + "revision": "20200505", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index d1dac3701d7..0bca98259c0 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -35,7 +35,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/FdQR2PuSNWtGMMUKoNdRc27FezA\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/QAkQAEY30ssATXLd1qBIbr9SiLc\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -2126,7 +2126,7 @@ } } }, - "revision": "20200417", + "revision": "20200505", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/discovery/driveactivity-v2.json b/discovery/driveactivity-v2.json index 946cc2cfe8f..b7141fa421a 100644 --- a/discovery/driveactivity-v2.json +++ b/discovery/driveactivity-v2.json @@ -132,7 +132,7 @@ } } }, - "revision": "20200428", + "revision": "20200509", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { diff --git a/discovery/factchecktools-v1alpha1.json b/discovery/factchecktools-v1alpha1.json index 0d7962f6d71..09ed910ae2e 100644 --- a/discovery/factchecktools-v1alpha1.json +++ b/discovery/factchecktools-v1alpha1.json @@ -304,7 +304,7 @@ } } }, - "revision": "20200502", + "revision": "20200511", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": { diff --git a/discovery/fcm-v1.json b/discovery/fcm-v1.json index 47298debd6a..a16ae0dcc36 100644 --- a/discovery/fcm-v1.json +++ b/discovery/fcm-v1.json @@ -142,7 +142,7 @@ } } }, - "revision": "20200427", + "revision": "20200505", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/discovery/firebase-v1beta1.json b/discovery/firebase-v1beta1.json index 037006035b5..96e0f7ef30d 100644 --- a/discovery/firebase-v1beta1.json +++ b/discovery/firebase-v1beta1.json @@ -183,7 +183,7 @@ "projects": { "methods": { "addFirebase": { - "description": "Adds Firebase resources to the specified existing\n[Google Cloud Platform (GCP) `Project`]\n(https://cloud.google.com/resource-manager/reference/rest/v1/projects).\n
\n
Since a FirebaseProject is actually also a GCP `Project`, a\n`FirebaseProject` uses underlying GCP identifiers (most importantly,\nthe `projectId`) as its own for easy interop with GCP APIs.\n
\n
The result of this call is an [`Operation`](../../v1beta1/operations).\nPoll the `Operation` to track the provisioning process by calling\nGetOperation until\n[`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When\n`done` is `true`, the `Operation` has either succeeded or failed. If the\n`Operation` succeeded, its\n[`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to\na FirebaseProject; if the `Operation` failed, its\n[`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a\ngoogle.rpc.Status. The `Operation` is automatically deleted after\ncompletion, so there is no need to call\nDeleteOperation.\n
\n
This method does not modify any billing account information on the\nunderlying GCP `Project`.\n
\n
To call `AddFirebase`, a member must be an Editor or Owner for the\nexisting GCP `Project`. Service accounts cannot call `AddFirebase`.", + "description": "Adds Firebase resources to the specified existing\n[Google Cloud Platform (GCP) `Project`]\n(https://cloud.google.com/resource-manager/reference/rest/v1/projects).\n
\n
Since a FirebaseProject is actually also a GCP `Project`, a\n`FirebaseProject` uses underlying GCP identifiers (most importantly,\nthe `projectId`) as its own for easy interop with GCP APIs.\n
\n
The result of this call is an [`Operation`](../../v1beta1/operations).\nPoll the `Operation` to track the provisioning process by calling\nGetOperation until\n[`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When\n`done` is `true`, the `Operation` has either succeeded or failed. If the\n`Operation` succeeded, its\n[`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to\na FirebaseProject; if the `Operation` failed, its\n[`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a\ngoogle.rpc.Status. The `Operation` is automatically deleted after\ncompletion, so there is no need to call\nDeleteOperation.\n
\n
This method does not modify any billing account information on the\nunderlying GCP `Project`.\n
\n
To call `AddFirebase`, a project member or service account must have\nthe following permissions (the IAM roles of Editor and Owner contain these\npermissions):\n`firebase.projects.update`, `resourcemanager.projects.get`,\n`serviceusage.services.enable`, and `serviceusage.services.get`.", "flatPath": "v1beta1/projects/{projectsId}:addFirebase", "httpMethod": "POST", "id": "firebase.projects.addFirebase", @@ -1116,7 +1116,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/discovery/firebasedynamiclinks-v1.json b/discovery/firebasedynamiclinks-v1.json index 073ccab3007..d5bcdaee001 100644 --- a/discovery/firebasedynamiclinks-v1.json +++ b/discovery/firebasedynamiclinks-v1.json @@ -224,7 +224,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": { diff --git a/discovery/firebaseml-v1beta2.json b/discovery/firebaseml-v1beta2.json index e3bc0cfac98..23f991f63a4 100644 --- a/discovery/firebaseml-v1beta2.json +++ b/discovery/firebaseml-v1beta2.json @@ -296,7 +296,7 @@ } } }, - "revision": "20200501", + "revision": "20200509", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/firebaserules-v1.json b/discovery/firebaserules-v1.json index 5e86c397436..858937f29d5 100644 --- a/discovery/firebaserules-v1.json +++ b/discovery/firebaserules-v1.json @@ -472,7 +472,7 @@ } } }, - "revision": "20200407", + "revision": "20200430", "rootUrl": "https://firebaserules.googleapis.com/", "schemas": { "Arg": { diff --git a/discovery/fitness-v1.json b/discovery/fitness-v1.json index 28dc01cbd9f..d3f9f51afd3 100644 --- a/discovery/fitness-v1.json +++ b/discovery/fitness-v1.json @@ -65,7 +65,7 @@ "description": "Stores and accesses user data in the fitness store from apps on any platform.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/fit/rest/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/TYOWQeLiGlZPchqLSRpmQsAC8E4\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/EziV23x-AFysmUIFfPMENcQrDOk\"", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -768,7 +768,7 @@ } } }, - "revision": "20200422", + "revision": "20200505", "rootUrl": "https://www.googleapis.com/", "schemas": { "AggregateBucket": { diff --git a/discovery/gamesConfiguration-v1configuration.json b/discovery/gamesConfiguration-v1configuration.json index 524d841bc25..2eb16718e84 100644 --- a/discovery/gamesConfiguration-v1configuration.json +++ b/discovery/gamesConfiguration-v1configuration.json @@ -434,7 +434,7 @@ } } }, - "revision": "20200416", + "revision": "20200504", "rootUrl": "https://www.googleapis.com/", "schemas": { "AchievementConfiguration": { diff --git a/discovery/gameservices-v1beta.json b/discovery/gameservices-v1beta.json index 5d81e72b9ba..fe8c0e5a852 100644 --- a/discovery/gameservices-v1beta.json +++ b/discovery/gameservices-v1beta.json @@ -185,7 +185,7 @@ "gameServerDeployments": { "methods": { "create": { - "description": "Creates a new Game Server Deployment in a given project and Location.", + "description": "Creates a new game server deployment in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments", "httpMethod": "POST", "id": "gameservices.projects.locations.gameServerDeployments.create", @@ -194,7 +194,7 @@ ], "parameters": { "deploymentId": { - "description": "Required. The ID of the Game Server Deployment resource to be created.", + "description": "Required. The ID of the game server delpoyment resource to be created.", "location": "query", "type": "string" }, @@ -218,7 +218,7 @@ ] }, "delete": { - "description": "Deletes a single Game Server Deployment.", + "description": "Deletes a single game server deployment.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}", "httpMethod": "DELETE", "id": "gameservices.projects.locations.gameServerDeployments.delete", @@ -227,7 +227,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Deployment to delete. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", + "description": "Required. The name of the game server delpoyment to delete. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, @@ -243,7 +243,7 @@ ] }, "fetchDeploymentState": { - "description": "Retrieves information about the current state of the Game Server\nDdeployment. Gathers all the Agones fleets and Agones autoscalers,\nincluding fleets running an older version of the Game Server Deployment.", + "description": "Retrieves information about the current state of the game server\ndeployment. Gathers all the Agones fleets and Agones autoscalers,\nincluding fleets running an older version of the game server deployment.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:fetchDeploymentState", "httpMethod": "POST", "id": "gameservices.projects.locations.gameServerDeployments.fetchDeploymentState", @@ -252,7 +252,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Deployment. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", + "description": "Required. The name of the game server delpoyment. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, @@ -271,7 +271,7 @@ ] }, "get": { - "description": "Gets details of a single Game Server Deployment.", + "description": "Gets details of a single game server deployment.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}", "httpMethod": "GET", "id": "gameservices.projects.locations.gameServerDeployments.get", @@ -280,7 +280,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Deployment to retrieve. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", + "description": "Required. The name of the game server delpoyment to retrieve. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, @@ -305,7 +305,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -327,7 +327,7 @@ ] }, "getRollout": { - "description": "Gets details a single Game Server Deployment Rollout.", + "description": "Gets details a single game server deployment rollout.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout", "httpMethod": "GET", "id": "gameservices.projects.locations.gameServerDeployments.getRollout", @@ -336,7 +336,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Deployment to retrieve. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.", + "description": "Required. The name of the game server delpoyment to retrieve. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, @@ -352,7 +352,7 @@ ] }, "list": { - "description": "Lists Game Server Deployments in a given project and Location.", + "description": "Lists game server deployments in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments", "httpMethod": "GET", "id": "gameservices.projects.locations.gameServerDeployments.list", @@ -371,7 +371,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, server\nwill pick an appropriate default. Server may return fewer items than\nrequested. A caller should only rely on response's\nnext_page_token to\ndetermine if there are more GameServerDeployments left to be queried.", + "description": "Optional. The maximum number of items to return. If unspecified, the server\nwill pick an appropriate default. The server may return fewer items than\nrequested. A caller should only rely on response's\nnext_page_token to\ndetermine if there are more GameServerDeployments left to be queried.", "format": "int32", "location": "query", "type": "integer" @@ -398,7 +398,7 @@ ] }, "patch": { - "description": "Patches a Game Server Deployment.", + "description": "Patches a game server deployment.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}", "httpMethod": "PATCH", "id": "gameservices.projects.locations.gameServerDeployments.patch", @@ -407,7 +407,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Game Server Deployment. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment`.", + "description": "The resource name of the game server deployment. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, @@ -432,7 +432,7 @@ ] }, "previewRollout": { - "description": "Previews the Game Server Deployment Rollout. This API does not mutate the\nRollout resource.", + "description": "Previews the game server deployment rollout. This API does not mutate the\nrollout resource.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout:preview", "httpMethod": "PATCH", "id": "gameservices.projects.locations.gameServerDeployments.previewRollout", @@ -441,14 +441,14 @@ ], "parameters": { "name": { - "description": "The resource name of the Game Server Deployment Rollout. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.", + "description": "The resource name of the game server deployment rollout. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" }, "previewTime": { - "description": "Optional. The target timestamp to compute the preview. Defaults to the immediately\nafter the proposed Rollout completes.", + "description": "Optional. The target timestamp to compute the preview. Defaults to the immediately\nafter the proposed rollout completes.", "format": "google-datetime", "location": "query", "type": "string" @@ -528,7 +528,7 @@ ] }, "updateRollout": { - "description": "Patches a single Game Server Deployment Rollout.\nThe method will not return an error if the update does not affect any\nexisting realms. For example - if the default_game_server_config is changed\nbut all existing realms use the override, that is valid. Similarly, if a\nnon existing realm is explicitly called out in game_server_config_overrides\nfield, that will also not result in an error.", + "description": "Patches a single game server deployment rollout.\nThe method will not return an error if the update does not affect any\nexisting realms. For example - if the default_game_server_config is changed\nbut all existing realms use the override, that is valid. Similarly, if a\nnon existing realm is explicitly called out in game_server_config_overrides\nfield, that will also not result in an error.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout", "httpMethod": "PATCH", "id": "gameservices.projects.locations.gameServerDeployments.updateRollout", @@ -537,7 +537,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Game Server Deployment Rollout. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.", + "description": "The resource name of the game server deployment rollout. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, @@ -566,7 +566,7 @@ "configs": { "methods": { "create": { - "description": "Creates a new Game Server Config in a given project, Location, and Game\nServer Deployment. Game Server Configs are immutable, and are not applied\nuntil referenced in the Game Server Deployment Rollout resource.", + "description": "Creates a new game server config in a given project, location, and game\nserver deployment. Game server configs are immutable, and are not applied\nuntil referenced in the game server deployment rollout resource.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs", "httpMethod": "POST", "id": "gameservices.projects.locations.gameServerDeployments.configs.create", @@ -575,7 +575,7 @@ ], "parameters": { "configId": { - "description": "Required. The ID of the Game Server Config resource to be created.", + "description": "Required. The ID of the game server config resource to be created.", "location": "query", "type": "string" }, @@ -599,7 +599,7 @@ ] }, "delete": { - "description": "Deletes a single Game Server Config. The deletion will fail if the Game\nServer Config is referenced in a Game Server Deployment Rollout.", + "description": "Deletes a single game server config. The deletion will fail if the game\nserver config is referenced in a game server deployment rollout.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs/{configsId}", "httpMethod": "DELETE", "id": "gameservices.projects.locations.gameServerDeployments.configs.delete", @@ -608,7 +608,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Config to delete. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.", + "description": "Required. The name of the game server config to delete. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+/configs/[^/]+$", "required": true, @@ -624,7 +624,7 @@ ] }, "get": { - "description": "Gets details of a single Game Server Config.", + "description": "Gets details of a single game server config.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs/{configsId}", "httpMethod": "GET", "id": "gameservices.projects.locations.gameServerDeployments.configs.get", @@ -633,7 +633,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Config to retrieve. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.", + "description": "Required. The name of the game server config to retrieve. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+/configs/[^/]+$", "required": true, @@ -649,7 +649,7 @@ ] }, "list": { - "description": "Lists Game Server Configs in a given project, Location, and Game Server\nDeployment.", + "description": "Lists game server configs in a given project, location, and game server\ndeployment.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs", "httpMethod": "GET", "id": "gameservices.projects.locations.gameServerDeployments.configs.list", @@ -674,7 +674,7 @@ "type": "integer" }, "pageToken": { - "description": "Optional. The next_page_token value returned from a previous List request, if any.", + "description": "Optional. The next_page_token value returned from a previous list request, if any.", "location": "query", "type": "string" }, @@ -824,7 +824,7 @@ "realms": { "methods": { "create": { - "description": "Creates a new Realm in a given project and Location.", + "description": "Creates a new realm in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/realms", "httpMethod": "POST", "id": "gameservices.projects.locations.realms.create", @@ -840,7 +840,7 @@ "type": "string" }, "realmId": { - "description": "Required. The ID of the Realm resource to be created.", + "description": "Required. The ID of the realm resource to be created.", "location": "query", "type": "string" } @@ -857,7 +857,7 @@ ] }, "delete": { - "description": "Deletes a single Realm.", + "description": "Deletes a single realm.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "httpMethod": "DELETE", "id": "gameservices.projects.locations.realms.delete", @@ -866,7 +866,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Realm to delete. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`.", + "description": "Required. The name of the realm to delete. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, @@ -882,7 +882,7 @@ ] }, "get": { - "description": "Gets details of a single Realm.", + "description": "Gets details of a single realm.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "httpMethod": "GET", "id": "gameservices.projects.locations.realms.get", @@ -891,7 +891,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Realm to retrieve. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`.", + "description": "Required. The name of the realm to retrieve. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, @@ -907,7 +907,7 @@ ] }, "list": { - "description": "Lists Realms in a given project and Location.", + "description": "Lists realms in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/realms", "httpMethod": "GET", "id": "gameservices.projects.locations.realms.list", @@ -926,7 +926,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, server\nwill pick an appropriate default. Server may return fewer items than\nrequested. A caller should only rely on response's\nnext_page_token to\ndetermine if there are more Realms left to be queried.", + "description": "Optional. The maximum number of items to return. If unspecified, server\nwill pick an appropriate default. Server may return fewer items than\nrequested. A caller should only rely on response's\nnext_page_token to\ndetermine if there are more realms left to be queried.", "format": "int32", "location": "query", "type": "integer" @@ -953,7 +953,7 @@ ] }, "patch": { - "description": "Patches a single Realm.", + "description": "Patches a single realm.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "httpMethod": "PATCH", "id": "gameservices.projects.locations.realms.patch", @@ -962,7 +962,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Realm. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`. For\nexample, `projects/my-project/locations/{location}/realms/my-realm`.", + "description": "The resource name of the realm. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`. For\nexample, `projects/my-project/locations/{location}/realms/my-realm`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, @@ -987,7 +987,7 @@ ] }, "previewUpdate": { - "description": "Previews patches to a single Realm.", + "description": "Previews patches to a single realm.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}:previewUpdate", "httpMethod": "PATCH", "id": "gameservices.projects.locations.realms.previewUpdate", @@ -996,7 +996,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Realm. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`. For\nexample, `projects/my-project/locations/{location}/realms/my-realm`.", + "description": "The resource name of the realm. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`. For\nexample, `projects/my-project/locations/{location}/realms/my-realm`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, @@ -1040,7 +1040,7 @@ ], "parameters": { "gameServerClusterId": { - "description": "Required. The ID of the Game Server Cluster resource to be created.", + "description": "Required. The ID of the game server cluster resource to be created.", "location": "query", "type": "string" }, @@ -1073,7 +1073,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Cluster to delete. Uses the form:\n`projects/{project}/locations/{location}/gameServerClusters/{cluster}`.", + "description": "Required. The name of the game server cluster to delete. Uses the form:\n`projects/{project}/locations/{location}/gameServerClusters/{cluster}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, @@ -1098,7 +1098,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Cluster to retrieve. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`.", + "description": "Required. The name of the game server cluster to retrieve. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, @@ -1114,7 +1114,7 @@ ] }, "list": { - "description": "Lists Game Server Clusters in a given project and location.", + "description": "Lists game server clusters in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters", "httpMethod": "GET", "id": "gameservices.projects.locations.realms.gameServerClusters.list", @@ -1133,7 +1133,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, server\nwill pick an appropriate default. Server may return fewer items than\nrequested. A caller should only rely on response's\nnext_page_token to\ndetermine if there are more GameServerClusters left to be queried.", + "description": "Optional. The maximum number of items to return. If unspecified, the server\nwill pick an appropriate default. The server may return fewer items than\nrequested. A caller should only rely on response's\nnext_page_token to\ndetermine if there are more GameServerClusters left to be queried.", "format": "int32", "location": "query", "type": "integer" @@ -1169,7 +1169,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Game Server Cluster. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.\nFor example,\n\n`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", + "description": "Required. The resource name of the game server cluster. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.\nFor example,\n\n`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, @@ -1203,7 +1203,7 @@ ], "parameters": { "gameServerClusterId": { - "description": "Required. The ID of the Game Server Cluster resource to be created.", + "description": "Required. The ID of the game server cluster resource to be created.", "location": "query", "type": "string" }, @@ -1242,7 +1242,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Game Server Cluster to delete. Uses the form:\n`projects/{project}/locations/{location}/gameServerClusters/{cluster}`.", + "description": "Required. The name of the game server cluster to delete. Uses the form:\n`projects/{project}/locations/{location}/gameServerClusters/{cluster}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, @@ -1273,7 +1273,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Game Server Cluster. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.\nFor example,\n\n`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", + "description": "Required. The resource name of the game server cluster. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.\nFor example,\n\n`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, @@ -1312,7 +1312,7 @@ } } }, - "revision": "20200423", + "revision": "20200507", "rootUrl": "https://gameservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -1403,7 +1403,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1584,7 +1584,7 @@ "type": "object" }, "DeployedClusterState": { - "description": "The Game Server Cluster changes made by the Game Server Deployment.", + "description": "The game server cluster changes made by the game server deployment.", "id": "DeployedClusterState", "properties": { "cluster": { @@ -1592,7 +1592,7 @@ "type": "string" }, "fleetDetails": { - "description": "The details about the Agones fleets and autoscalers created in the\nGame Server Cluster.", + "description": "The details about the Agones fleets and autoscalers created in the\ngame server cluster.", "items": { "$ref": "DeployedFleetDetails" }, @@ -1725,14 +1725,14 @@ "id": "FetchDeploymentStateResponse", "properties": { "clusterState": { - "description": "The state of the Game Server Deployment in each Game Server Cluster.", + "description": "The state of the game server deployment in each game server cluster.", "items": { "$ref": "DeployedClusterState" }, "type": "array" }, "unavailable": { - "description": "List of Locations that could not be reached.", + "description": "List of locations that could not be reached.", "items": { "type": "string" }, @@ -1757,12 +1757,12 @@ "type": "object" }, "GameServerCluster": { - "description": "A Game Server Cluster resource.", + "description": "A game server cluster resource.", "id": "GameServerCluster", "properties": { "connectionInfo": { "$ref": "GameServerClusterConnectionInfo", - "description": "Game Server Cluster connection information. This information is used to\nmanage Game Server Clusters." + "description": "The game server cluster connection information. This information is used to\nmanage game server clusters." }, "createTime": { "description": "Output only. The creation time.", @@ -1781,11 +1781,11 @@ "additionalProperties": { "type": "string" }, - "description": "The labels associated with this Game Server Cluster. Each label is a\nkey-value pair.", + "description": "The labels associated with this game server cluster. Each label is a\nkey-value pair.", "type": "object" }, "name": { - "description": "Required. The resource name of the Game Server Cluster. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.\nFor example,\n\n`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", + "description": "Required. The resource name of the game server cluster. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.\nFor example,\n\n`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", "type": "string" }, "updateTime": { @@ -1797,7 +1797,7 @@ "type": "object" }, "GameServerClusterConnectionInfo": { - "description": "The Game Server Cluster connection information.", + "description": "The game server cluster connection information.", "id": "GameServerClusterConnectionInfo", "properties": { "gkeClusterReference": { @@ -1805,14 +1805,14 @@ "description": "Reference to the GKE cluster where the game servers are installed." }, "namespace": { - "description": "Namespace designated on the Game Server Cluster where the Agones game\nserver instances will be created. Existence of the namespace will be\nvalidated during creation.", + "description": "Namespace designated on the game server cluster where the Agones game\nserver instances will be created. Existence of the namespace will be\nvalidated during creation.", "type": "string" } }, "type": "object" }, "GameServerConfig": { - "description": "A Game Server Config resource.", + "description": "A game server config resource.", "id": "GameServerConfig", "properties": { "createTime": { @@ -1821,7 +1821,7 @@ "type": "string" }, "description": { - "description": "The description of the Game Server Config.", + "description": "The description of the game server config.", "type": "string" }, "fleetConfigs": { @@ -1835,11 +1835,11 @@ "additionalProperties": { "type": "string" }, - "description": "The labels associated with this Game Server Config. Each label is a\nkey-value pair.", + "description": "The labels associated with this game server config. Each label is a\nkey-value pair.", "type": "object" }, "name": { - "description": "The resource name of the Game Server Config. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.\nFor example,\n\n`projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.", + "description": "The resource name of the game server config. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.\nFor example,\n\n`projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.", "type": "string" }, "scalingConfigs": { @@ -1858,7 +1858,7 @@ "type": "object" }, "GameServerConfigOverride": { - "description": "A Game Server Config override.", + "description": "A game server config override.", "id": "GameServerConfigOverride", "properties": { "configVersion": { @@ -1873,7 +1873,7 @@ "type": "object" }, "GameServerDeployment": { - "description": "A Game Server Deployment resource.", + "description": "A game server deployment resource.", "id": "GameServerDeployment", "properties": { "createTime": { @@ -1882,7 +1882,7 @@ "type": "string" }, "description": { - "description": "Human readable description of the Game Server Deployment.", + "description": "Human readable description of the game server delpoyment.", "type": "string" }, "etag": { @@ -1893,11 +1893,11 @@ "additionalProperties": { "type": "string" }, - "description": "The labels associated with this Game Server Deployment. Each label is a\nkey-value pair.", + "description": "The labels associated with this game server deployment. Each label is a\nkey-value pair.", "type": "object" }, "name": { - "description": "The resource name of the Game Server Deployment. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment`.", + "description": "The resource name of the game server deployment. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment`.", "type": "string" }, "updateTime": { @@ -1909,7 +1909,7 @@ "type": "object" }, "GameServerDeploymentRollout": { - "description": "The Game Server Deployment Rollout which represents the desired rollout\nstate.", + "description": "The game server deployment rollout which represents the desired rollout\nstate.", "id": "GameServerDeploymentRollout", "properties": { "createTime": { @@ -1918,7 +1918,7 @@ "type": "string" }, "defaultGameServerConfig": { - "description": "The default Game Server Config is applied to all Realms unless overridden\nin the Rollout. For example,\n\n`projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.", + "description": "The default game server config is applied to all realms unless overridden\nin the rollout. For example,\n\n`projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.", "type": "string" }, "etag": { @@ -1926,14 +1926,14 @@ "type": "string" }, "gameServerConfigOverrides": { - "description": "Contains the Game Server Config Rollout overrides. Overrides are processed\nin the order they are listed. Once a match is found for a Realm, the rest\nof the list is not processed.", + "description": "Contains the game server config rollout overrides. Overrides are processed\nin the order they are listed. Once a match is found for a realm, the rest\nof the list is not processed.", "items": { "$ref": "GameServerConfigOverride" }, "type": "array" }, "name": { - "description": "The resource name of the Game Server Deployment Rollout. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.", + "description": "The resource name of the game server deployment rollout. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.\nFor example,\n\n`projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.", "type": "string" }, "updateTime": { @@ -1974,7 +1974,7 @@ "id": "ListGameServerClustersResponse", "properties": { "gameServerClusters": { - "description": "The list of Game Server Clusters.", + "description": "The list of game server clusters.", "items": { "$ref": "GameServerCluster" }, @@ -1985,7 +1985,7 @@ "type": "string" }, "unreachable": { - "description": "List of Locations that could not be reached.", + "description": "List of locations that could not be reached.", "items": { "type": "string" }, @@ -1999,7 +1999,7 @@ "id": "ListGameServerConfigsResponse", "properties": { "gameServerConfigs": { - "description": "The list of Game Server Configs.", + "description": "The list of game server configs.", "items": { "$ref": "GameServerConfig" }, @@ -2010,7 +2010,7 @@ "type": "string" }, "unreachable": { - "description": "List of Locations that could not be reached.", + "description": "List of locations that could not be reached.", "items": { "type": "string" }, @@ -2024,7 +2024,7 @@ "id": "ListGameServerDeploymentsResponse", "properties": { "gameServerDeployments": { - "description": "The list of Game Server Delpoyments.", + "description": "The list of game server deployments.", "items": { "$ref": "GameServerDeployment" }, @@ -2035,7 +2035,7 @@ "type": "string" }, "unreachable": { - "description": "List of Locations that could not be reached.", + "description": "List of locations that could not be reached.", "items": { "type": "string" }, @@ -2089,14 +2089,14 @@ "type": "string" }, "realms": { - "description": "The list of Realms.", + "description": "The list of realms.", "items": { "$ref": "Realm" }, "type": "array" }, "unreachable": { - "description": "List of Locations that could not be reached.", + "description": "List of locations that could not be reached.", "items": { "type": "string" }, @@ -2215,7 +2215,7 @@ "additionalProperties": { "$ref": "OperationStatus" }, - "description": "Output only. Operation status for gameservices API operations. Operation status is in\nthe form of key-value pairs where keys are resource IDs and the values show\nthe status of the operation. In case of failures, the value includes an\nerror code and error message.", + "description": "Output only. Operation status for Game Services API operations. Operation status is in\nthe form of key-value pairs where keys are resource IDs and the values show\nthe status of the operation. In case of failures, the value includes an\nerror code and error message.", "type": "object" }, "requestedCancellation": { @@ -2275,7 +2275,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -2308,7 +2308,7 @@ "type": "array" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -2350,7 +2350,7 @@ "id": "PreviewGameServerDeploymentRolloutResponse", "properties": { "etag": { - "description": "ETag of the Game Server Deployment.", + "description": "ETag of the game server deployment.", "type": "string" }, "targetState": { @@ -2398,7 +2398,7 @@ "type": "object" }, "Realm": { - "description": "A Realm resource.", + "description": "A realm resource.", "id": "Realm", "properties": { "createTime": { @@ -2407,7 +2407,7 @@ "type": "string" }, "description": { - "description": "Human readable description of the Realm.", + "description": "Human readable description of the realm.", "type": "string" }, "etag": { @@ -2418,15 +2418,15 @@ "additionalProperties": { "type": "string" }, - "description": "The labels associated with this Realm. Each label is a key-value pair.", + "description": "The labels associated with this realm. Each label is a key-value pair.", "type": "object" }, "name": { - "description": "The resource name of the Realm. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`. For\nexample, `projects/my-project/locations/{location}/realms/my-realm`.", + "description": "The resource name of the realm. Uses the form:\n`projects/{project}/locations/{location}/realms/{realm}`. For\nexample, `projects/my-project/locations/{location}/realms/my-realm`.", "type": "string" }, "timeZone": { - "description": "Required. Time zone where all policies targeting this Realm are evaluated. The value\nof this field must be from the IANA time zone database:\nhttps://www.iana.org/time-zones.", + "description": "Required. Time zone where all policies targeting this realm are evaluated. The value\nof this field must be from the IANA time zone database:\nhttps://www.iana.org/time-zones.", "type": "string" }, "updateTime": { @@ -2438,11 +2438,11 @@ "type": "object" }, "RealmSelector": { - "description": "The Realm selector, used to match Realm resources.", + "description": "The realm selector, used to match realm resources.", "id": "RealmSelector", "properties": { "realms": { - "description": "List of Realms to match.", + "description": "List of realms to match.", "items": { "type": "string" }, @@ -2537,7 +2537,7 @@ "type": "array" }, "selectors": { - "description": "Labels used to identify the Game Server Clusters to which this Agones\nscaling config applies. A Game Server Cluster is subject to this Agones\nscaling config if its labels match any of the selector entries.", + "description": "Labels used to identify the game server clusters to which this Agones\nscaling config applies. A game server cluster is subject to this Agones\nscaling config if its labels match any of the selector entries.", "items": { "$ref": "LabelSelector" }, @@ -2556,7 +2556,7 @@ "type": "string" }, "cronSpec": { - "description": "The cron definition of the scheduled event. See\nhttps://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as\ndefined by the Realm.", + "description": "The cron definition of the scheduled event. See\nhttps://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as\ndefined by the realm.", "type": "string" }, "endTime": { @@ -2593,7 +2593,7 @@ "id": "SpecSource", "properties": { "gameServerConfigName": { - "description": "The Game Server Config resource. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.", + "description": "The game server config resource. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.", "type": "string" }, "name": { @@ -2635,18 +2635,18 @@ "id": "TargetDetails", "properties": { "fleetDetails": { - "description": "Agones fleet details for Game Server Clusters and Game Server Deployments.", + "description": "Agones fleet details for game server clusters and game server deployments.", "items": { "$ref": "TargetFleetDetails" }, "type": "array" }, "gameServerClusterName": { - "description": "The Game Server Cluster name. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.", + "description": "The game server cluster name. Uses the form:\n\n`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.", "type": "string" }, "gameServerDeploymentName": { - "description": "The Game Server Deployment name. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.", + "description": "The game server deployment name. Uses the form:\n\n`projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.", "type": "string" } }, diff --git a/discovery/genomics-v1.json b/discovery/genomics-v1.json index ea094e4c90c..4cc28746d59 100644 --- a/discovery/genomics-v1.json +++ b/discovery/genomics-v1.json @@ -209,7 +209,7 @@ } } }, - "revision": "20200414", + "revision": "20200507", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/genomics-v1alpha2.json b/discovery/genomics-v1alpha2.json index e36d1cf854c..2e1a29f4b79 100644 --- a/discovery/genomics-v1alpha2.json +++ b/discovery/genomics-v1alpha2.json @@ -389,7 +389,7 @@ } } }, - "revision": "20200414", + "revision": "20200507", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/genomics-v2alpha1.json b/discovery/genomics-v2alpha1.json index 8004eddb1ba..5c8d5dc2b5a 100644 --- a/discovery/genomics-v2alpha1.json +++ b/discovery/genomics-v2alpha1.json @@ -301,7 +301,7 @@ } } }, - "revision": "20200414", + "revision": "20200507", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "Accelerator": { diff --git a/discovery/gmail-v1.json b/discovery/gmail-v1.json index 815e9d5506b..6deb9cd8d28 100644 --- a/discovery/gmail-v1.json +++ b/discovery/gmail-v1.json @@ -53,7 +53,7 @@ "description": "Access Gmail mailboxes including sending user email.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/gmail/api/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/g3bzeMMQiCUwx2f62jBl-yFDoB8\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/wuvO3debMRRbS1xgERSPmyvlCL4\"", "icons": { "x16": "https://www.google.com/images/icons/product/googlemail-16.png", "x32": "https://www.google.com/images/icons/product/googlemail-32.png" @@ -2578,7 +2578,7 @@ } } }, - "revision": "20200203", + "revision": "20200504", "rootUrl": "https://www.googleapis.com/", "schemas": { "AutoForwarding": { diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 6f8cf953236..10a88d2fc1b 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -145,7 +145,7 @@ ] }, "deidentify": { - "description": "Creates a new dataset containing de-identified data from the source\ndataset. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifySummary.\nIf errors occur, error is set.\nThe LRO result may still be successful if de-identification fails for some\nDICOM instances. The new de-identified dataset will not contain these\nfailed resources. Failed resource totals are tracked in\nOperation.metadata.\nError details are also logged to Stackdriver Logging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging).", + "description": "Creates a new dataset containing de-identified data from the source\ndataset. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifySummary.\nIf errors occur, error is set.\nThe LRO result may still be successful if de-identification fails for some\nDICOM instances. The new de-identified dataset will not contain these\nfailed resources. Failed resource totals are tracked in\nOperation.metadata.\nError details are also logged to Cloud Logging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/logging).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:deidentify", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.deidentify", @@ -232,7 +232,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -324,7 +324,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.setIamPolicy", @@ -352,7 +352,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.testIamPermissions", @@ -417,7 +417,7 @@ ] }, "deidentify": { - "description": "De-identifies data from the source store and writes it to the destination\nstore. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifyDicomStoreSummary. If errors occur,\nerror is set.\nThe LRO result may still be successful if de-identification fails for some\nDICOM instances. The output DICOM store will not contain\nthese failed resources. Failed resource totals are tracked in\nOperation.metadata.\nError details are also logged to Stackdriver\n(see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)).", + "description": "De-identifies data from the source store and writes it to the destination\nstore. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifyDicomStoreSummary. If errors occur,\nerror is set.\nThe LRO result may still be successful if de-identification fails for some\nDICOM instances. The output DICOM store will not contain\nthese failed resources. Failed resource totals are tracked in\nOperation.metadata.\nError details are also logged to Cloud Logging\n(see [Viewing logs](/healthcare/docs/how-tos/logging)).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:deidentify", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.deidentify", @@ -470,7 +470,7 @@ ] }, "export": { - "description": "Exports data to the specified destination by copying it from the DICOM\nstore.\nErrors are also logged to Stackdriver Logging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging).\nThe metadata field type is\nOperationMetadata.", + "description": "Exports data to the specified destination by copying it from the DICOM\nstore.\nErrors are also logged to Cloud Logging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/logging).\nThe metadata field type is\nOperationMetadata.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:export", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.export", @@ -532,7 +532,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -554,7 +554,7 @@ ] }, "import": { - "description": "Imports data into the DICOM store by copying it from the specified source.\nErrors are logged to Stackdriver Logging. For more information, see\n[Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The\nmetadata field type is\nOperationMetadata.", + "description": "Imports data into the DICOM store by copying it from the specified source.\nErrors are logged to Cloud Logging. For more information, see\n[Viewing logs](/healthcare/docs/how-tos/logging). The\nmetadata field type is\nOperationMetadata.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:import", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.import", @@ -756,7 +756,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.setIamPolicy", @@ -820,7 +820,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.testIamPermissions", @@ -1439,7 +1439,7 @@ ] }, "deidentify": { - "description": "De-identifies data from the source store and writes it to the destination\nstore. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifyFhirStoreSummary. If errors occur,\nerror is set.\nError details are also logged to Stackdriver\n(see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)).", + "description": "De-identifies data from the source store and writes it to the destination\nstore. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifyFhirStoreSummary. If errors occur,\nerror is set.\nError details are also logged to Cloud Logging\n(see [Viewing logs](/healthcare/docs/how-tos/logging)).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:deidentify", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.deidentify", @@ -1492,7 +1492,7 @@ ] }, "export": { - "description": "Export resources from the FHIR store to the specified destination.\n\nThis method returns an Operation that can\nbe used to track the status of the export by calling\nGetOperation.\n\nImmediate fatal errors appear in the\nerror field, errors are also logged\nto Stackdriver (see [Viewing\nlogs](/healthcare/docs/how-tos/stackdriver-logging)).\nOtherwise, when the operation finishes, a detailed response of type\nExportResourcesResponse is returned in the\nresponse field.\nThe metadata field type for this\noperation is OperationMetadata.", + "description": "Export resources from the FHIR store to the specified destination.\n\nThis method returns an Operation that can\nbe used to track the status of the export by calling\nGetOperation.\n\nImmediate fatal errors appear in the\nerror field, errors are also logged\nto Cloud Logging (see [Viewing\nlogs](/healthcare/docs/how-tos/logging)).\nOtherwise, when the operation finishes, a detailed response of type\nExportResourcesResponse is returned in the\nresponse field.\nThe metadata field type for this\noperation is OperationMetadata.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.export", @@ -1554,7 +1554,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -1576,7 +1576,7 @@ ] }, "import": { - "description": "Import resources to the FHIR store by loading data from the specified\nsources. This method is optimized to load large quantities of data using\nimport semantics that ignore some FHIR store configuration options and are\nnot suitable for all use cases. It is primarily intended to load data into\nan empty FHIR store that is not being used by other clients. In cases\nwhere this method is not appropriate, consider using ExecuteBundle to\nload data.\n\nEvery resource in the input must contain a client-supplied ID, and will be\nstored using that ID regardless of the\nenable_update_create setting on the FHIR\nstore.\n\nThe import process does not enforce referential integrity, regardless of\nthe\ndisable_referential_integrity\nsetting on the FHIR store. This allows the import of resources with\narbitrary interdependencies without considering grouping or ordering, but\nif the input data contains invalid references or if some resources fail to\nbe imported, the FHIR store might be left in a state that violates\nreferential integrity.\n\nThe import process does not trigger PubSub notification or BigQuery\nstreaming update, regardless of how those are configured on the FHIR store.\n\nIf a resource with the specified ID already exists, the most recent\nversion of the resource is overwritten without creating a new historical\nversion, regardless of the\ndisable_resource_versioning\nsetting on the FHIR store. If transient failures occur during the import,\nit is possible that successfully imported resources will be overwritten\nmore than once.\n\nThe import operation is idempotent unless the input data contains multiple\nvalid resources with the same ID but different contents. In that case,\nafter the import completes, the store will contain exactly one resource\nwith that ID but there is no ordering guarantee on which version of the\ncontents it will have. The operation result counters do not count\nduplicate IDs as an error and will count one success for each resource in\nthe input, which might result in a success count larger than the number\nof resources in the FHIR store. This often occurs when importing data\norganized in bundles produced by Patient-everything\nwhere each bundle contains its own copy of a resource such as Practitioner\nthat might be referred to by many patients.\n\nIf some resources fail to import, for example due to parsing errors,\nsuccessfully imported resources are not rolled back.\n\nThe location and format of the input data is specified by the parameters\nbelow. Note that if no format is specified, this method assumes the\n`BUNDLE` format. When using the `BUNDLE` format this method ignores the\n`Bundle.type` field, except that `history` bundles are rejected, and does\nnot apply any of the bundle processing semantics for batch or transaction\nbundles. Unlike in ExecuteBundle, transaction bundles are not executed\nas a single transaction and bundle-internal references are not rewritten.\nThe bundle is treated as a collection of resources to be written as\nprovided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As\nan example, this allows the import of `searchset` bundles produced by a\nFHIR search or\nPatient-everything operation.\n\nThis method returns an Operation that can\nbe used to track the status of the import by calling\nGetOperation.\n\nImmediate fatal errors appear in the\nerror field, errors are also logged\nto Stackdriver (see [Viewing\nlogs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the\noperation finishes, a detailed response of type ImportResourcesResponse\nis returned in the response field.\nThe metadata field type for this\noperation is OperationMetadata.", + "description": "Import resources to the FHIR store by loading data from the specified\nsources. This method is optimized to load large quantities of data using\nimport semantics that ignore some FHIR store configuration options and are\nnot suitable for all use cases. It is primarily intended to load data into\nan empty FHIR store that is not being used by other clients. In cases\nwhere this method is not appropriate, consider using ExecuteBundle to\nload data.\n\nEvery resource in the input must contain a client-supplied ID, and will be\nstored using that ID regardless of the\nenable_update_create setting on the FHIR\nstore.\n\nThe import process does not enforce referential integrity, regardless of\nthe\ndisable_referential_integrity\nsetting on the FHIR store. This allows the import of resources with\narbitrary interdependencies without considering grouping or ordering, but\nif the input data contains invalid references or if some resources fail to\nbe imported, the FHIR store might be left in a state that violates\nreferential integrity.\n\nThe import process does not trigger Pub/Sub notification or BigQuery\nstreaming update, regardless of how those are configured on the FHIR store.\n\nIf a resource with the specified ID already exists, the most recent\nversion of the resource is overwritten without creating a new historical\nversion, regardless of the\ndisable_resource_versioning\nsetting on the FHIR store. If transient failures occur during the import,\nit is possible that successfully imported resources will be overwritten\nmore than once.\n\nThe import operation is idempotent unless the input data contains multiple\nvalid resources with the same ID but different contents. In that case,\nafter the import completes, the store will contain exactly one resource\nwith that ID but there is no ordering guarantee on which version of the\ncontents it will have. The operation result counters do not count\nduplicate IDs as an error and will count one success for each resource in\nthe input, which might result in a success count larger than the number\nof resources in the FHIR store. This often occurs when importing data\norganized in bundles produced by Patient-everything\nwhere each bundle contains its own copy of a resource such as Practitioner\nthat might be referred to by many patients.\n\nIf some resources fail to import, for example due to parsing errors,\nsuccessfully imported resources are not rolled back.\n\nThe location and format of the input data is specified by the parameters\nbelow. Note that if no format is specified, this method assumes the\n`BUNDLE` format. When using the `BUNDLE` format this method ignores the\n`Bundle.type` field, except that `history` bundles are rejected, and does\nnot apply any of the bundle processing semantics for batch or transaction\nbundles. Unlike in ExecuteBundle, transaction bundles are not executed\nas a single transaction and bundle-internal references are not rewritten.\nThe bundle is treated as a collection of resources to be written as\nprovided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As\nan example, this allows the import of `searchset` bundles produced by a\nFHIR search or\nPatient-everything operation.\n\nThis method returns an Operation that can\nbe used to track the status of the import by calling\nGetOperation.\n\nImmediate fatal errors appear in the\nerror field, errors are also logged\nto Cloud Logging (see [Viewing\nlogs](/healthcare/docs/how-tos/logging)). Otherwise, when the\noperation finishes, a detailed response of type ImportResourcesResponse\nis returned in the response field.\nThe metadata field type for this\noperation is OperationMetadata.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:import", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.import", @@ -1678,38 +1678,8 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "search": { - "description": "Searches for resources in the given FHIR store according to criteria\nspecified as query parameters.\n\nImplements the FHIR standard search interaction\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#search))\nusing the search semantics described in the FHIR Search specification\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/search.html),\n[R4](http://hl7.org/implement/standards/fhir/R4/search.html)).\n\nSupports three methods of search defined by the specification:\n\n* `GET [base]?[parameters]` to search across all resources.\n* `GET [base]/[type]?[parameters]` to search resources of a specified\ntype.\n* `POST [base]/[type]/_search?[parameters]` as an alternate form having\nthe same semantics as the `GET` method.\n\nThe `GET` methods do not support compartment searches. The `POST` method\ndoes not support `application/x-www-form-urlencoded` search parameters.\n\nOn success, the response body will contain a JSON-encoded representation\nof a `Bundle` resource of type `searchset`, containing the results of the\nsearch.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.\n\nThe server's capability statement, retrieved through\ncapabilities, indicates what search parameters\nare supported on each FHIR resource. A list of all search parameters\ndefined by the specification can be found in the FHIR Search Parameter\nRegistry\n([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html),\n[R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)).\nFHIR search parameters for DSTU2 can be found on each resource's definition\npage.\n\nSupported search modifiers: `:missing`, `:exact`, `:contains`, `:text`,\n`:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`.\n\nSupported search result parameters: `_sort`, `_count`, `_include`,\n`_revinclude`, `_summary=text`, `_summary=data`, and `_elements`.\n\nThe maximum number of search results returned defaults to 100, which can\nbe overridden by the `_count` parameter up to a maximum limit of 1000. If\nthere are additional results, the returned `Bundle` will contain\npagination links.\n\nResources with a total size larger than 5MB or a field count larger than\n50,000 might not be fully searchable as the server might trim its generated\nsearch index in those cases.\n\nNote: FHIR resources are indexed asynchronously, so there might be a slight\ndelay between the time a resource is created or changes and when the change\nis reflected in search results.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", - "httpMethod": "GET", - "id": "healthcare.projects.locations.datasets.fhirStores.search", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Name of the FHIR store to retrieve resources from.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", - "required": true, - "type": "string" - }, - "resourceType": { - "description": "The FHIR resource type to search, such as Patient or Observation. For a\ncomplete list, see the FHIR Resource Index\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html),\n[R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/fhir", - "response": { - "$ref": "HttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.setIamPolicy", @@ -1737,7 +1707,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.testIamPermissions", @@ -1769,7 +1739,7 @@ "fhir": { "methods": { "Patient-everything": { - "description": "Retrieves all the resources directly referenced by a patient, as well as\nall of the resources in the patient compartment.\n\nImplements the FHIR extended operation Patient-everything\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything),\n[R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)).\n\nOn success, the response body will contain a JSON-encoded representation\nof a `Bundle` resource of type `searchset`, containing the results of the\noperation.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.", + "description": "Retrieves a Patient resource and resources related to that patient.\n\nImplements the FHIR extended operation Patient-everything\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything),\n[R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)).\n\nOn success, the response body will contain a JSON-encoded representation\nof a `Bundle` resource of type `searchset`, containing the results of the\noperation.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.\n\nThe resources in scope for the response are:\n\n* The patient resource itself.\n* All the resources directly referenced by the patient resource.\n* Resources directly referencing the patient resource that meet the\n inclusion criteria. The inclusion criteria are based on the membership\n rules in the patient compartment definition\n ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html),\n [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html),\n [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which\n details the eligible resource types and referencing search parameters.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything", @@ -2232,7 +2202,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -2329,7 +2299,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy", @@ -2357,7 +2327,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions", @@ -2707,7 +2677,7 @@ } } }, - "revision": "20200424", + "revision": "20200501", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AuditConfig": { @@ -2764,7 +2734,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -3285,7 +3255,7 @@ "type": "string" }, "pubsubTopic": { - "description": "The [Cloud Pubsub](https://cloud.google.com/pubsub/docs/) topic that\nnotifications of changes are published on. Supplied by the client. The\nnotification is a `PubsubMessage` with the following fields:\n\n* `PubsubMessage.Data` contains the resource name.\n* `PubsubMessage.MessageId` is the ID of this notification. It is\nguaranteed to be unique within the topic.\n* `PubsubMessage.PublishTime` is the time at which the message was\npublished.\n\nNote that notifications are only sent if the topic is non-empty. [Topic\nnames](https://cloud.google.com/pubsub/docs/overview#names) must be\nscoped to a project. cloud-healthcare@system.gserviceaccount.com must\nhave publisher permissions on the given Pubsub topic. Not having adequate\npermissions causes the calls that send notifications to fail.\n\nIf a notification cannot be published to Cloud Pub/Sub, errors will be\nlogged to Stackdriver (see [Viewing logs](/healthcare/docs/how-\ntos/stackdriver-logging)).", + "description": "The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that\nnotifications of changes are published on. Supplied by the client. The\nnotification is a `PubsubMessage` with the following fields:\n\n* `PubsubMessage.Data` contains the resource name.\n* `PubsubMessage.MessageId` is the ID of this notification. It is\nguaranteed to be unique within the topic.\n* `PubsubMessage.PublishTime` is the time at which the message was\npublished.\n\nNote that notifications are only sent if the topic is non-empty. [Topic\nnames](https://cloud.google.com/pubsub/docs/overview#names) must be\nscoped to a project. Cloud Healthcare API service account must have\npublisher permissions on the given Pub/Sub topic. Not having adequate\npermissions causes the calls that send notifications to fail.\n\nIf a notification cannot be published to Cloud Pub/Sub, errors will be\nlogged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-\ntos/logging)).", "type": "string" } }, @@ -3652,7 +3622,7 @@ "id": "NotificationConfig", "properties": { "pubsubTopic": { - "description": "The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that\nnotifications of changes are published on. Supplied by the client.\nPubsubMessage.Data contains the resource name.\nPubsubMessage.MessageId is the ID of this message. It is guaranteed to be\nunique within the topic.\nPubsubMessage.PublishTime is the time at which the message was published.\nNotifications are only sent if the topic is\nnon-empty. [Topic\nnames](https://cloud.google.com/pubsub/docs/overview#names) must be scoped\nto a project. cloud-healthcare@system.gserviceaccount.com must have\npublisher permissions on the given Cloud Pub/Sub topic. Not having adequate\npermissions causes the calls that send notifications to fail.\n\nIf a notification can't be published to Cloud Pub/Sub, errors are logged to\nStackdriver (see [Viewing\nlogs](/healthcare/docs/how-tos/stackdriver-logging)). If the number of\nerrors exceeds a certain rate, some aren't submitted.", + "description": "The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that\nnotifications of changes are published on. Supplied by the client.\nPubsubMessage.Data contains the resource name.\nPubsubMessage.MessageId is the ID of this message. It is guaranteed to be\nunique within the topic.\nPubsubMessage.PublishTime is the time at which the message was published.\nNotifications are only sent if the topic is\nnon-empty. [Topic\nnames](https://cloud.google.com/pubsub/docs/overview#names) must be scoped\nto a project. Cloud Healthcare API service account must have publisher\npermissions on the given Cloud Pub/Sub topic. Not having adequate\npermissions causes the calls that send notifications to fail.\n\nIf a notification can't be published to Cloud Pub/Sub, errors are logged to\nCloud Logging (see [Viewing\nlogs](/healthcare/docs/how-tos/logging)). If the number of\nerrors exceeds a certain rate, some aren't submitted.", "type": "string" } }, @@ -3719,7 +3689,7 @@ "type": "string" }, "logsUrl": { - "description": "A link to audit and error logs in the log viewer. Error logs are generated\nonly by some operations, listed at\nhttps://cloud.google.com/healthcare/docs/how-tos/stackdriver-logging.", + "description": "A link to audit and error logs in the log viewer. Error logs are generated\nonly by some operations, listed at\n[Viewing logs](/healthcare/docs/how-tos/logging).", "type": "string" } }, @@ -3770,7 +3740,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -3793,7 +3763,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -3865,7 +3835,7 @@ ], "enumDescriptions": [ "No schema type specified.", - "Analytics schema defined by the FHIR community.\nSee https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md." + "Analytics schema defined by the FHIR community.\nSee https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.\n\nBigQuery only allows a maximum of 10,000 columns per table. Due to this\nlimitation, the server will not generate schemas for fields of type\n`Resource`, which can hold any resource type. The affected fields are\n`Parameters.parameter.resource`, `Bundle.entry.resource`, and\n`Bundle.entry.response.outcome`." ], "type": "string" } @@ -3914,7 +3884,7 @@ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." }, "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } @@ -3954,7 +3924,7 @@ "properties": { "bigqueryDestination": { "$ref": "GoogleCloudHealthcareV1FhirBigQueryDestination", - "description": "The destination BigQuery structure that contains both the dataset\nlocation and corresponding schema config.\n\nThe output is organized in one table per resource type. The server\nreuses the existing tables (if any) that are named after the resource\ntypes, e.g. \"Patient\", \"Observation\". When there is no existing table\nfor a given resource type, the server attempts to create one.\n\nWhen a table schema doesn't align with the schema config, either\nbecause of existing incompatible schema or out of band incompatible\nmodification, the server does not stream in new data.\n\nBigQuery imposes a 1 MB limit on streaming insert row size, therefore\nany resource mutation that generates more than 1 MB of BigQuery data\nwill not be streamed.\n\nOne resolution in this case is to delete the incompatible\ntable and let the server recreate one, though the newly created table\nonly contains data after the table recreation.\n\nResults are appended to the corresponding BigQuery tables. Different\nversions of the same resource are distinguishable by the meta.versionId\nand meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that\nresults in the new version is recorded in the meta.tag.\n\nThe tables contain all historical resource versions since streaming was\nenabled. For query convenience, the server also creates one view per\ntable of the same name containing only the current resource version.\n\nIf a resource mutation cannot be streamed to BigQuery, errors will be\nlogged to Stackdriver (see [Viewing logs](/healthcare/docs/how-\ntos/stackdriver-logging))." + "description": "The destination BigQuery structure that contains both the dataset\nlocation and corresponding schema config.\n\nThe output is organized in one table per resource type. The server\nreuses the existing tables (if any) that are named after the resource\ntypes, e.g. \"Patient\", \"Observation\". When there is no existing table\nfor a given resource type, the server attempts to create one.\n\nWhen a table schema doesn't align with the schema config, either\nbecause of existing incompatible schema or out of band incompatible\nmodification, the server does not stream in new data.\n\nBigQuery imposes a 1 MB limit on streaming insert row size, therefore\nany resource mutation that generates more than 1 MB of BigQuery data\nwill not be streamed.\n\nOne resolution in this case is to delete the incompatible\ntable and let the server recreate one, though the newly created table\nonly contains data after the table recreation.\n\nResults are appended to the corresponding BigQuery tables. Different\nversions of the same resource are distinguishable by the meta.versionId\nand meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that\nresults in the new version is recorded in the meta.tag.\n\nThe tables contain all historical resource versions since streaming was\nenabled. For query convenience, the server also creates one view per\ntable of the same name containing only the current resource version.\n\nThe streamed data in the BigQuery dataset is not guaranteed to be\ncompletely unique. The combination of the id and meta.versionId columns\nshould ideally identify a single unique row. But in rare cases,\nduplicates may exist. At query time, users may use the SQL select\nstatement to keep only one of the duplicate rows given an id and\nmeta.versionId pair. Alternatively, the server created view mentioned\nabove also filters out duplicates.\n\nIf a resource mutation cannot be streamed to BigQuery, errors will be\nlogged to Cloud Logging (see\n[Viewing logs](/healthcare/docs/how-tos/logging))." }, "resourceTypes": { "description": "Supply a FHIR resource type (such as \"Patient\" or \"Observation\").\nSee https://www.hl7.org/fhir/valueset-resource-types.html for a list of\nall FHIR resource types.\nThe server treats an empty list as an intent to stream all the\nsupported resource types in this FHIR store.", diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 2b002289db5..3f4f7e4c739 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -213,7 +213,7 @@ ] }, "deidentify": { - "description": "Creates a new dataset containing de-identified data from the source\ndataset. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifySummary.\nIf errors occur,\nerror\ndetails field type is\nDeidentifyErrorDetails.\nThe LRO result may still be successful if de-identification fails for some\nDICOM instances. The new de-identified dataset will not contain these\nfailed resources. Failed resource totals are tracked in\nDeidentifySummary.failure_resource_count.\nError details are also logged to Stackdriver Logging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging).", + "description": "Creates a new dataset containing de-identified data from the source\ndataset. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifySummary.\nIf errors occur,\nerror\ndetails field type is\nDeidentifyErrorDetails.\nThe LRO result may still be successful if de-identification fails for some\nDICOM instances. The new de-identified dataset will not contain these\nfailed resources. Failed resource totals are tracked in\nDeidentifySummary.failure_resource_count.\nError details are also logged to Cloud Logging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/logging).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:deidentify", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.deidentify", @@ -300,7 +300,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -392,7 +392,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.setIamPolicy", @@ -420,7 +420,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.testIamPermissions", @@ -461,7 +461,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -483,7 +483,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.annotationStores.setIamPolicy", @@ -511,7 +511,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.annotationStores.testIamPermissions", @@ -576,7 +576,7 @@ ] }, "deidentify": { - "description": "De-identifies data from the source store and writes it to the destination\nstore. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifyDicomStoreSummary. If errors occur,\nerror\ndetails field type is\nDeidentifyErrorDetails.\nThe LRO result may still be successful if de-identification fails for some\nDICOM instances. The output DICOM store will not contain\nthese failed resources. Failed resource totals are tracked in\nDeidentifySummary.failure_resource_count.\nError details are also logged to Stackdriver\n(see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)).", + "description": "De-identifies data from the source store and writes it to the destination\nstore. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifyDicomStoreSummary. If errors occur,\nerror\ndetails field type is\nDeidentifyErrorDetails.\nThe LRO result may still be successful if de-identification fails for some\nDICOM instances. The output DICOM store will not contain\nthese failed resources. Failed resource totals are tracked in\nDeidentifySummary.failure_resource_count.\nError details are also logged to Cloud Logging\n(see [Viewing logs](/healthcare/docs/how-tos/logging)).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:deidentify", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.deidentify", @@ -629,7 +629,7 @@ ] }, "export": { - "description": "Exports data to the specified destination by copying it from the DICOM\nstore.\nErrors are also logged to Stackdriver Logging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging).\nThe metadata field type is\nOperationMetadata.", + "description": "Exports data to the specified destination by copying it from the DICOM\nstore.\nErrors are also logged to Cloud Logging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/logging).\nThe metadata field type is\nOperationMetadata.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:export", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.export", @@ -691,7 +691,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -713,7 +713,7 @@ ] }, "import": { - "description": "Imports data into the DICOM store by copying it from the specified source.\nFor errors, the Operation is populated with error details (in the form\nof ImportDicomDataErrorDetails in error.details), which hold\nfiner-grained error information. Errors are also logged to Stackdriver\nLogging. For more information,\nsee [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging).\nThe metadata field type is\nOperationMetadata.", + "description": "Imports data into the DICOM store by copying it from the specified source.\nFor errors, the Operation is populated with error details (in the form\nof ImportDicomDataErrorDetails in error.details), which hold\nfiner-grained error information. Errors are also logged to Cloud Logging.\nFor more information, see [Viewing logs](/healthcare/docs/how-tos/logging).\nThe metadata field type is\nOperationMetadata.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:import", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.import", @@ -915,7 +915,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.setIamPolicy", @@ -979,7 +979,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.testIamPermissions", @@ -1598,7 +1598,7 @@ ] }, "deidentify": { - "description": "De-identifies data from the source store and writes it to the destination\nstore. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifyFhirStoreSummary. If errors occur,\nerror\ndetails field type is\nDeidentifyErrorDetails.\nErrors are also logged to Stackdriver\n(see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)).", + "description": "De-identifies data from the source store and writes it to the destination\nstore. The metadata field type\nis OperationMetadata.\nIf the request is successful, the\nresponse field type is\nDeidentifyFhirStoreSummary. If errors occur,\nerror\ndetails field type is\nDeidentifyErrorDetails.\nErrors are also logged to Cloud Logging\n(see [Viewing logs](/healthcare/docs/how-tos/logging)).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:deidentify", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.deidentify", @@ -1651,7 +1651,7 @@ ] }, "export": { - "description": "Export resources from the FHIR store to the specified destination.\n\nThis method returns an Operation that can\nbe used to track the status of the export by calling\nGetOperation.\n\nImmediate fatal errors appear in the\nerror field, errors are also logged\nto Stackdriver (see [Viewing\nlogs](/healthcare/docs/how-tos/stackdriver-logging)).\nOtherwise, when the operation finishes, a detailed response of type\nExportResourcesResponse is returned in the\nresponse field.\nThe metadata field type for this\noperation is OperationMetadata.", + "description": "Export resources from the FHIR store to the specified destination.\n\nThis method returns an Operation that can\nbe used to track the status of the export by calling\nGetOperation.\n\nImmediate fatal errors appear in the\nerror field, errors are also logged\nto Cloud Logging (see [Viewing\nlogs](/healthcare/docs/how-tos/logging)).\nOtherwise, when the operation finishes, a detailed response of type\nExportResourcesResponse is returned in the\nresponse field.\nThe metadata field type for this\noperation is OperationMetadata.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.export", @@ -1713,7 +1713,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -1735,7 +1735,7 @@ ] }, "import": { - "description": "Import resources to the FHIR store by loading data from the specified\nsources. This method is optimized to load large quantities of data using\nimport semantics that ignore some FHIR store configuration options and are\nnot suitable for all use cases. It is primarily intended to load data into\nan empty FHIR store that is not being used by other clients. In cases\nwhere this method is not appropriate, consider using ExecuteBundle to\nload data.\n\nEvery resource in the input must contain a client-supplied ID, and will be\nstored using that ID regardless of the\nenable_update_create setting on the FHIR\nstore.\n\nThe import process does not enforce referential integrity, regardless of\nthe\ndisable_referential_integrity\nsetting on the FHIR store. This allows the import of resources with\narbitrary interdependencies without considering grouping or ordering, but\nif the input data contains invalid references or if some resources fail to\nbe imported, the FHIR store might be left in a state that violates\nreferential integrity.\n\nThe import process does not trigger Cloud Pub/Sub notification or BigQuery\nstreaming update, regardless of how those are configured on the FHIR store.\n\nIf a resource with the specified ID already exists, the most recent\nversion of the resource is overwritten without creating a new historical\nversion, regardless of the\ndisable_resource_versioning\nsetting on the FHIR store. If transient failures occur during the import,\nit is possible that successfully imported resources will be overwritten\nmore than once.\n\nThe import operation is idempotent unless the input data contains multiple\nvalid resources with the same ID but different contents. In that case,\nafter the import completes, the store will contain exactly one resource\nwith that ID but there is no ordering guarantee on which version of the\ncontents it will have. The operation result counters do not count\nduplicate IDs as an error and will count one success for each resource in\nthe input, which might result in a success count larger than the number\nof resources in the FHIR store. This often occurs when importing data\norganized in bundles produced by Patient-everything\nwhere each bundle contains its own copy of a resource such as Practitioner\nthat might be referred to by many patients.\n\nIf some resources fail to import, for example due to parsing errors,\nsuccessfully imported resources are not rolled back.\n\nThe location and format of the input data is specified by the parameters\nbelow. Note that if no format is specified, this method assumes the\n`BUNDLE` format. When using the `BUNDLE` format this method ignores the\n`Bundle.type` field, except that `history` bundles are rejected, and does\nnot apply any of the bundle processing semantics for batch or transaction\nbundles. Unlike in ExecuteBundle, transaction bundles are not executed\nas a single transaction and bundle-internal references are not rewritten.\nThe bundle is treated as a collection of resources to be written as\nprovided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As\nan example, this allows the import of `searchset` bundles produced by a\nFHIR search or\nPatient-everything operation.\n\nThis method returns an Operation that can\nbe used to track the status of the import by calling\nGetOperation.\n\nImmediate fatal errors appear in the\nerror field, errors are also logged\nto Stackdriver (see [Viewing\nlogs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the\noperation finishes, a detailed response of type ImportResourcesResponse\nis returned in the response field.\nThe metadata field type for this\noperation is OperationMetadata.", + "description": "Import resources to the FHIR store by loading data from the specified\nsources. This method is optimized to load large quantities of data using\nimport semantics that ignore some FHIR store configuration options and are\nnot suitable for all use cases. It is primarily intended to load data into\nan empty FHIR store that is not being used by other clients. In cases\nwhere this method is not appropriate, consider using ExecuteBundle to\nload data.\n\nEvery resource in the input must contain a client-supplied ID, and will be\nstored using that ID regardless of the\nenable_update_create setting on the FHIR\nstore.\n\nThe import process does not enforce referential integrity, regardless of\nthe\ndisable_referential_integrity\nsetting on the FHIR store. This allows the import of resources with\narbitrary interdependencies without considering grouping or ordering, but\nif the input data contains invalid references or if some resources fail to\nbe imported, the FHIR store might be left in a state that violates\nreferential integrity.\n\nThe import process does not trigger Cloud Pub/Sub notification or BigQuery\nstreaming update, regardless of how those are configured on the FHIR store.\n\nIf a resource with the specified ID already exists, the most recent\nversion of the resource is overwritten without creating a new historical\nversion, regardless of the\ndisable_resource_versioning\nsetting on the FHIR store. If transient failures occur during the import,\nit is possible that successfully imported resources will be overwritten\nmore than once.\n\nThe import operation is idempotent unless the input data contains multiple\nvalid resources with the same ID but different contents. In that case,\nafter the import completes, the store will contain exactly one resource\nwith that ID but there is no ordering guarantee on which version of the\ncontents it will have. The operation result counters do not count\nduplicate IDs as an error and will count one success for each resource in\nthe input, which might result in a success count larger than the number\nof resources in the FHIR store. This often occurs when importing data\norganized in bundles produced by Patient-everything\nwhere each bundle contains its own copy of a resource such as Practitioner\nthat might be referred to by many patients.\n\nIf some resources fail to import, for example due to parsing errors,\nsuccessfully imported resources are not rolled back.\n\nThe location and format of the input data is specified by the parameters\nbelow. Note that if no format is specified, this method assumes the\n`BUNDLE` format. When using the `BUNDLE` format this method ignores the\n`Bundle.type` field, except that `history` bundles are rejected, and does\nnot apply any of the bundle processing semantics for batch or transaction\nbundles. Unlike in ExecuteBundle, transaction bundles are not executed\nas a single transaction and bundle-internal references are not rewritten.\nThe bundle is treated as a collection of resources to be written as\nprovided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As\nan example, this allows the import of `searchset` bundles produced by a\nFHIR search or\nPatient-everything operation.\n\nThis method returns an Operation that can\nbe used to track the status of the import by calling\nGetOperation.\n\nImmediate fatal errors appear in the\nerror field, errors are also logged\nto Cloud Logging (see [Viewing\nlogs](/healthcare/docs/how-tos/logging)). Otherwise, when the\noperation finishes, a detailed response of type ImportResourcesResponse\nis returned in the response field.\nThe metadata field type for this\noperation is OperationMetadata.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:import", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.import", @@ -1837,38 +1837,8 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "search": { - "description": "Searches for resources in the given FHIR store according to criteria\nspecified as query parameters.\n\nImplements the FHIR standard search interaction\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#search))\nusing the search semantics described in the FHIR Search specification\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/search.html),\n[R4](http://hl7.org/implement/standards/fhir/R4/search.html)).\n\nSupports three methods of search defined by the specification:\n\n* `GET [base]?[parameters]` to search across all resources.\n* `GET [base]/[type]?[parameters]` to search resources of a specified\ntype.\n* `POST [base]/[type]/_search?[parameters]` as an alternate form having\nthe same semantics as the `GET` method.\n\nThe `GET` methods do not support compartment searches. The `POST` method\ndoes not support `application/x-www-form-urlencoded` search parameters.\n\nOn success, the response body will contain a JSON-encoded representation\nof a `Bundle` resource of type `searchset`, containing the results of the\nsearch.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.\n\nThe server's capability statement, retrieved through\ncapabilities, indicates what search parameters\nare supported on each FHIR resource. A list of all search parameters\ndefined by the specification can be found in the FHIR Search Parameter\nRegistry\n([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html),\n[R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)).\nFHIR search parameters for DSTU2 can be found on each resource's definition\npage.\n\nSupported search modifiers: `:missing`, `:exact`, `:contains`, `:text`,\n`:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`.\n\nSupported search result parameters: `_sort`, `_count`, `_include`,\n`_revinclude`, `_summary=text`, `_summary=data`, and `_elements`.\n\nThe maximum number of search results returned defaults to 100, which can\nbe overridden by the `_count` parameter up to a maximum limit of 1000. If\nthere are additional results, the returned `Bundle` will contain\npagination links.\n\nResources with a total size larger than 5MB or a field count larger than\n50,000 might not be fully searchable as the server might trim its generated\nsearch index in those cases.\n\nNote: FHIR resources are indexed asynchronously, so there might be a slight\ndelay between the time a resource is created or changes and when the change\nis reflected in search results.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", - "httpMethod": "GET", - "id": "healthcare.projects.locations.datasets.fhirStores.search", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Name of the FHIR store to retrieve resources from.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", - "required": true, - "type": "string" - }, - "resourceType": { - "description": "The FHIR resource type to search, such as Patient or Observation. For a\ncomplete list, see the FHIR Resource Index\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html),\n[R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/fhir", - "response": { - "$ref": "HttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.setIamPolicy", @@ -1896,7 +1866,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.testIamPermissions", @@ -2048,7 +2018,7 @@ ] }, "Patient-everything": { - "description": "Retrieves all the resources directly referenced by a patient, as well as\nall of the resources in the patient compartment.\n\nImplements the FHIR extended operation Patient-everything\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything),\n[R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)).\n\nOn success, the response body will contain a JSON-encoded representation\nof a `Bundle` resource of type `searchset`, containing the results of the\noperation.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.", + "description": "Retrieves a Patient resource and resources related to that patient.\n\nImplements the FHIR extended operation Patient-everything\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything),\n[R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)).\n\nOn success, the response body will contain a JSON-encoded representation\nof a `Bundle` resource of type `searchset`, containing the results of the\noperation.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.\n\nThe resources in scope for the response are:\n\n* The patient resource itself.\n* All the resources directly referenced by the patient resource.\n* Resources directly referencing the patient resource that meet the\n inclusion criteria. The inclusion criteria are based on the membership\n rules in the patient compartment definition\n ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html),\n [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html),\n [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which\n details the eligible resource types and referencing search parameters.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything", @@ -2144,7 +2114,7 @@ ] }, "conditionalDelete": { - "description": "Deletes FHIR resources that match a search query.\n\nImplements the FHIR standard conditional delete interaction\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)).\nIf multiple resources match, all of them will be deleted.\n\nSearch terms are provided as query parameters following the same pattern as\nthe search method.\n\nNote: Unless resource versioning is disabled by setting the\ndisable_resource_versioning flag\non the FHIR store, the deleted resources will be moved to a history\nrepository that can still be retrieved through vread\nand related methods, unless they are removed by the\npurge method.", + "description": "Deletes FHIR resources that match a search query.\n\nImplements the FHIR standard conditional delete interaction\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)).\nIf multiple resources match, all of them will be deleted.\n\nSearch terms are provided as query parameters following the same pattern as\nthe search method.\n\nNote: Unless resource versioning is disabled by setting the\ndisable_resource_versioning flag\non the FHIR store, the deleted resources will be moved to a history\nrepository that can still be retrieved through vread\nand related methods, unless they are removed by the\npurge method.\n\nThis method requires the`healthcare.fhirStores.searchResources` and\n`healthcare.fhirResources.delete` permissions on the parent FHIR store.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete", @@ -2177,7 +2147,7 @@ ] }, "conditionalPatch": { - "description": "If a resource is found based on the search criteria specified in the query\nparameters, updates part of that resource by applying the operations\nspecified in a [JSON Patch](http://jsonpatch.com/) document.\n\nImplements the FHIR standard conditional patch interaction\n([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)).\n\nDSTU2 doesn't define a conditional patch method, but the server supports it\nin the same way it supports STU3.\n\nSearch terms are provided as query parameters following the same pattern as\nthe search method.\n\nIf the search criteria identify more than one match, the request will\nreturn a `412 Precondition Failed` error.\n\nThe request body must contain a JSON Patch document, and the request\nheaders must contain `Content-Type: application/json-patch+json`.\n\nOn success, the response body will contain a JSON-encoded representation\nof the updated resource, including the server-assigned version ID.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.", + "description": "If a resource is found based on the search criteria specified in the query\nparameters, updates part of that resource by applying the operations\nspecified in a [JSON Patch](http://jsonpatch.com/) document.\n\nImplements the FHIR standard conditional patch interaction\n([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)).\n\nDSTU2 doesn't define a conditional patch method, but the server supports it\nin the same way it supports STU3.\n\nSearch terms are provided as query parameters following the same pattern as\nthe search method.\n\nIf the search criteria identify more than one match, the request will\nreturn a `412 Precondition Failed` error.\n\nThe request body must contain a JSON Patch document, and the request\nheaders must contain `Content-Type: application/json-patch+json`.\n\nOn success, the response body will contain a JSON-encoded representation\nof the updated resource, including the server-assigned version ID.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.\n\nThis method requires the`healthcare.fhirStores.searchResources` permission\non the parent FHIR store and the `healthcare.fhirResources.patch`\npermission on the requested FHIR store resource.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "PATCH", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch", @@ -2213,7 +2183,7 @@ ] }, "conditionalUpdate": { - "description": "If a resource is found based on the search criteria specified in the query\nparameters, updates the entire contents of that resource.\n\nImplements the FHIR standard conditional update interaction\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#cond-update)).\n\nSearch terms are provided as query parameters following the same pattern as\nthe search method.\n\nIf the search criteria identify more than one match, the request will\nreturn a `412 Precondition Failed` error.\nIf the search criteria identify zero matches, and the supplied resource\nbody contains an `id`, and the FHIR store has\nenable_update_create set, creates the\nresource with the client-specified ID. If the search criteria identify zero\nmatches, and the supplied resource body does not contain an `id`, the\nresource will be created with a server-assigned ID as per the\ncreate method.\n\nThe request body must contain a JSON-encoded FHIR resource, and the request\nheaders must contain `Content-Type: application/fhir+json`.\n\nOn success, the response body will contain a JSON-encoded representation\nof the updated resource, including the server-assigned version ID.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.", + "description": "If a resource is found based on the search criteria specified in the query\nparameters, updates the entire contents of that resource.\n\nImplements the FHIR standard conditional update interaction\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#cond-update)).\n\nSearch terms are provided as query parameters following the same pattern as\nthe search method.\n\nIf the search criteria identify more than one match, the request will\nreturn a `412 Precondition Failed` error.\nIf the search criteria identify zero matches, and the supplied resource\nbody contains an `id`, and the FHIR store has\nenable_update_create set, creates the\nresource with the client-specified ID. If the search criteria identify zero\nmatches, and the supplied resource body does not contain an `id`, the\nresource will be created with a server-assigned ID as per the\ncreate method.\n\nThe request body must contain a JSON-encoded FHIR resource, and the request\nheaders must contain `Content-Type: application/fhir+json`.\n\nOn success, the response body will contain a JSON-encoded representation\nof the updated resource, including the server-assigned version ID.\nErrors generated by the FHIR store will contain a JSON-encoded\n`OperationOutcome` resource describing the reason for the error. If the\nrequest cannot be mapped to a valid API method on a FHIR store, a generic\nGCP error might be returned instead.\n\nThis method requires the`healthcare.fhirStores.searchResources` and\n`healthcare.fhirResources.update` permissions on the parent FHIR store.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "PUT", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate", @@ -2310,7 +2280,7 @@ ] }, "executeBundle": { - "description": "Executes all the requests in the given Bundle.\n\nImplements the FHIR standard batch/transaction interaction\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#transaction)).\n\nSupports all interactions within a bundle, except search. This method\naccepts Bundles of type `batch` and `transaction`, processing them\naccording to the batch processing rules\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules))\nand transaction processing rules\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)).\n\nThe request body must contain a JSON-encoded FHIR `Bundle` resource, and\nthe request headers must contain `Content-Type: application/fhir+json`.\n\nFor a batch bundle or a successful transaction the response body will\ncontain a JSON-encoded representation of a `Bundle` resource of type\n`batch-response` or `transaction-response` containing one entry for each\nentry in the request, with the outcome of processing the entry. In the\ncase of an error for a transaction bundle, the response body will contain\na JSON-encoded `OperationOutcome` resource describing the reason for the\nerror. If the request cannot be mapped to a valid API method on a FHIR\nstore, a generic GCP error might be returned instead.", + "description": "Executes all the requests in the given Bundle.\n\nImplements the FHIR standard batch/transaction interaction\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#transaction)).\n\nSupports all interactions within a bundle, except search. This method\naccepts Bundles of type `batch` and `transaction`, processing them\naccording to the batch processing rules\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules))\nand transaction processing rules\n([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2),\n[STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2),\n[R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)).\n\nThe request body must contain a JSON-encoded FHIR `Bundle` resource, and\nthe request headers must contain `Content-Type: application/fhir+json`.\n\nFor a batch bundle or a successful transaction the response body will\ncontain a JSON-encoded representation of a `Bundle` resource of type\n`batch-response` or `transaction-response` containing one entry for each\nentry in the request, with the outcome of processing the entry. In the\ncase of an error for a transaction bundle, the response body will contain\na JSON-encoded `OperationOutcome` resource describing the reason for the\nerror. If the request cannot be mapped to a valid API method on a FHIR\nstore, a generic GCP error might be returned instead.\n\nThis method requires permission for executing the requests in the bundle.\nThe `executeBundle` permission grants permission to execute the request in\nthe bundle but you must grant sufficient permissions to execute the\nindividual requests in the bundle. For example, if the bundle contains a\n`create` request, you must have permission to execute the `create` request.\n\nLogging is available for the `executeBundle` permission.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", @@ -2616,7 +2586,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -2713,7 +2683,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:setIamPolicy", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy", @@ -2741,7 +2711,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:testIamPermissions", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions", @@ -3091,7 +3061,7 @@ } } }, - "revision": "20200424", + "revision": "20200501", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AuditConfig": { @@ -3148,7 +3118,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -3910,7 +3880,7 @@ "type": "string" }, "pubsubTopic": { - "description": "The [Cloud Pubsub](https://cloud.google.com/pubsub/docs/) topic that\nnotifications of changes are published on. Supplied by the client. The\nnotification is a `PubsubMessage` with the following fields:\n\n* `PubsubMessage.Data` contains the resource name.\n* `PubsubMessage.MessageId` is the ID of this notification. It is\nguaranteed to be unique within the topic.\n* `PubsubMessage.PublishTime` is the time at which the message was\npublished.\n\nNote that notifications are only sent if the topic is non-empty. [Topic\nnames](https://cloud.google.com/pubsub/docs/overview#names) must be\nscoped to a project. cloud-healthcare@system.gserviceaccount.com must\nhave publisher permissions on the given Pubsub topic. Not having adequate\npermissions causes the calls that send notifications to fail.\n\nIf a notification cannot be published to Cloud Pub/Sub, errors will be\nlogged to Stackdriver (see [Viewing logs](/healthcare/docs/how-\ntos/stackdriver-logging)).", + "description": "The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that\nnotifications of changes are published on. Supplied by the client. The\nnotification is a `PubsubMessage` with the following fields:\n\n* `PubsubMessage.Data` contains the resource name.\n* `PubsubMessage.MessageId` is the ID of this notification. It is\nguaranteed to be unique within the topic.\n* `PubsubMessage.PublishTime` is the time at which the message was\npublished.\n\nNote that notifications are only sent if the topic is non-empty. [Topic\nnames](https://cloud.google.com/pubsub/docs/overview#names) must be\nscoped to a project. Cloud Healthcare API service account must have\npublisher permissions on the given Pub/Sub topic. Not having adequate\npermissions causes the calls that send notifications to fail.\n\nIf a notification cannot be published to Cloud Pub/Sub, errors will be\nlogged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-\ntos/logging)).", "type": "string" } }, @@ -4345,7 +4315,7 @@ "id": "NotificationConfig", "properties": { "pubsubTopic": { - "description": "The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that\nnotifications of changes are published on. Supplied by the client.\nPubsubMessage.Data contains the resource name.\nPubsubMessage.MessageId is the ID of this message. It is guaranteed to be\nunique within the topic.\nPubsubMessage.PublishTime is the time at which the message was published.\nNotifications are only sent if the topic is\nnon-empty. [Topic\nnames](https://cloud.google.com/pubsub/docs/overview#names) must be scoped\nto a project. cloud-healthcare@system.gserviceaccount.com must have\npublisher permissions on the given Cloud Pub/Sub topic. Not having adequate\npermissions causes the calls that send notifications to fail.\n\nIf a notification can't be published to Cloud Pub/Sub, errors are logged to\nStackdriver (see [Viewing\nlogs](/healthcare/docs/how-tos/stackdriver-logging)). If the number of\nerrors exceeds a certain rate, some aren't submitted.", + "description": "The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that\nnotifications of changes are published on. Supplied by the client.\nPubsubMessage.Data contains the resource name.\nPubsubMessage.MessageId is the ID of this message. It is guaranteed to be\nunique within the topic.\nPubsubMessage.PublishTime is the time at which the message was published.\nNotifications are only sent if the topic is\nnon-empty. [Topic\nnames](https://cloud.google.com/pubsub/docs/overview#names) must be scoped\nto a project. Cloud Healthcare API service account must have publisher\npermissions on the given Cloud Pub/Sub topic. Not having adequate\npermissions causes the calls that send notifications to fail.\n\nIf a notification can't be published to Cloud Pub/Sub, errors are logged to\nCloud Logging (see [Viewing\nlogs](/healthcare/docs/how-tos/logging)). If the number of\nerrors exceeds a certain rate, some aren't submitted.", "type": "string" } }, @@ -4412,7 +4382,7 @@ "type": "string" }, "logsUrl": { - "description": "A link to audit and error logs in the log viewer. Error logs are generated\nonly by some operations, listed at\nhttps://cloud.google.com/healthcare/docs/how-tos/stackdriver-logging.", + "description": "A link to audit and error logs in the log viewer. Error logs are generated\nonly by some operations, listed at\n[Viewing logs](/healthcare/docs/how-tos/logging).", "type": "string" } }, @@ -4467,7 +4437,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -4490,7 +4460,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -4564,7 +4534,7 @@ "enumDescriptions": [ "No schema type specified. Same as `LOSSLESS`.", "A data-driven schema generated from the fields present in the FHIR data\nbeing exported, with no additional simplification.", - "Analytics schema defined by the FHIR community.\nSee https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md." + "Analytics schema defined by the FHIR community.\nSee https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.\n\nBigQuery only allows a maximum of 10,000 columns per table. Due to this\nlimitation, the server will not generate schemas for fields of type\n`Resource`, which can hold any resource type. The affected fields are\n`Parameters.parameter.resource`, `Bundle.entry.resource`, and\n`Bundle.entry.response.outcome`." ], "type": "string" } @@ -4720,7 +4690,7 @@ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." }, "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } @@ -4760,7 +4730,7 @@ "properties": { "bigqueryDestination": { "$ref": "GoogleCloudHealthcareV1beta1FhirBigQueryDestination", - "description": "The destination BigQuery structure that contains both the dataset\nlocation and corresponding schema config.\n\nThe output is organized in one table per resource type. The server\nreuses the existing tables (if any) that are named after the resource\ntypes, e.g. \"Patient\", \"Observation\". When there is no existing table\nfor a given resource type, the server attempts to create one.\n\nWhen a table schema doesn't align with the schema config, either\nbecause of existing incompatible schema or out of band incompatible\nmodification, the server does not stream in new data.\n\nOne resolution in this case is to delete the incompatible\ntable and let the server recreate one, though the newly created table\nonly contains data after the table recreation.\n\nBigQuery imposes a 1 MB limit on streaming insert row size, therefore\nany resource mutation that generates more than 1 MB of BigQuery data\nwill not be streamed.\n\nResults are appended to the corresponding BigQuery tables. Different\nversions of the same resource are distinguishable by the meta.versionId\nand meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that\nresults in the new version is recorded in the meta.tag.\n\nThe tables contain all historical resource versions since streaming was\nenabled. For query convenience, the server also creates one view per\ntable of the same name containing only the current resource version.\n\nIf a resource mutation cannot be streamed to BigQuery, errors will be\nlogged to Stackdriver (see [Viewing logs](/healthcare/docs/how-\ntos/stackdriver-logging))." + "description": "The destination BigQuery structure that contains both the dataset\nlocation and corresponding schema config.\n\nThe output is organized in one table per resource type. The server\nreuses the existing tables (if any) that are named after the resource\ntypes, e.g. \"Patient\", \"Observation\". When there is no existing table\nfor a given resource type, the server attempts to create one.\n\nWhen a table schema doesn't align with the schema config, either\nbecause of existing incompatible schema or out of band incompatible\nmodification, the server does not stream in new data.\n\nOne resolution in this case is to delete the incompatible\ntable and let the server recreate one, though the newly created table\nonly contains data after the table recreation.\n\nBigQuery imposes a 1 MB limit on streaming insert row size, therefore\nany resource mutation that generates more than 1 MB of BigQuery data\nwill not be streamed.\n\nResults are appended to the corresponding BigQuery tables. Different\nversions of the same resource are distinguishable by the meta.versionId\nand meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that\nresults in the new version is recorded in the meta.tag.\n\nThe tables contain all historical resource versions since streaming was\nenabled. For query convenience, the server also creates one view per\ntable of the same name containing only the current resource version.\n\nThe streamed data in the BigQuery dataset is not guaranteed to be\ncompletely unique. The combination of the id and meta.versionId columns\nshould ideally identify a single unique row. But in rare cases,\nduplicates may exist. At query time, users may use the SQL select\nstatement to keep only one of the duplicate rows given an id and\nmeta.versionId pair. Alternatively, the server created view mentioned\nabove also filters out duplicates.\n\nIf a resource mutation cannot be streamed to BigQuery, errors will be\nlogged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-\ntos/logging))." }, "resourceTypes": { "description": "Supply a FHIR resource type (such as \"Patient\" or \"Observation\").\nSee https://www.hl7.org/fhir/valueset-resource-types.html for a list of\nall FHIR resource types.\nThe server treats an empty list as an intent to stream all the\nsupported resource types in this FHIR store.", diff --git a/discovery/homegraph-v1.json b/discovery/homegraph-v1.json index f35a0f39ef9..c47bd63079a 100644 --- a/discovery/homegraph-v1.json +++ b/discovery/homegraph-v1.json @@ -192,7 +192,7 @@ } } }, - "revision": "20200429", + "revision": "20200504", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { diff --git a/discovery/iamcredentials-v1.json b/discovery/iamcredentials-v1.json index 24c7377d080..b148d4dafcc 100644 --- a/discovery/iamcredentials-v1.json +++ b/discovery/iamcredentials-v1.json @@ -226,7 +226,7 @@ } } }, - "revision": "20200417", + "revision": "20200501", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/discovery/iap-v1.json b/discovery/iap-v1.json index e05fd6ad9c5..0f5fdc5bab6 100644 --- a/discovery/iap-v1.json +++ b/discovery/iap-v1.json @@ -201,7 +201,7 @@ ], "parameters": { "parent": { - "description": "Required. Path to create the client in.\nIn the following format:\nprojects/{project_number/id}/brands/{brand}.\nThe project must belong to a GSuite account.", + "description": "Required. Path to create the client in.\nIn the following format:\nprojects/{project_number/id}/brands/{brand}.\nThe project must belong to a G Suite account.", "location": "path", "pattern": "^projects/[^/]+/brands/[^/]+$", "required": true, @@ -487,7 +487,7 @@ } } }, - "revision": "20200409", + "revision": "20200511", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { @@ -532,6 +532,10 @@ "$ref": "AccessDeniedPageSettings", "description": "Customization for Access Denied page." }, + "cookieDomain": { + "description": "The Domain value to set for cookies generated by IAP. This value is not\nvalidated by the API, but will be ignored at runtime if invalid.", + "type": "string" + }, "csmSettings": { "$ref": "CsmSettings", "description": "Settings to configure IAP's behavior for a CSM mesh." @@ -545,7 +549,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -574,7 +578,7 @@ "type": "string" }, "orgInternalOnly": { - "description": "Output only. Whether the brand is only intended for usage inside the\nGSuite organization only.", + "description": "Output only. Whether the brand is only intended for usage inside the\nG Suite organization only.", "type": "boolean" }, "supportEmail": { @@ -659,7 +663,7 @@ "properties": { "options": { "$ref": "GetPolicyOptions", - "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM." + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`." } }, "type": "object" @@ -669,7 +673,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -762,7 +766,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -778,7 +782,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -815,7 +819,7 @@ "type": "string" }, "region": { - "description": "For Cloud IAM:\nThe location of the Policy.\nMust be empty or \"global\" for Policies owned by global IAM. Must name a\nregion from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see\nhttp://go/iam-faq#where-is-iam-currently-deployed.\n\nFor Local IAM:\nThis field should be set to \"local\".", + "description": "For Cloud IAM:\nThe location of the Policy.\nMust be empty or \"global\" for Policies owned by global IAM. Must name a\nregion from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see\ngo/iam-faq#where-is-iam-currently-deployed.\n\nFor Local IAM:\nThis field should be set to \"local\".", "type": "string" }, "type": { diff --git a/discovery/iap-v1beta1.json b/discovery/iap-v1beta1.json index 087ae6bbc0a..a3888889b6a 100644 --- a/discovery/iap-v1beta1.json +++ b/discovery/iap-v1beta1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20200409", + "revision": "20200511", "rootUrl": "https://iap.googleapis.com/", "schemas": { "Binding": { @@ -203,7 +203,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -248,7 +248,7 @@ "properties": { "options": { "$ref": "GetPolicyOptions", - "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM." + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`." } }, "type": "object" @@ -258,7 +258,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -266,7 +266,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -282,7 +282,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/index.json b/discovery/index.json index d220b99fa3a..62ed2e3e56a 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -1307,21 +1307,6 @@ "documentationLink": "https://cloud.google.com/trace", "preferred": false }, - { - "kind": "discovery#directoryItem", - "id": "commentanalyzer:v1alpha1", - "name": "commentanalyzer", - "version": "v1alpha1", - "title": "Perspective Comment Analyzer API", - "description": "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.", - "discoveryRestUrl": "https://commentanalyzer.googleapis.com/$discovery/rest?version=v1alpha1", - "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" - }, - "documentationLink": "https://github.com/conversationai/perspectiveapi/blob/master/README.md", - "preferred": true - }, { "kind": "discovery#directoryItem", "id": "composer:v1", diff --git a/discovery/indexing-v3.json b/discovery/indexing-v3.json index 7a038756c6d..c3468eb13d5 100644 --- a/discovery/indexing-v3.json +++ b/discovery/indexing-v3.json @@ -149,7 +149,7 @@ } } }, - "revision": "20200421", + "revision": "20200509", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": { diff --git a/discovery/jobs-v2.json b/discovery/jobs-v2.json index cd3c4cff3dd..c4e7ee788a7 100644 --- a/discovery/jobs-v2.json +++ b/discovery/jobs-v2.json @@ -615,7 +615,7 @@ } } }, - "revision": "20200501", + "revision": "20200506", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "BatchDeleteJobsRequest": { diff --git a/discovery/jobs-v3.json b/discovery/jobs-v3.json index 1996fb20399..7582e4cb0e2 100644 --- a/discovery/jobs-v3.json +++ b/discovery/jobs-v3.json @@ -633,7 +633,7 @@ } } }, - "revision": "20200423", + "revision": "20200505", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -1213,7 +1213,7 @@ "id": "CustomAttribute", "properties": { "filterable": { - "description": "Optional. If the `filterable` flag is true, custom field values are searchable.\nIf false, values are not searchable.\n\nDefault is false.", + "description": "Optional. If the `filterable` flag is true, the custom field values may be used for\ncustom attribute filters JobQuery.custom_attribute_filter.\nIf false, these values may not be used for custom attribute filters.\n\nDefault is false.", "type": "boolean" }, "longValues": { diff --git a/discovery/jobs-v3p1beta1.json b/discovery/jobs-v3p1beta1.json index ee1a1064dd5..6d133767b87 100644 --- a/discovery/jobs-v3p1beta1.json +++ b/discovery/jobs-v3p1beta1.json @@ -663,7 +663,7 @@ } } }, - "revision": "20200423", + "revision": "20200506", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/discovery/kgsearch-v1.json b/discovery/kgsearch-v1.json index a9f4b3eb665..ac60c8ce437 100644 --- a/discovery/kgsearch-v1.json +++ b/discovery/kgsearch-v1.json @@ -151,7 +151,7 @@ } } }, - "revision": "20200405", + "revision": "20200509", "rootUrl": "https://kgsearch.googleapis.com/", "schemas": { "SearchResponse": { diff --git a/discovery/language-v1.json b/discovery/language-v1.json index 9e5b639ac81..081aac19256 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -227,7 +227,7 @@ } } }, - "revision": "20200411", + "revision": "20200502", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/discovery/language-v1beta1.json b/discovery/language-v1beta1.json index 73f2c4cf251..af76c0c55fc 100644 --- a/discovery/language-v1beta1.json +++ b/discovery/language-v1beta1.json @@ -189,7 +189,7 @@ } } }, - "revision": "20200411", + "revision": "20200502", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/discovery/language-v1beta2.json b/discovery/language-v1beta2.json index faaa0cb78e0..e6fc0164e47 100644 --- a/discovery/language-v1beta2.json +++ b/discovery/language-v1beta2.json @@ -227,7 +227,7 @@ } } }, - "revision": "20200411", + "revision": "20200502", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/discovery/libraryagent-v1.json b/discovery/libraryagent-v1.json index 366c52b4536..b178047e00f 100644 --- a/discovery/libraryagent-v1.json +++ b/discovery/libraryagent-v1.json @@ -279,7 +279,7 @@ } } }, - "revision": "20200502", + "revision": "20200511", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": { diff --git a/discovery/lifesciences-v2beta.json b/discovery/lifesciences-v2beta.json index 7a8d971fe86..c26e2765f7c 100644 --- a/discovery/lifesciences-v2beta.json +++ b/discovery/lifesciences-v2beta.json @@ -312,7 +312,7 @@ } } }, - "revision": "20200416", + "revision": "20200507", "rootUrl": "https://lifesciences.googleapis.com/", "schemas": { "Accelerator": { diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 0b5df421ff3..953eadf5c23 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -679,7 +679,7 @@ "entries": { "methods": { "list": { - "description": "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.", + "description": "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 (https://cloud.google.com/logging/docs/export).", "flatPath": "v2/entries:list", "httpMethod": "POST", "id": "logging.entries.list", @@ -1653,7 +1653,7 @@ "organizations": { "methods": { "getCmekSettings": { - "description": "Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information.", + "description": "Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/organizations/{organizationsId}/cmekSettings", "httpMethod": "GET", "id": "logging.organizations.getCmekSettings", @@ -1681,7 +1681,7 @@ ] }, "updateCmekSettings": { - "description": "Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router for more information.", + "description": "Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/organizations/{organizationsId}/cmekSettings", "httpMethod": "PATCH", "id": "logging.organizations.updateCmekSettings", @@ -3157,7 +3157,7 @@ "v2": { "methods": { "getCmekSettings": { - "description": "Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information.", + "description": "Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/{v2Id}/{v2Id1}/cmekSettings", "httpMethod": "GET", "id": "logging.getCmekSettings", @@ -3185,7 +3185,7 @@ ] }, "updateCmekSettings": { - "description": "Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router for more information.", + "description": "Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/{v2Id}/{v2Id1}/cmekSettings", "httpMethod": "PATCH", "id": "logging.updateCmekSettings", @@ -3222,7 +3222,7 @@ } } }, - "revision": "20200407", + "revision": "20200501", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryOptions": { @@ -3230,7 +3230,7 @@ "id": "BigQueryOptions", "properties": { "usePartitionedTables": { - "description": "Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.", + "description": "Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone.", "type": "boolean" }, "usesTimestampColumnPartitioning": { @@ -3260,11 +3260,11 @@ "type": "object" }, "CmekSettings": { - "description": "Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information.", + "description": "Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "id": "CmekSettings", "properties": { "kmsKeyName": { - "description": "The resource name for the configured Cloud KMS key.KMS key name format: \"projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY\"For example: \"projects/my-project-id/locations/my-region/keyRings/key-ring-name/cryptoKeys/key-name\"To enable CMEK for the Logs Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Logs Router, set this field to an empty string.See Enabling CMEK for Logs Router for more information.", + "description": "The resource name for the configured Cloud KMS key.KMS key name format: \"projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY\"For example: \"projects/my-project-id/locations/my-region/keyRings/key-ring-name/cryptoKeys/key-name\"To enable CMEK for the Logs Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Logs Router, set this field to an empty string.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "type": "string" }, "name": { @@ -3272,7 +3272,7 @@ "type": "string" }, "serviceAccountId": { - "description": "Output only. The service account that will be used by the Logs Router to access your Cloud KMS key.Before enabling CMEK for Logs Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Logs Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router for more information.", + "description": "Output only. The service account that will be used by the Logs Router to access your Cloud KMS key.Before enabling CMEK for Logs Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Logs Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "type": "string" } }, @@ -3485,7 +3485,7 @@ "id": "ListLogEntriesRequest", "properties": { "filter": { - "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Queries. 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.", + "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Queries (https://cloud.google.com/logging/docs/view/advanced-queries). 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.", "type": "string" }, "orderBy": { @@ -3685,7 +3685,7 @@ }, "metadata": { "$ref": "MonitoredResourceMetadata", - "description": "Output only. Deprecated. 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." + "description": "Output only. Deprecated. 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 system labels that were present in the metadata.systemLabels field will no longer be available in the LogEntry." }, "operation": { "$ref": "LogEntryOperation", @@ -3747,7 +3747,7 @@ "type": "string" }, "timestamp": { - "description": "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 must have timestamps that don't exceed the logs retention period in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging.", + "description": "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 must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging.", "format": "google-datetime", "type": "string" }, @@ -3823,7 +3823,7 @@ "type": "boolean" }, "filter": { - "description": "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 query matches 99% of low-severity log entries from Google Cloud Storage buckets:\"resource.type=gcs_bucket severity=ERROR\"\nThe maximum length of the filter is 20000 characters.", + "description": "Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example:\n\"resource.type=gae_app AND severity>=ERROR\"\nThe maximum length of the filter is 20000 characters.", "type": "string" }, "labelExtractors": { @@ -3962,7 +3962,7 @@ "type": "string" }, "destination": { - "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe 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.", + "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe 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 (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).", "type": "string" }, "disabled": { @@ -3970,7 +3970,7 @@ "type": "boolean" }, "filter": { - "description": "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:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity>=ERROR\n", + "description": "Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity>=ERROR\n", "type": "string" }, "includeChildren": { @@ -3982,7 +3982,7 @@ "type": "string" }, "outputVersionFormat": { - "description": "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.", + "description": "Deprecated. This field is unused.", "enum": [ "VERSION_FORMAT_UNSPECIFIED", "V2", @@ -4001,7 +4001,7 @@ "type": "string" }, "writerIdentity": { - "description": "Output only. An IAM identity—a service account or group—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.", + "description": "Output only. An IAM identity—a service account or group—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 (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.", "type": "string" } }, @@ -4447,7 +4447,7 @@ "type": "boolean" }, "entries": { - "description": "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.", + "description": "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 (https://cloud.google.com/logging/quota-policy) 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 (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).To improve throughput and to avoid exceeding the quota limit (https://cloud.google.com/logging/quota-policy) 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.", "items": { "$ref": "LogEntry" }, diff --git a/discovery/manufacturers-v1.json b/discovery/manufacturers-v1.json index 6cfcba2ece4..1a01dc468dd 100644 --- a/discovery/manufacturers-v1.json +++ b/discovery/manufacturers-v1.json @@ -275,7 +275,7 @@ } } }, - "revision": "20200428", + "revision": "20200505", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { diff --git a/discovery/memcache-v1beta2.json b/discovery/memcache-v1beta2.json index 7ac574e8020..e88f20fd844 100644 --- a/discovery/memcache-v1beta2.json +++ b/discovery/memcache-v1beta2.json @@ -300,7 +300,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -402,7 +402,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy", "httpMethod": "POST", "id": "memcache.projects.locations.instances.setIamPolicy", @@ -430,7 +430,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions", "httpMethod": "POST", "id": "memcache.projects.locations.instances.testIamPermissions", @@ -615,7 +615,7 @@ } } }, - "revision": "20200414", + "revision": "20200512", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -690,7 +690,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1362,7 +1362,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -1385,7 +1385,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1401,7 +1401,7 @@ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." }, "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index d1600611756..f74a3c5a097 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -275,7 +275,7 @@ } } }, - "revision": "20200416", + "revision": "20200502", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index 6bfc826ac28..f552406ac03 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -128,7 +128,7 @@ ], "parameters": { "name": { - "description": "Required. The project in which to create the alerting policy. The format is:\nprojects/[PROJECT_ID_OR_NUMBER]\nNote 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/[ALERT_POLICY_ID], identifying the policy in the container.", + "description": "Required. The project in which to create the alerting policy. The format is:\nprojects/[PROJECT_ID_OR_NUMBER]\nNote that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. 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/[ALERT_POLICY_ID], identifying the policy in the container.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -201,7 +201,7 @@ ] }, "list": { - "description": "Lists the existing alerting policies for the project.", + "description": "Lists the existing alerting policies for the workspace.", "flatPath": "v3/projects/{projectsId}/alertPolicies", "httpMethod": "GET", "id": "monitoring.projects.alertPolicies.list", @@ -1848,7 +1848,7 @@ } } }, - "revision": "20200416", + "revision": "20200502", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2762,6 +2762,23 @@ "$ref": "BasicAuthentication", "description": "The authentication information. Optional when creating an HTTP check; defaults to empty." }, + "body": { + "description": "The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields JSON representations are base64 encoded. e.g.: \"foo=bar\" in URL-encoded form is \"foo%3Dbar\" and in base64 encoding is \"Zm9vJTI1M0RiYXI=\".", + "format": "byte", + "type": "string" + }, + "contentType": { + "description": "The content type to use for the check.", + "enum": [ + "TYPE_UNSPECIFIED", + "URL_ENCODED" + ], + "enumDescriptions": [ + "No content type specified. If the request method is POST, an unspecified content type results in a check creation rejection.", + "body is in URL-encoded form. Equivalent to setting the Content-Type to application/x-www-form-urlencoded in the HTTP request." + ], + "type": "string" + }, "headers": { "additionalProperties": { "type": "string" @@ -2770,7 +2787,7 @@ "type": "object" }, "maskHeaders": { - "description": "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 ******.", + "description": "Boolean specifying 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 ******.", "type": "boolean" }, "path": { @@ -2782,6 +2799,20 @@ "format": "int32", "type": "integer" }, + "requestMethod": { + "description": "The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.", + "enum": [ + "METHOD_UNSPECIFIED", + "GET", + "POST" + ], + "enumDescriptions": [ + "No request method specified.", + "GET request.", + "POST request." + ], + "type": "string" + }, "useSsl": { "description": "If true, use HTTPS instead of HTTP to run the check.", "type": "boolean" @@ -4029,7 +4060,7 @@ "type": "object" }, "TimeInterval": { - "description": "A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time.\nFor a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements.\nFor DELTA and CUMULATIVE metrics, the start time must be earlier than the end time.\nIn all cases, the start time of the next interval must be at least a microsecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time.", + "description": "A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time.\nFor a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements.\nFor DELTA and CUMULATIVE metrics, the start time must be earlier than the end time.\nIn all cases, the start time of the next interval must be at least a millisecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time.", "id": "TimeInterval", "properties": { "endTime": { @@ -4051,7 +4082,7 @@ "properties": { "metadata": { "$ref": "MonitoredResourceMetadata", - "description": "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." + "description": "Output only. The associated monitored resource metadata. When reading a timeseries, this field will include metadata labels that are explicitly named in the reduction. When creating a timeseries, this field is ignored." }, "metric": { "$ref": "Metric", diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index 30870d59358..78eb1a61df5 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -224,7 +224,7 @@ ], "parameters": { "name": { - "description": "Required. Connectivity Test resource name using the form:\n `projects/{project_id}/connectivityTests/{test_id}`", + "description": "Required. Connectivity Test resource name using the form:\n `projects/{project_id}/locations/global/connectivityTests/{test_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$", "required": true, @@ -274,7 +274,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -305,7 +305,7 @@ ], "parameters": { "filter": { - "description": "Lists the `ConnectivityTests` that match the filter expression. A filter\nexpression filters the resources listed in the response. The expression\nmust be of the form ` ` where operators: `<`, `>`,\n`<=`,\n`>=`,\n`!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is\nroughly synonymous with equality). can refer to a proto or JSON\nfield, or a synthetic field. Field names can be camelCase or snake_case.\n\nExamples:\n- Filter by name:\n name = \"projects/proj-1/connectivityTests/test-1\n\n- Filter by labels:\n - Resources that have a key called `foo`\n labels.foo:*\n - Resources that have a key called `foo` whose value is `bar`\n labels.foo = bar", + "description": "Lists the `ConnectivityTests` that match the filter expression. A filter\nexpression filters the resources listed in the response. The expression\nmust be of the form ` ` where operators: `<`, `>`,\n`<=`,\n`>=`,\n`!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is\nroughly synonymous with equality). can refer to a proto or JSON\nfield, or a synthetic field. Field names can be camelCase or snake_case.\n\nExamples:\n- Filter by name:\n name = \"projects/proj-1/locations/global/connectivityTests/test-1\n\n- Filter by labels:\n - Resources that have a key called `foo`\n labels.foo:*\n - Resources that have a key called `foo` whose value is `bar`\n labels.foo = bar", "location": "query", "type": "string" }, @@ -351,7 +351,7 @@ ], "parameters": { "name": { - "description": "Required. Unique name of the resource using the form:\n `projects/{project_id}/tests/{test_id}`", + "description": "Required. Unique name of the resource using the form:\n `projects/{project_id}/locations/global/connectivityTests/{test}`", "location": "path", "pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$", "required": true, @@ -385,7 +385,7 @@ ], "parameters": { "name": { - "description": "Required. Connectivity Test resource name using the form:\n `projects/{project_id}/connectivityTests/{test_id}`", + "description": "Required. Connectivity Test resource name using the form:\n `projects/{project_id}/locations/global/connectivityTests/{test_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$", "required": true, @@ -404,7 +404,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:setIamPolicy", "httpMethod": "POST", "id": "networkmanagement.projects.locations.global.connectivityTests.setIamPolicy", @@ -432,7 +432,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:testIamPermissions", "httpMethod": "POST", "id": "networkmanagement.projects.locations.global.connectivityTests.testIamPermissions", @@ -591,7 +591,7 @@ } } }, - "revision": "20200303", + "revision": "20200505", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -610,7 +610,8 @@ "INVALID_ARGUMENT", "NO_EXTERNAL_IP", "UNINTENDED_DESTINATION", - "TRACE_TOO_LONG" + "TRACE_TOO_LONG", + "INTERNAL_ERROR" ], "enumDescriptions": [ "Cause is unspecified.", @@ -622,7 +623,8 @@ "Aborted because the source and/or destination endpoint specified in\nthe test are invalid. The possible reasons that an endpoint is\ninvalid include: malformed IP address; nonexistent instance or\nnetwork URI; IP address not in the range of specified network URI; and\ninstance not owning the network interface in the specified network.", "Aborted because traffic is sent from a public IP to an instance without\nan external IP.", "Aborted because none of the traces matches destination information\nspecified in the input test request.", - "Aborted because the number of steps in the trace exceeding a certain\nlimit which may be caused by routing loop." + "Aborted because the number of steps in the trace exceeding a certain\nlimit which may be caused by routing loop.", + "Aborted due to internal server error." ], "type": "string" }, @@ -687,7 +689,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -738,7 +740,7 @@ "type": "object" }, "name": { - "description": "Required. Unique name of the resource using the form:\n `projects/{project_id}/tests/{test_id}`", + "description": "Required. Unique name of the resource using the form:\n `projects/{project_id}/locations/global/connectivityTests/{test}`", "type": "string" }, "protocol": { @@ -1385,7 +1387,7 @@ "type": "string" }, "target": { - "description": "Target of the operation - for example\nprojects/project-1/connectivityTests/test-1", + "description": "Target of the operation - for example\nprojects/project-1/locations/global/connectivityTests/test-1", "type": "string" }, "verb": { @@ -1396,7 +1398,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -1419,7 +1421,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1512,7 +1514,8 @@ "NEXT_HOP_VPN_TUNNEL", "NEXT_HOP_VPN_GATEWAY", "NEXT_HOP_INTERNET_GATEWAY", - "NEXT_HOP_BLACKHOLE" + "NEXT_HOP_BLACKHOLE", + "NEXT_HOP_ILB" ], "enumDescriptions": [ "Unspecified type. Default value.", @@ -1524,7 +1527,8 @@ "Next hop is a VPN tunnel.", "Next hop is a VPN Gateway. This scenario only happens when tracing\nconnectivity from an on-premises network to GCP through a VPN. The\nanalysis simulates a packet departing from the on-premises network\nthrough a VPN tunnel and arrives at a Cloud VPN gateway.", "Next hop is an internet gateway.", - "Next hop is blackhole; that is, the next hop either does not exist or is\nnot running." + "Next hop is blackhole; that is, the next hop either does not exist or is\nnot running.", + "Next hop is the forwarding rule of an Internal Load Balancer." ], "type": "string" }, @@ -1571,7 +1575,7 @@ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." }, "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/osconfig-v1.json b/discovery/osconfig-v1.json index e18592793b3..84e6f313cff 100644 --- a/discovery/osconfig-v1.json +++ b/discovery/osconfig-v1.json @@ -406,7 +406,7 @@ } } }, - "revision": "20200410", + "revision": "20200504", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -485,7 +485,7 @@ }, "gcsObject": { "$ref": "GcsObject", - "description": "A Google Cloud Storage object containing the executable." + "description": "A Cloud Storage object containing the executable." }, "interpreter": { "description": "The script interpreter to use to run the script. If no interpreter is\nspecified the script will be executed directly, which will likely\nonly succeed for scripts with [shebang lines]\n(https://en.wikipedia.org/wiki/Shebang_\\(Unix\\)).", @@ -509,7 +509,7 @@ "type": "object" }, "ExecutePatchJobRequest": { - "description": "A request message to initiate patching across Google Compute Engine\ninstances.", + "description": "A request message to initiate patching across Compute Engine\ninstances.", "id": "ExecutePatchJobRequest", "properties": { "description": { @@ -541,20 +541,20 @@ "type": "object" }, "GcsObject": { - "description": "Google Cloud Storage object representation.", + "description": "Cloud Storage object representation.", "id": "GcsObject", "properties": { "bucket": { - "description": "Required. Bucket of the Google Cloud Storage object.", + "description": "Required. Bucket of the Cloud Storage object.", "type": "string" }, "generationNumber": { - "description": "Required. Generation number of the Google Cloud Storage object. This is used to\nensure that the ExecStep specified by this PatchJob does not change.", + "description": "Required. Generation number of the Cloud Storage object. This is used to\nensure that the ExecStep specified by this PatchJob does not change.", "format": "int64", "type": "string" }, "object": { - "description": "Required. Name of the Google Cloud Storage object.", + "description": "Required. Name of the Cloud Storage object.", "type": "string" } }, @@ -637,7 +637,7 @@ "type": "object" }, "OneTimeSchedule": { - "description": "Sets the time for a one time patch deployment. Timestamp is in\nRFC3339\ntext format.", + "description": "Sets the time for a one time patch deployment. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "id": "OneTimeSchedule", "properties": { "executeTime": { @@ -700,11 +700,11 @@ "type": "object" }, "PatchDeployment": { - "description": "Patch deployments are configurations that individual patch jobs use to\ncomplete a patch. These configurations include instance filter, package\nrepository settings, and a schedule. For more information about creating and\nmanaging patch deployments, see [Scheduling patch\njobs](/compute/docs/os-patch-management/schedule-patch-jobs).", + "description": "Patch deployments are configurations that individual patch jobs use to\ncomplete a patch. These configurations include instance filter, package\nrepository settings, and a schedule. For more information about creating and\nmanaging patch deployments, see [Scheduling patch\njobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).", "id": "PatchDeployment", "properties": { "createTime": { - "description": "Output only. Time the patch deployment was created. Timestamp is in\nRFC3339\ntext format.", + "description": "Output only. Time the patch deployment was created. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "format": "google-datetime", "type": "string" }, @@ -722,7 +722,7 @@ "description": "Required. VM instances to patch." }, "lastExecuteTime": { - "description": "Output only. The last time a patch job was started by this deployment.\nTimestamp is in\nRFC3339\ntext format.", + "description": "Output only. The last time a patch job was started by this deployment.\nTimestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text\nformat.", "format": "google-datetime", "type": "string" }, @@ -743,7 +743,7 @@ "description": "Required. Schedule recurring executions." }, "updateTime": { - "description": "Output only. Time the patch deployment was last updated. Timestamp is in\nRFC3339\ntext format.", + "description": "Output only. Time the patch deployment was last updated. Timestamp is in\n[RFC3339](\"https://www.ietf.org/rfc/rfc3339.txt) text format.", "format": "google-datetime", "type": "string" } @@ -759,7 +759,7 @@ "type": "boolean" }, "groupLabels": { - "description": "Targets VM instances matching at least one of these label sets. This allows\ntargeting of disparate groups, for example \"env=prod or env=staging\".", + "description": "Targets VM instances matching ANY of these GroupLabels. This allows\ntargeting of disparate groups of VM instances.", "items": { "$ref": "PatchInstanceFilterGroupLabel" }, @@ -790,21 +790,21 @@ "type": "object" }, "PatchInstanceFilterGroupLabel": { - "description": "Represents a group of VMs that can be identified as having all these\nlabels, for example \"env=prod and app=web\".", + "description": "Targets a group of VM instances by using their [assigned\nlabels](https://cloud.google.com/compute/docs/labeling-resources). Labels\nare key-value pairs. A `GroupLabel` is a combination of labels\nthat is used to target VMs for a patch job.\n\nFor example, a patch job can target VMs that have the following\n`GroupLabel`: `{\"env\":\"test\", \"app\":\"web\"}`. This means that the patch job\nis applied to VMs that have both the labels `env=test` and `app=web`.", "id": "PatchInstanceFilterGroupLabel", "properties": { "labels": { "additionalProperties": { "type": "string" }, - "description": "Google Compute Engine instance labels that must be present for a VM\ninstance to be targeted by this filter.", + "description": "Compute Engine instance labels that must be present for a VM\ninstance to be targeted by this filter.", "type": "object" } }, "type": "object" }, "PatchJob": { - "description": "A high level representation of a patch job that is either in progress\nor has completed.\n\nInstances details are not included in the job. To paginate through instance\ndetails, use ListPatchJobInstanceDetails.\n\nFor more information about patch jobs, see\n[Creating patch jobs](/compute/docs/os-patch-management/create-patch-job).", + "description": "A high level representation of a patch job that is either in progress\nor has completed.\n\nInstances details are not included in the job. To paginate through instance\ndetails, use ListPatchJobInstanceDetails.\n\nFor more information about patch jobs, see\n[Creating patch\njobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).", "id": "PatchJob", "properties": { "createTime": { @@ -891,7 +891,7 @@ "type": "object" }, "PatchJobInstanceDetails": { - "description": "Patch details for a VM instance. For more information about reviewing VM\ninstance details, see\n[Listing all VM instance details for a specific patch\njob](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).", + "description": "Patch details for a VM instance. For more information about reviewing VM\ninstance details, see\n[Listing all VM instance details for a specific patch\njob](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).", "id": "PatchJobInstanceDetails", "properties": { "attemptCount": { diff --git a/discovery/osconfig-v1beta.json b/discovery/osconfig-v1beta.json index e67d1ff2ae0..3a694d4ebc3 100644 --- a/discovery/osconfig-v1beta.json +++ b/discovery/osconfig-v1beta.json @@ -599,7 +599,7 @@ } } }, - "revision": "20200410", + "revision": "20200504", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -1124,7 +1124,7 @@ "type": "object" }, "OneTimeSchedule": { - "description": "Sets the time for a one time patch deployment. Timestamp is in\nRFC3339\ntext format.", + "description": "Sets the time for a one time patch deployment. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "id": "OneTimeSchedule", "properties": { "executeTime": { @@ -1257,11 +1257,11 @@ "type": "object" }, "PatchDeployment": { - "description": "Patch deployments are configurations that individual patch jobs use to\ncomplete a patch. These configurations include instance filter, package\nrepository settings, and a schedule. For more information about creating and\nmanaging patch deployments, see [Scheduling patch\njobs](/compute/docs/os-patch-management/schedule-patch-jobs).", + "description": "Patch deployments are configurations that individual patch jobs use to\ncomplete a patch. These configurations include instance filter, package\nrepository settings, and a schedule. For more information about creating and\nmanaging patch deployments, see [Scheduling patch\njobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).", "id": "PatchDeployment", "properties": { "createTime": { - "description": "Output only. Time the patch deployment was created. Timestamp is in\nRFC3339\ntext format.", + "description": "Output only. Time the patch deployment was created. Timestamp is in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "format": "google-datetime", "type": "string" }, @@ -1279,7 +1279,7 @@ "description": "Required. VM instances to patch." }, "lastExecuteTime": { - "description": "Output only. The last time a patch job was started by this deployment.\nTimestamp is in\nRFC3339\ntext format.", + "description": "Output only. The last time a patch job was started by this deployment.\nTimestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text\nformat.", "format": "google-datetime", "type": "string" }, @@ -1300,7 +1300,7 @@ "description": "Required. Schedule recurring executions." }, "updateTime": { - "description": "Output only. Time the patch deployment was last updated. Timestamp is in\nRFC3339\ntext format.", + "description": "Output only. Time the patch deployment was last updated. Timestamp is in\n[RFC3339](\"https://www.ietf.org/rfc/rfc3339.txt) text format.", "format": "google-datetime", "type": "string" } @@ -1361,7 +1361,7 @@ "type": "object" }, "PatchJob": { - "description": "A high level representation of a patch job that is either in progress\nor has completed.\n\nInstances details are not included in the job. To paginate through instance\ndetails, use ListPatchJobInstanceDetails.\n\nFor more information about patch jobs, see\n[Creating patch jobs](/compute/docs/os-patch-management/create-patch-job).", + "description": "A high level representation of a patch job that is either in progress\nor has completed.\n\nInstances details are not included in the job. To paginate through instance\ndetails, use ListPatchJobInstanceDetails.\n\nFor more information about patch jobs, see\n[Creating patch\njobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).", "id": "PatchJob", "properties": { "createTime": { @@ -1448,7 +1448,7 @@ "type": "object" }, "PatchJobInstanceDetails": { - "description": "Patch details for a VM instance. For more information about reviewing VM\ninstance details, see\n[Listing all VM instance details for a specific patch\njob](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).", + "description": "Patch details for a VM instance. For more information about reviewing VM\ninstance details, see\n[Listing all VM instance details for a specific patch\njob](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).", "id": "PatchJobInstanceDetails", "properties": { "attemptCount": { @@ -1651,7 +1651,7 @@ "type": "object" }, "SoftwareRecipe": { - "description": "A software recipe is a set of instructions for installing and configuring a\npiece of software. It consists of a set of artifacts that are\ndownloaded, and a set of steps that install, configure, and/or update the\nsoftware.\n\nRecipes support installing and updating software from artifacts in the\nfollowing formats:\nZip archive, Tar archive, Windows MSI, Debian package, and RPM package.\n\nAdditionally, recipes support executing a script (either defined in a file or\ndirectly in this api) in bash, sh, cmd, and powershell.\n\nUpdating a software recipe\n\nIf a recipe is assigned to an instance and there is a recipe with the same\nname but a lower version already installed and the assigned state\nof the recipe is `INSTALLED_KEEP_UPDATED`, then the recipe is updated to\nthe new version.\n\nScript Working Directories\n\nEach script or execution step is run in its own temporary directory which\nis deleted after completing the step.", + "description": "A software recipe is a set of instructions for installing and configuring a\npiece of software. It consists of a set of artifacts that are\ndownloaded, and a set of steps that install, configure, and/or update the\nsoftware.\n\nRecipes support installing and updating software from artifacts in the\nfollowing formats:\nZip archive, Tar archive, Windows MSI, Debian package, and RPM package.\n\nAdditionally, recipes support executing a script (either defined in a file or\ndirectly in this api) in bash, sh, cmd, and powershell.\n\nUpdating a software recipe\n\nIf a recipe is assigned to an instance and there is a recipe with the same\nname but a lower version already installed and the assigned state\nof the recipe is `UPDATED`, then the recipe is updated to\nthe new version.\n\nScript Working Directories\n\nEach script or execution step is run in its own temporary directory which\nis deleted after completing the step.", "id": "SoftwareRecipe", "properties": { "artifacts": { @@ -1662,7 +1662,7 @@ "type": "array" }, "desiredState": { - "description": "Default is INSTALLED. The desired state the agent should maintain for this\nrecipe.\n\nINSTALLED: The software recipe is installed on the instance but\n won't be updated to new versions.\nINSTALLED_KEEP_UPDATED: The software recipe is installed on the\n instance. The recipe is updated to a higher\n version, if a higher version of the recipe is\n assigned to this instance.\nREMOVE: Remove is unsupported for software recipes and attempts to\n create or update a recipe to the REMOVE state is rejected.", + "description": "Default is INSTALLED. The desired state the agent should maintain for this\nrecipe.\n\nINSTALLED: The software recipe is installed on the instance but\n won't be updated to new versions.\nUPDATED: The software recipe is installed on the instance. The recipe is\n updated to a higher version, if a higher version of the recipe is\n assigned to this instance.\nREMOVE: Remove is unsupported for software recipes and attempts to\n create or update a recipe to the REMOVE state is rejected.", "enum": [ "DESIRED_STATE_UNSPECIFIED", "INSTALLED", diff --git a/discovery/oslogin-v1.json b/discovery/oslogin-v1.json index f1c667b1bb6..a1241baeedb 100644 --- a/discovery/oslogin-v1.json +++ b/discovery/oslogin-v1.json @@ -306,7 +306,7 @@ } } }, - "revision": "20200419", + "revision": "20200504", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/oslogin-v1alpha.json b/discovery/oslogin-v1alpha.json index ef6d2bb1edf..6788265ff9d 100644 --- a/discovery/oslogin-v1alpha.json +++ b/discovery/oslogin-v1alpha.json @@ -334,7 +334,7 @@ } } }, - "revision": "20200419", + "revision": "20200504", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/oslogin-v1beta.json b/discovery/oslogin-v1beta.json index f4d7a37d24b..0ca40f221fd 100644 --- a/discovery/oslogin-v1beta.json +++ b/discovery/oslogin-v1beta.json @@ -314,7 +314,7 @@ } } }, - "revision": "20200419", + "revision": "20200504", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/pagespeedonline-v1.json b/discovery/pagespeedonline-v1.json deleted file mode 100644 index fa6fd11fd99..00000000000 --- a/discovery/pagespeedonline-v1.json +++ /dev/null @@ -1,419 +0,0 @@ -{ - "basePath": "/pagespeedonline/v1/", - "baseUrl": "https://www.googleapis.com/pagespeedonline/v1/", - "batchPath": "batch/pagespeedonline/v1", - "description": "Analyzes the performance of a web page and provides tailored suggestions to make that page faster.", - "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/speed/docs/insights/v1/getting_started", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/H-mP1siOMcJ4amcS_1sf_SI17Lk\"", - "icons": { - "x16": "https://www.google.com/images/icons/product/pagespeed-16.png", - "x32": "https://www.google.com/images/icons/product/pagespeed-32.png" - }, - "id": "pagespeedonline:v1", - "kind": "discovery#restDescription", - "name": "pagespeedonline", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "alt": { - "default": "json", - "description": "Data format for the response.", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", - "location": "query", - "type": "string" - }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "pagespeedapi": { - "methods": { - "runpagespeed": { - "description": "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.", - "httpMethod": "GET", - "id": "pagespeedonline.pagespeedapi.runpagespeed", - "parameterOrder": [ - "url" - ], - "parameters": { - "filter_third_party_resources": { - "default": "false", - "description": "Indicates if third party resources should be filtered out before PageSpeed analysis.", - "location": "query", - "type": "boolean" - }, - "locale": { - "description": "The locale used to localize formatted results", - "location": "query", - "pattern": "[a-zA-Z]+(_[a-zA-Z]+)?", - "type": "string" - }, - "rule": { - "description": "A PageSpeed rule to run; if none are given, all rules are run", - "location": "query", - "pattern": "[a-zA-Z]+", - "repeated": true, - "type": "string" - }, - "screenshot": { - "default": "false", - "description": "Indicates if binary data containing a screenshot should be included", - "location": "query", - "type": "boolean" - }, - "strategy": { - "description": "The analysis strategy to use", - "enum": [ - "desktop", - "mobile" - ], - "enumDescriptions": [ - "Fetch and analyze the URL for desktop browsers", - "Fetch and analyze the URL for mobile devices" - ], - "location": "query", - "type": "string" - }, - "url": { - "description": "The URL to fetch and analyze", - "location": "query", - "pattern": "(?i)http(s)?://.*", - "required": true, - "type": "string" - } - }, - "path": "runPagespeed", - "response": { - "$ref": "Result" - } - } - } - } - }, - "revision": "20191206", - "rootUrl": "https://www.googleapis.com/", - "schemas": { - "Result": { - "id": "Result", - "properties": { - "captchaResult": { - "description": "The captcha verify result", - "type": "string" - }, - "formattedResults": { - "description": "Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server.", - "properties": { - "locale": { - "description": "The locale of the formattedResults, e.g. \"en_US\".", - "type": "string" - }, - "ruleResults": { - "additionalProperties": { - "description": "The enum-like identifier for this rule. For instance \"EnableKeepAlive\" or \"AvoidCssImport\". Not localized.", - "properties": { - "localizedRuleName": { - "description": "Localized name of the rule, intended for presentation to a user.", - "type": "string" - }, - "ruleImpact": { - "description": "The impact (unbounded floating point value) that implementing the suggestions for this rule would have on making the page faster. Impact is comparable between rules to determine which rule's suggestions would have a higher or lower impact on making a page faster. For instance, if enabling compression would save 1MB, while optimizing images would save 500kB, the enable compression rule would have 2x the impact of the image optimization rule, all other things being equal.", - "format": "double", - "type": "number" - }, - "urlBlocks": { - "description": "List of blocks of URLs. Each block may contain a heading and a list of URLs. Each URL may optionally include additional details.", - "items": { - "properties": { - "header": { - "description": "Heading to be displayed with the list of URLs.", - "properties": { - "args": { - "description": "List of arguments for the format string.", - "items": { - "properties": { - "type": { - "description": "Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION.", - "type": "string" - }, - "value": { - "description": "Argument value, as a localized string.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "format": { - "description": "A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Minifying the following $1 resources would save a total of $2 bytes'.", - "type": "string" - } - }, - "type": "object" - }, - "urls": { - "description": "List of entries that provide information about URLs in the url block. Optional.", - "items": { - "properties": { - "details": { - "description": "List of entries that provide additional details about a single URL. Optional.", - "items": { - "properties": { - "args": { - "description": "List of arguments for the format string.", - "items": { - "properties": { - "type": { - "description": "Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION.", - "type": "string" - }, - "value": { - "description": "Argument value, as a localized string.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "format": { - "description": "A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Unnecessary metadata for this resource adds an additional $1 bytes to its download size'.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "result": { - "description": "A format string that gives information about the URL, and a list of arguments for that format string.", - "properties": { - "args": { - "description": "List of arguments for the format string.", - "items": { - "properties": { - "type": { - "description": "Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION.", - "type": "string" - }, - "value": { - "description": "Argument value, as a localized string.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "format": { - "description": "A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Minifying the resource at URL $1 can save $2 bytes'.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "description": "Dictionary of formatted rule results, with one entry for each PageSpeed rule instantiated and run by the server.", - "type": "object" - } - }, - "type": "object" - }, - "id": { - "description": "Canonicalized and final URL for the document, after following page redirects (if any).", - "type": "string" - }, - "invalidRules": { - "description": "List of rules that were specified in the request, but which the server did not know how to instantiate.", - "items": { - "type": "string" - }, - "type": "array" - }, - "kind": { - "default": "pagespeedonline#result", - "description": "Kind of result.", - "type": "string" - }, - "pageStats": { - "description": "Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.", - "properties": { - "cssResponseBytes": { - "description": "Number of uncompressed response bytes for CSS resources on the page.", - "format": "int64", - "type": "string" - }, - "flashResponseBytes": { - "description": "Number of response bytes for flash resources on the page.", - "format": "int64", - "type": "string" - }, - "htmlResponseBytes": { - "description": "Number of uncompressed response bytes for the main HTML document and all iframes on the page.", - "format": "int64", - "type": "string" - }, - "imageResponseBytes": { - "description": "Number of response bytes for image resources on the page.", - "format": "int64", - "type": "string" - }, - "javascriptResponseBytes": { - "description": "Number of uncompressed response bytes for JS resources on the page.", - "format": "int64", - "type": "string" - }, - "numberCssResources": { - "description": "Number of CSS resources referenced by the page.", - "format": "int32", - "type": "integer" - }, - "numberHosts": { - "description": "Number of unique hosts referenced by the page.", - "format": "int32", - "type": "integer" - }, - "numberJsResources": { - "description": "Number of JavaScript resources referenced by the page.", - "format": "int32", - "type": "integer" - }, - "numberResources": { - "description": "Number of HTTP resources loaded by the page.", - "format": "int32", - "type": "integer" - }, - "numberStaticResources": { - "description": "Number of static (i.e. cacheable) resources on the page.", - "format": "int32", - "type": "integer" - }, - "otherResponseBytes": { - "description": "Number of response bytes for other resources on the page.", - "format": "int64", - "type": "string" - }, - "textResponseBytes": { - "description": "Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page.", - "format": "int64", - "type": "string" - }, - "totalRequestBytes": { - "description": "Total size of all request bytes sent by the page.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "responseCode": { - "description": "Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.", - "format": "int32", - "type": "integer" - }, - "score": { - "description": "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.", - "format": "int32", - "type": "integer" - }, - "screenshot": { - "description": "Base64-encoded screenshot of the page that was analyzed.", - "properties": { - "data": { - "description": "Image data base64 encoded.", - "format": "byte", - "type": "string" - }, - "height": { - "description": "Height of screenshot in pixels.", - "format": "int32", - "type": "integer" - }, - "mime_type": { - "description": "Mime type of image data. E.g. \"image/jpeg\".", - "type": "string" - }, - "width": { - "description": "Width of screenshot in pixels.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "title": { - "description": "Title of the page, as displayed in the browser's title bar.", - "type": "string" - }, - "version": { - "description": "The version of PageSpeed used to generate these results.", - "properties": { - "major": { - "description": "The major version number of PageSpeed used to generate these results.", - "format": "int32", - "type": "integer" - }, - "minor": { - "description": "The minor version number of PageSpeed used to generate these results.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "servicePath": "pagespeedonline/v1/", - "title": "PageSpeed Insights API", - "version": "v1" -} \ No newline at end of file diff --git a/discovery/people-v1.json b/discovery/people-v1.json index 022c01364e2..b018809e92e 100644 --- a/discovery/people-v1.json +++ b/discovery/people-v1.json @@ -650,7 +650,7 @@ } } }, - "revision": "20200428", + "revision": "20200509", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/discovery/policytroubleshooter-v1.json b/discovery/policytroubleshooter-v1.json index 896a0af6884..eaafb5ecaf1 100644 --- a/discovery/policytroubleshooter-v1.json +++ b/discovery/policytroubleshooter-v1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20200322", + "revision": "20200509", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1AccessTuple": { @@ -424,7 +424,7 @@ "properties": { "condition": { "$ref": "GoogleTypeExpr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -441,7 +441,7 @@ "type": "object" }, "GoogleIamV1Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "GoogleIamV1Policy", "properties": { "auditConfigs": { @@ -464,7 +464,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/policytroubleshooter-v1beta.json b/discovery/policytroubleshooter-v1beta.json index a52e4d37f3b..a46b1329123 100644 --- a/discovery/policytroubleshooter-v1beta.json +++ b/discovery/policytroubleshooter-v1beta.json @@ -128,7 +128,7 @@ } } }, - "revision": "20200322", + "revision": "20200509", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1betaAccessTuple": { @@ -424,7 +424,7 @@ "properties": { "condition": { "$ref": "GoogleTypeExpr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -441,7 +441,7 @@ "type": "object" }, "GoogleIamV1Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "GoogleIamV1Policy", "properties": { "auditConfigs": { @@ -464,7 +464,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/poly-v1.json b/discovery/poly-v1.json index 51e68b87be5..b308e603e86 100644 --- a/discovery/poly-v1.json +++ b/discovery/poly-v1.json @@ -291,7 +291,7 @@ } } }, - "revision": "20200424", + "revision": "20200509", "rootUrl": "https://poly.googleapis.com/", "schemas": { "Asset": { diff --git a/discovery/prod_tt_sasportal-v1alpha1.json b/discovery/prod_tt_sasportal-v1alpha1.json index 9aaca8ba96a..6bac5e27942 100644 --- a/discovery/prod_tt_sasportal-v1alpha1.json +++ b/discovery/prod_tt_sasportal-v1alpha1.json @@ -1523,7 +1523,7 @@ } } }, - "revision": "20200502", + "revision": "20200511", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 63e331549f9..dad7da0b938 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -202,7 +202,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -291,7 +291,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy", "httpMethod": "POST", "id": "pubsub.projects.snapshots.setIamPolicy", @@ -320,7 +320,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions", "httpMethod": "POST", "id": "pubsub.projects.snapshots.testIamPermissions", @@ -472,7 +472,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -677,7 +677,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy", "httpMethod": "POST", "id": "pubsub.projects.subscriptions.setIamPolicy", @@ -706,7 +706,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions", "httpMethod": "POST", "id": "pubsub.projects.subscriptions.testIamPermissions", @@ -829,7 +829,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -947,7 +947,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy", "httpMethod": "POST", "id": "pubsub.projects.topics.setIamPolicy", @@ -976,7 +976,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions", "httpMethod": "POST", "id": "pubsub.projects.topics.testIamPermissions", @@ -1093,7 +1093,7 @@ } } }, - "revision": "20200403", + "revision": "20200427", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1116,7 +1116,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1356,7 +1356,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -1372,7 +1372,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1481,7 +1481,7 @@ "description": "If specified, Pub/Sub will generate and attach an OIDC JWT token as an\n`Authorization` header in the HTTP request for every pushed message." }, "pushEndpoint": { - "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".", + "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use `https://example.com/push`.", "type": "string" } }, @@ -1578,12 +1578,16 @@ }, "deadLetterPolicy": { "$ref": "DeadLetterPolicy", - "description": "A policy that specifies the conditions for dead lettering messages in\nthis subscription. If dead_letter_policy is not set, dead lettering\nis disabled.\n\nThe Cloud Pub/Sub service account associated with this subscriptions's\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Acknowledge() messages on this subscription.\nEXPERIMENTAL: This feature is part of a closed alpha release. This\nAPI might be changed in backward-incompatible ways and is not recommended\nfor production use. It is not subject to any SLA or deprecation policy." + "description": "A policy that specifies the conditions for dead lettering messages in\nthis subscription. If dead_letter_policy is not set, dead lettering\nis disabled.\n\nThe Cloud Pub/Sub service account associated with this subscriptions's\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Acknowledge() messages on this subscription." }, "expirationPolicy": { "$ref": "ExpirationPolicy", "description": "A policy that specifies the conditions for this subscription's expiration.\nA subscription is considered active as long as any connected subscriber is\nsuccessfully consuming messages from the subscription or is issuing\noperations on the subscription. If `expiration_policy` is not set, a\n*default policy* with `ttl` of 31 days will be used. The minimum allowed\nvalue for `expiration_policy.ttl` is 1 day." }, + "filter": { + "description": "An expression written in the Cloud Pub/Sub filter language. If non-empty,\nthen only `PubsubMessage`s whose `attributes` field matches the filter are\ndelivered on this subscription. If empty, then no messages are filtered\nout.\nEXPERIMENTAL: This feature is part of a closed alpha release. This\nAPI might be changed in backward-incompatible ways and is not recommended\nfor production use. It is not subject to any SLA or deprecation policy.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" diff --git a/discovery/pubsub-v1beta1a.json b/discovery/pubsub-v1beta1a.json index 2f9f978087a..b42dd6f2799 100644 --- a/discovery/pubsub-v1beta1a.json +++ b/discovery/pubsub-v1beta1a.json @@ -457,7 +457,7 @@ } } }, - "revision": "20200403", + "revision": "20200427", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/pubsub-v1beta2.json b/discovery/pubsub-v1beta2.json index 65bb4ad8a22..f37c33415b0 100644 --- a/discovery/pubsub-v1beta2.json +++ b/discovery/pubsub-v1beta2.json @@ -231,7 +231,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -378,7 +378,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy", "httpMethod": "POST", "id": "pubsub.projects.subscriptions.setIamPolicy", @@ -407,7 +407,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions", "httpMethod": "POST", "id": "pubsub.projects.subscriptions.testIamPermissions", @@ -530,7 +530,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -619,7 +619,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy", "httpMethod": "POST", "id": "pubsub.projects.topics.setIamPolicy", @@ -648,7 +648,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions", "httpMethod": "POST", "id": "pubsub.projects.topics.testIamPermissions", @@ -724,7 +724,7 @@ } } }, - "revision": "20200403", + "revision": "20200427", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -747,7 +747,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -896,7 +896,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -912,7 +912,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/recommender-v1beta1.json b/discovery/recommender-v1beta1.json index d4bbf06f350..67fb24d5664 100644 --- a/discovery/recommender-v1beta1.json +++ b/discovery/recommender-v1beta1.json @@ -374,7 +374,7 @@ } } }, - "revision": "20200411", + "revision": "20200502", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1beta1CostProjection": { diff --git a/discovery/remotebuildexecution-v1.json b/discovery/remotebuildexecution-v1.json index 38cfdb76126..7a764f030f1 100644 --- a/discovery/remotebuildexecution-v1.json +++ b/discovery/remotebuildexecution-v1.json @@ -307,7 +307,7 @@ } } }, - "revision": "20200429", + "revision": "20200505", "rootUrl": "https://remotebuildexecution.googleapis.com/", "schemas": { "BuildBazelRemoteExecutionV2Action": { @@ -1008,6 +1008,7 @@ "PERMISSION_DENIED", "INTERNAL", "ABORTED", + "FAILED_PRECONDITION", "CLEANUP_ERROR", "DOWNLOAD_INPUTS_ERROR", "UNKNOWN", @@ -1044,6 +1045,7 @@ "The command failed due to permission errors.", "The command failed because of some invariants expected by the underlying\nsystem have been broken. This usually indicates a bug wit the system.", "The command was aborted.", + "The command failed because the system is not in a state required for the\ncommand, e.g. the command inputs cannot be found on the server.", "The bot failed to do the cleanup, e.g. unable to delete the command\nworking directory or the command process.", "The bot failed to download the inputs.", "Unknown error.", @@ -1408,6 +1410,10 @@ "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale", "description": "The autoscale policy to apply on a pool." }, + "channel": { + "description": "Channel specifies the release channel of the pool.", + "type": "string" + }, "name": { "description": "WorkerPool resource name formatted as:\n`projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.\nname should not be populated when creating a worker pool since it is\nprovided in the `poolId` field.", "type": "string" diff --git a/discovery/remotebuildexecution-v1alpha.json b/discovery/remotebuildexecution-v1alpha.json index ffb57b23a5b..ad0f845eb7a 100644 --- a/discovery/remotebuildexecution-v1alpha.json +++ b/discovery/remotebuildexecution-v1alpha.json @@ -388,7 +388,7 @@ } } }, - "revision": "20200429", + "revision": "20200505", "rootUrl": "https://admin-remotebuildexecution.googleapis.com/", "schemas": { "BuildBazelRemoteExecutionV2Action": { @@ -1078,6 +1078,7 @@ "PERMISSION_DENIED", "INTERNAL", "ABORTED", + "FAILED_PRECONDITION", "CLEANUP_ERROR", "DOWNLOAD_INPUTS_ERROR", "UNKNOWN", @@ -1114,6 +1115,7 @@ "The command failed due to permission errors.", "The command failed because of some invariants expected by the underlying\nsystem have been broken. This usually indicates a bug wit the system.", "The command was aborted.", + "The command failed because the system is not in a state required for the\ncommand, e.g. the command inputs cannot be found on the server.", "The bot failed to do the cleanup, e.g. unable to delete the command\nworking directory or the command process.", "The bot failed to download the inputs.", "Unknown error.", @@ -1478,6 +1480,10 @@ "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale", "description": "The autoscale policy to apply on a pool." }, + "channel": { + "description": "Channel specifies the release channel of the pool.", + "type": "string" + }, "name": { "description": "WorkerPool resource name formatted as:\n`projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.\nname should not be populated when creating a worker pool since it is\nprovided in the `poolId` field.", "type": "string" diff --git a/discovery/remotebuildexecution-v2.json b/discovery/remotebuildexecution-v2.json index b4390f0c634..1fa991f0805 100644 --- a/discovery/remotebuildexecution-v2.json +++ b/discovery/remotebuildexecution-v2.json @@ -447,7 +447,7 @@ } } }, - "revision": "20200429", + "revision": "20200505", "rootUrl": "https://remotebuildexecution.googleapis.com/", "schemas": { "BuildBazelRemoteExecutionV2Action": { @@ -1537,6 +1537,7 @@ "PERMISSION_DENIED", "INTERNAL", "ABORTED", + "FAILED_PRECONDITION", "CLEANUP_ERROR", "DOWNLOAD_INPUTS_ERROR", "UNKNOWN", @@ -1573,6 +1574,7 @@ "The command failed due to permission errors.", "The command failed because of some invariants expected by the underlying\nsystem have been broken. This usually indicates a bug wit the system.", "The command was aborted.", + "The command failed because the system is not in a state required for the\ncommand, e.g. the command inputs cannot be found on the server.", "The bot failed to do the cleanup, e.g. unable to delete the command\nworking directory or the command process.", "The bot failed to download the inputs.", "Unknown error.", @@ -1937,6 +1939,10 @@ "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale", "description": "The autoscale policy to apply on a pool." }, + "channel": { + "description": "Channel specifies the release channel of the pool.", + "type": "string" + }, "name": { "description": "WorkerPool resource name formatted as:\n`projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.\nname should not be populated when creating a worker pool since it is\nprovided in the `poolId` field.", "type": "string" diff --git a/discovery/run-v1.json b/discovery/run-v1.json index fe2f801ecf4..3406ab7e99a 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -1769,7 +1769,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -1942,7 +1942,7 @@ } } }, - "revision": "20200415", + "revision": "20200505", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -2024,7 +2024,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -2528,27 +2528,6 @@ }, "type": "object" }, - "IntOrString": { - "description": "IntOrString is a type that can hold an int32 or a string. When used in\nJSON or YAML marshalling and unmarshalling, it produces or consumes the\ninner type. This allows you to have, for example, a JSON field that can\naccept a name or number.", - "id": "IntOrString", - "properties": { - "intVal": { - "description": "The int value.", - "format": "int32", - "type": "integer" - }, - "strVal": { - "description": "The string value.", - "type": "string" - }, - "type": { - "description": "The type of the value.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "KeyToPath": { "description": "Cloud Run fully managed: not supported\n\nCloud Run for Anthos: supported\n\nMaps a string key to a path within a volume.", "id": "KeyToPath", @@ -2993,7 +2972,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -3016,7 +2995,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -3610,8 +3589,9 @@ "type": "string" }, "port": { - "$ref": "IntOrString", - "description": "Cloud Run fully managed: not supported\n\nCloud Run for Anthos: supported\n\nNumber or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + "description": "Cloud Run fully managed: not supported\n\nCloud Run for Anthos: supported\n\nNumber or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.\n\nThis field is currently limited to integer types only because of proto's\ninability to properly support the IntOrString golang type.", + "format": "int32", + "type": "integer" } }, "type": "object" diff --git a/discovery/run-v1alpha1.json b/discovery/run-v1alpha1.json index bf212478a46..8b736db0763 100644 --- a/discovery/run-v1alpha1.json +++ b/discovery/run-v1alpha1.json @@ -3027,7 +3027,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -3358,7 +3358,7 @@ } } }, - "revision": "20200415", + "revision": "20200505", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -3444,7 +3444,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -5129,7 +5129,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -5152,7 +5152,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/run-v1beta1.json b/discovery/run-v1beta1.json index 1cbf6ffc09e..ade3b9f48d0 100644 --- a/discovery/run-v1beta1.json +++ b/discovery/run-v1beta1.json @@ -296,7 +296,7 @@ } } }, - "revision": "20200415", + "revision": "20200505", "rootUrl": "https://run.googleapis.com/", "schemas": { "CustomResourceColumnDefinition": { diff --git a/discovery/runtimeconfig-v1.json b/discovery/runtimeconfig-v1.json index 98119cee12f..46de19fe411 100644 --- a/discovery/runtimeconfig-v1.json +++ b/discovery/runtimeconfig-v1.json @@ -210,7 +210,7 @@ } } }, - "revision": "20200413", + "revision": "20200512", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/runtimeconfig-v1beta1.json b/discovery/runtimeconfig-v1beta1.json index 48832cfb435..6a8068f569c 100644 --- a/discovery/runtimeconfig-v1beta1.json +++ b/discovery/runtimeconfig-v1beta1.json @@ -208,7 +208,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -805,7 +805,7 @@ } } }, - "revision": "20200413", + "revision": "20200504", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "Binding": { @@ -814,7 +814,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -976,7 +976,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -992,7 +992,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/sasportal-v1alpha1.json b/discovery/sasportal-v1alpha1.json index c2839445278..d602e04e95e 100644 --- a/discovery/sasportal-v1alpha1.json +++ b/discovery/sasportal-v1alpha1.json @@ -1522,7 +1522,7 @@ } } }, - "revision": "20200502", + "revision": "20200511", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/discovery/searchconsole-v1.json b/discovery/searchconsole-v1.json index e83bbb9109f..b7db0a805e5 100644 --- a/discovery/searchconsole-v1.json +++ b/discovery/searchconsole-v1.json @@ -120,7 +120,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "BlockedResource": { diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index 3ab005a6c79..6cbd143e38b 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20200415", + "revision": "20200509", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -816,7 +816,7 @@ "type": "object" }, "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing, `consumer_destinations` is the only supported destination and\nthe monitored resources need at least one label key\n`cloud.googleapis.com/location` to indicate the location of the billing\nusage, using different monitored resources between monitoring and billing is\nrecommended so they can be evolved independently:\n\n\n monitored_resources:\n - type: library.googleapis.com/billing_branch\n labels:\n - key: cloud.googleapis.com/location\n description: |\n Predefined label to support billing location restriction.\n - key: city\n description: |\n Custom label to define the city where the library branch is located\n in.\n - key: name\n description: Custom label to define the name of the library branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n unit: \"1\"\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/billing_branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "id": "Billing", "properties": { "consumerDestinations": { diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index 66b51823ee1..221463f45d5 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -437,7 +437,7 @@ } } }, - "revision": "20200415", + "revision": "20200509", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -662,7 +662,7 @@ "type": "object" }, "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing, `consumer_destinations` is the only supported destination and\nthe monitored resources need at least one label key\n`cloud.googleapis.com/location` to indicate the location of the billing\nusage, using different monitored resources between monitoring and billing is\nrecommended so they can be evolved independently:\n\n\n monitored_resources:\n - type: library.googleapis.com/billing_branch\n labels:\n - key: cloud.googleapis.com/location\n description: |\n Predefined label to support billing location restriction.\n - key: city\n description: |\n Custom label to define the city where the library branch is located\n in.\n - key: name\n description: Custom label to define the name of the library branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n unit: \"1\"\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/billing_branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "id": "Billing", "properties": { "consumerDestinations": { diff --git a/discovery/servicecontrol-v1.json b/discovery/servicecontrol-v1.json index e19ff79cd45..beb04bd94bc 100644 --- a/discovery/servicecontrol-v1.json +++ b/discovery/servicecontrol-v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20200420", + "revision": "20200504", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { diff --git a/discovery/servicedirectory-v1beta1.json b/discovery/servicedirectory-v1beta1.json index ac80c2f80c7..bf74ef4829d 100644 --- a/discovery/servicedirectory-v1beta1.json +++ b/discovery/servicedirectory-v1beta1.json @@ -883,7 +883,7 @@ } } }, - "revision": "20200415", + "revision": "20200429", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { @@ -892,7 +892,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -980,7 +980,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1112,7 +1112,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { @@ -1128,7 +1128,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index e3d8e894b79..de6bddc93da 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -443,7 +443,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/services/{servicesId}:setIamPolicy", "httpMethod": "POST", "id": "servicemanagement.services.setIamPolicy", @@ -472,7 +472,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/services/{servicesId}:testIamPermissions", "httpMethod": "POST", "id": "servicemanagement.services.testIamPermissions", @@ -704,7 +704,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy", "httpMethod": "POST", "id": "servicemanagement.services.consumers.setIamPolicy", @@ -733,7 +733,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions", "httpMethod": "POST", "id": "servicemanagement.services.consumers.testIamPermissions", @@ -877,7 +877,7 @@ } } }, - "revision": "20200411", + "revision": "20200506", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1161,7 +1161,7 @@ "type": "object" }, "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing, `consumer_destinations` is the only supported destination and\nthe monitored resources need at least one label key\n`cloud.googleapis.com/location` to indicate the location of the billing\nusage, using different monitored resources between monitoring and billing is\nrecommended so they can be evolved independently:\n\n\n monitored_resources:\n - type: library.googleapis.com/billing_branch\n labels:\n - key: cloud.googleapis.com/location\n description: |\n Predefined label to support billing location restriction.\n - key: city\n description: |\n Custom label to define the city where the library branch is located\n in.\n - key: name\n description: Custom label to define the name of the library branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n unit: \"1\"\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/billing_branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "id": "Billing", "properties": { "consumerDestinations": { @@ -1198,7 +1198,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1872,7 +1872,7 @@ "properties": { "options": { "$ref": "GetPolicyOptions", - "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM." + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`." } }, "type": "object" @@ -1882,7 +1882,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -2601,7 +2601,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -2624,7 +2624,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -2928,7 +2928,7 @@ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." }, "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/servicenetworking-v1.json b/discovery/servicenetworking-v1.json index 7aaec604673..1ea13977d97 100644 --- a/discovery/servicenetworking-v1.json +++ b/discovery/servicenetworking-v1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20200415", + "revision": "20200509", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddRolesMetadata": { @@ -834,7 +834,7 @@ "type": "object" }, "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing, `consumer_destinations` is the only supported destination and\nthe monitored resources need at least one label key\n`cloud.googleapis.com/location` to indicate the location of the billing\nusage, using different monitored resources between monitoring and billing is\nrecommended so they can be evolved independently:\n\n\n monitored_resources:\n - type: library.googleapis.com/billing_branch\n labels:\n - key: cloud.googleapis.com/location\n description: |\n Predefined label to support billing location restriction.\n - key: city\n description: |\n Custom label to define the city where the library branch is located\n in.\n - key: name\n description: Custom label to define the name of the library branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n unit: \"1\"\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/billing_branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "id": "Billing", "properties": { "consumerDestinations": { diff --git a/discovery/servicenetworking-v1beta.json b/discovery/servicenetworking-v1beta.json index 30e2639f974..883b96459ca 100644 --- a/discovery/servicenetworking-v1beta.json +++ b/discovery/servicenetworking-v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20200415", + "revision": "20200509", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddRolesMetadata": { @@ -595,7 +595,7 @@ "type": "object" }, "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing, `consumer_destinations` is the only supported destination and\nthe monitored resources need at least one label key\n`cloud.googleapis.com/location` to indicate the location of the billing\nusage, using different monitored resources between monitoring and billing is\nrecommended so they can be evolved independently:\n\n\n monitored_resources:\n - type: library.googleapis.com/billing_branch\n labels:\n - key: cloud.googleapis.com/location\n description: |\n Predefined label to support billing location restriction.\n - key: city\n description: |\n Custom label to define the city where the library branch is located\n in.\n - key: name\n description: Custom label to define the name of the library branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n unit: \"1\"\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/billing_branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "id": "Billing", "properties": { "consumerDestinations": { diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index 266171d6818..83603261ee2 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -275,7 +275,7 @@ ], "parameters": { "names": { - "description": "Names of the services to retrieve.\n\nAn example name would be:\n`projects/123/services/serviceusage.googleapis.com` where `123` is the\nproject number.\nA single request can get a maximum of 20 services at a time.", + "description": "Names of the services to retrieve.\n\nAn example name would be:\n`projects/123/services/serviceusage.googleapis.com` where `123` is the\nproject number.\nA single request can get a maximum of 30 services at a time.", "location": "query", "repeated": true, "type": "string" @@ -426,7 +426,7 @@ } } }, - "revision": "20200415", + "revision": "20200509", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "Api": { @@ -728,7 +728,7 @@ "type": "object" }, "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing, `consumer_destinations` is the only supported destination and\nthe monitored resources need at least one label key\n`cloud.googleapis.com/location` to indicate the location of the billing\nusage, using different monitored resources between monitoring and billing is\nrecommended so they can be evolved independently:\n\n\n monitored_resources:\n - type: library.googleapis.com/billing_branch\n labels:\n - key: cloud.googleapis.com/location\n description: |\n Predefined label to support billing location restriction.\n - key: city\n description: |\n Custom label to define the city where the library branch is located\n in.\n - key: name\n description: Custom label to define the name of the library branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n unit: \"1\"\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/billing_branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "id": "Billing", "properties": { "consumerDestinations": { diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 38f04e47ad2..d36d9b0f2a9 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -764,7 +764,7 @@ } } }, - "revision": "20200415", + "revision": "20200509", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "Api": { @@ -1052,7 +1052,7 @@ "type": "object" }, "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing, `consumer_destinations` is the only supported destination and\nthe monitored resources need at least one label key\n`cloud.googleapis.com/location` to indicate the location of the billing\nusage, using different monitored resources between monitoring and billing is\nrecommended so they can be evolved independently:\n\n\n monitored_resources:\n - type: library.googleapis.com/billing_branch\n labels:\n - key: cloud.googleapis.com/location\n description: |\n Predefined label to support billing location restriction.\n - key: city\n description: |\n Custom label to define the city where the library branch is located\n in.\n - key: name\n description: Custom label to define the name of the library branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n unit: \"1\"\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/billing_branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "id": "Billing", "properties": { "consumerDestinations": { diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json index d65631a2e91..459463625c4 100644 --- a/discovery/sheets-v4.json +++ b/discovery/sheets-v4.json @@ -810,7 +810,7 @@ } } }, - "revision": "20200428", + "revision": "20200508", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -3526,7 +3526,7 @@ "Corresponds to the `#VALUE!` error.", "Corresponds to the `#REF!` error.", "Corresponds to the `#NAME?` error.", - "Corresponds to the `#NUM`! error.", + "Corresponds to the `#NUM!` error.", "Corresponds to the `#N/A` error.", "Corresponds to the `Loading...` state." ], diff --git a/discovery/slides-v1.json b/discovery/slides-v1.json index f290c6ac327..d6bebce6819 100644 --- a/discovery/slides-v1.json +++ b/discovery/slides-v1.json @@ -304,7 +304,7 @@ } } }, - "revision": "20200429", + "revision": "20200508", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index a1d49c857d3..a2df35ad8a2 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -1895,7 +1895,7 @@ } } }, - "revision": "20200409", + "revision": "20200508", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "Backup": { @@ -2411,7 +2411,7 @@ "properties": { "options": { "$ref": "GetPolicyOptions", - "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM." + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`." } }, "type": "object" diff --git a/discovery/speech-v1.json b/discovery/speech-v1.json index 084715cea04..35d62eeae19 100644 --- a/discovery/speech-v1.json +++ b/discovery/speech-v1.json @@ -290,7 +290,7 @@ } } }, - "revision": "20200421", + "revision": "20200502", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ListOperationsResponse": { diff --git a/discovery/speech-v1p1beta1.json b/discovery/speech-v1p1beta1.json index c7c1480c2f4..503d5e2dc19 100644 --- a/discovery/speech-v1p1beta1.json +++ b/discovery/speech-v1p1beta1.json @@ -290,7 +290,7 @@ } } }, - "revision": "20200421", + "revision": "20200502", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ClassItem": { @@ -309,7 +309,7 @@ "id": "CustomClass", "properties": { "customClassId": { - "description": "If this custom class is a resource, the custom_class_id is the resource id\nof the CustomClass.", + "description": "If this custom class is a resource, the custom_class_id is the resource id\nof the CustomClass. Case sensitive.", "type": "string" }, "items": { @@ -435,7 +435,7 @@ "type": "object" }, "Phrase": { - "description": "A phrases containing words and phrase \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech-to-text/quotas#content).\n\nList items can also include pre-built or custom classes containing groups\nof words that represent common concepts that occur in natural language. For\nexample, rather than providing a phrase hint for every month of the\nyear (e.g. \"i was born in january\", \"i was born in febuary\", ...), use the\npre-built $MONTH class improves the likelihood of correctly transcribing\naudio that includes months (e.g. \"i was born in $month\").\nTo refer to pre-built classes, use the class' symbol prepended with $ e.g.\n$MONTH. To refer to custom classes that were defined inline in the request,\nset the class's `custom_class_id` to a string unique to all class resources\nand inline classes. Then use the class' id wrapped in ${...} e.g.\n\"${my-months}\". To refer to custom classes resources, use the class' id\nwrapped in ${} (e.g.\n${my-months}).", + "description": "A phrases containing words and phrase \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech-to-text/quotas#content).\n\nList items can also include pre-built or custom classes containing groups\nof words that represent common concepts that occur in natural language. For\nexample, rather than providing a phrase hint for every month of the\nyear (e.g. \"i was born in january\", \"i was born in febuary\", ...), use the\npre-built `$MONTH` class improves the likelihood of correctly transcribing\naudio that includes months (e.g. \"i was born in $month\").\nTo refer to pre-built classes, use the class' symbol prepended with `$`\ne.g. `$MONTH`. To refer to custom classes that were defined inline in the\nrequest, set the class's `custom_class_id` to a string unique to all class\nresources and inline classes. Then use the class' id wrapped in $`{...}`\ne.g. \"${my-months}\". To refer to custom classes resources, use the class'\nid wrapped in `${}` (e.g. `${my-months}`).", "id": "Phrase", "properties": { "boost": { diff --git a/discovery/speech-v2beta1.json b/discovery/speech-v2beta1.json index a916d8cce4d..bbdb57981c4 100644 --- a/discovery/speech-v2beta1.json +++ b/discovery/speech-v2beta1.json @@ -184,7 +184,7 @@ } } }, - "revision": "20200421", + "revision": "20200502", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ListOperationsResponse": { diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index f7ffc6826e7..70b5a16d8b0 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -26,7 +26,7 @@ "description": "Stores and retrieves potentially large, immutable data objects.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/storage/docs/json_api/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/ZrOuv2jlHS6Z6zwtpAqNzM6FbAU\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/SMGMLKKvE-TZrla7d9TA_SDVTI0\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -3229,7 +3229,7 @@ } } }, - "revision": "20200410", + "revision": "20200430", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { @@ -3415,6 +3415,11 @@ "format": "int32", "type": "integer" }, + "daysSinceNoncurrentTime": { + "description": "Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.", + "format": "int32", + "type": "integer" + }, "isLive": { "description": "Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.", "type": "boolean" @@ -3430,6 +3435,11 @@ }, "type": "array" }, + "noncurrentTimeBefore": { + "description": "A timestamp in RFC 3339 format. This condition is satisfied when the noncurrent time on an object is before this timestamp. This condition is relevant only for versioned objects.", + "format": "date-time", + "type": "string" + }, "numNewerVersions": { "description": "Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.", "format": "int32", diff --git a/discovery/storage-v1beta2.json b/discovery/storage-v1beta2.json index 93bd9370772..3fd032576b2 100644 --- a/discovery/storage-v1beta2.json +++ b/discovery/storage-v1beta2.json @@ -20,7 +20,7 @@ "description": "Lets you store and retrieve potentially-large, immutable data objects.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/storage/docs/json_api/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/X18fNo383RxkAXqftDi0nQCAj_Q\"", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/Ei3kXNBXlSAW2eI6GcaBEFRJ8mk\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -1677,7 +1677,7 @@ } } }, - "revision": "20200410", + "revision": "20200430", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { diff --git a/discovery/storagetransfer-v1.json b/discovery/storagetransfer-v1.json index 0e5e8156c5d..bb4ec31c106 100644 --- a/discovery/storagetransfer-v1.json +++ b/discovery/storagetransfer-v1.json @@ -396,7 +396,7 @@ } } }, - "revision": "20200411", + "revision": "20200507", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AwsAccessKey": { diff --git a/discovery/streetviewpublish-v1.json b/discovery/streetviewpublish-v1.json index 785469c70fd..ed6ffe08120 100644 --- a/discovery/streetviewpublish-v1.json +++ b/discovery/streetviewpublish-v1.json @@ -363,7 +363,7 @@ } } }, - "revision": "20200502", + "revision": "20200511", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/discovery/tagmanager-v1.json b/discovery/tagmanager-v1.json index 7e692a94000..75663efc6c9 100644 --- a/discovery/tagmanager-v1.json +++ b/discovery/tagmanager-v1.json @@ -28,7 +28,7 @@ }, "basePath": "", "baseUrl": "https://www.googleapis.com/", - "batchPath": "batch", + "batchPath": "batch/tagmanager/v1", "canonicalName": "Tag Manager", "description": "This API allows clients to access and modify container and tag\n configuration.", "discoveryVersion": "v1", @@ -1932,7 +1932,7 @@ } } }, - "revision": "20200429", + "revision": "20200506", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/tagmanager-v2.json b/discovery/tagmanager-v2.json index 9a22cf63ee6..5a6bde13797 100644 --- a/discovery/tagmanager-v2.json +++ b/discovery/tagmanager-v2.json @@ -28,7 +28,7 @@ }, "basePath": "", "baseUrl": "https://www.googleapis.com/", - "batchPath": "batch", + "batchPath": "batch/tagmanager/v2", "canonicalName": "Tag Manager", "description": "This API allows clients to access and modify container and tag\n configuration.", "discoveryVersion": "v1", @@ -2789,7 +2789,7 @@ } } }, - "revision": "20200429", + "revision": "20200506", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/testing-v1.json b/discovery/testing-v1.json index 1088f0035dd..2abd077a17f 100644 --- a/discovery/testing-v1.json +++ b/discovery/testing-v1.json @@ -273,7 +273,7 @@ } } }, - "revision": "20200429", + "revision": "20200509", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/texttospeech-v1.json b/discovery/texttospeech-v1.json index e434818e6f9..6640c457db5 100644 --- a/discovery/texttospeech-v1.json +++ b/discovery/texttospeech-v1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20200417", + "revision": "20200501", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/discovery/texttospeech-v1beta1.json b/discovery/texttospeech-v1beta1.json index 0465a728df5..ac95d907b75 100644 --- a/discovery/texttospeech-v1beta1.json +++ b/discovery/texttospeech-v1beta1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20200417", + "revision": "20200501", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/discovery/toolresults-v1beta3.json b/discovery/toolresults-v1beta3.json index f37bb2fb220..e46aa598d51 100644 --- a/discovery/toolresults-v1beta3.json +++ b/discovery/toolresults-v1beta3.json @@ -10,7 +10,7 @@ }, "basePath": "", "baseUrl": "https://www.googleapis.com/", - "batchPath": "batch", + "batchPath": "batch/toolresults/v1beta3", "canonicalName": "Tool Results", "description": "API to publish and access results from developer tools.", "discoveryVersion": "v1", @@ -1446,7 +1446,7 @@ } } }, - "revision": "20200430", + "revision": "20200512", "rootUrl": "https://www.googleapis.com/", "schemas": { "ANR": { diff --git a/discovery/translate-v3.json b/discovery/translate-v3.json index 76d7d9235a1..c526bb991b4 100644 --- a/discovery/translate-v3.json +++ b/discovery/translate-v3.json @@ -687,7 +687,7 @@ } } }, - "revision": "20200417", + "revision": "20200508", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchTranslateTextRequest": { diff --git a/discovery/translate-v3beta1.json b/discovery/translate-v3beta1.json index b5c3933f727..d61d4d4a35c 100644 --- a/discovery/translate-v3beta1.json +++ b/discovery/translate-v3beta1.json @@ -687,7 +687,7 @@ } } }, - "revision": "20200417", + "revision": "20200508", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchTranslateTextRequest": { diff --git a/discovery/vault-v1.json b/discovery/vault-v1.json index 15f1fbb5330..c939c7886c9 100644 --- a/discovery/vault-v1.json +++ b/discovery/vault-v1.json @@ -1051,7 +1051,7 @@ } } }, - "revision": "20200430", + "revision": "20200501", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountInfo": { @@ -1159,7 +1159,7 @@ "id": "CloudStorageFile", "properties": { "bucketName": { - "description": "The cloud storage bucket name of this export file.\nCan be used in cloud storage JSON/XML API.", + "description": "The cloud storage bucket name of this export file.\nCan be used in cloud storage JSON/XML API, but not to list the bucket\ncontents. Instead, you can \nget individual export files by object name.", "type": "string" }, "md5Hash": { diff --git a/discovery/youtubeAnalytics-v1.json b/discovery/youtubeAnalytics-v1.json index d15661db7b2..e9647de2cfc 100644 --- a/discovery/youtubeAnalytics-v1.json +++ b/discovery/youtubeAnalytics-v1.json @@ -96,7 +96,7 @@ }, "protocol": "rest", "resources": {}, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://youtubeanalytics.googleapis.com/", "schemas": {}, "servicePath": "", diff --git a/discovery/youtubeAnalytics-v2.json b/discovery/youtubeAnalytics-v2.json index b290bf7726f..3f1176845d9 100644 --- a/discovery/youtubeAnalytics-v2.json +++ b/discovery/youtubeAnalytics-v2.json @@ -421,7 +421,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://youtubeanalytics.googleapis.com/", "schemas": { "EmptyResponse": { diff --git a/discovery/youtubereporting-v1.json b/discovery/youtubereporting-v1.json index 483f72d53f0..194e7248f89 100644 --- a/discovery/youtubereporting-v1.json +++ b/discovery/youtubereporting-v1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20200504", + "revision": "20200512", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { diff --git a/samples/test/test.samples.customsearch.js b/samples/test/test.samples.customsearch.js index f5bc58d2ab5..6df9573651a 100644 --- a/samples/test/test.samples.customsearch.js +++ b/samples/test/test.samples.customsearch.js @@ -23,7 +23,7 @@ const samples = { list: require('../customsearch/customsearch'), }; -const baseUrl = 'https://www.googleapis.com'; +const baseUrl = 'https://customsearch.googleapis.com'; describe('customsearch samples', () => { afterEach(() => { diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 99b158dc2b4..f058087c111 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -227,6 +227,10 @@ export namespace adexchangebuyer2_v2beta1 { * The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View). */ measurableImpressions?: Schema$MetricValue; + /** + * The number of bids that won the auction and also won the mediation waterfall (if any). + */ + reachedQueries?: Schema$MetricValue; /** * The values of all dimensions associated with metric values in this row. */ diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index fa4e98c0700..9dd6da4cdb7 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -256,6 +256,32 @@ export namespace bigquery_v2 { */ seasonalPeriods?: string[] | null; } + /** + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.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 | null; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.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[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } export interface Schema$BigQueryModelTraining { /** * [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. @@ -387,6 +413,23 @@ export namespace bigquery_v2 { */ truePositives?: string | null; } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 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@example.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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + */ + members?: string[] | null; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string | null; + } export interface Schema$BqmlIterationResult { /** * [Output-only, Beta] Time taken to run the training iteration in milliseconds. @@ -888,6 +931,27 @@ export namespace bigquery_v2 { */ substeps?: string[] | null; } + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * 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 | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * 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 | null; + } export interface Schema$ExternalDataConfiguration { /** * Try to detect schema and format options automatically. Any option specified explicitly will be honored. @@ -951,6 +1015,24 @@ export namespace bigquery_v2 { */ numericalValue?: number | null; } + /** + * Request message for `GetIamPolicy` method. + */ + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + requestedPolicyVersion?: number | null; + } export interface Schema$GetQueryResultsResponse { /** * Whether the query result was fetched from the query cache. @@ -1818,6 +1900,27 @@ export namespace bigquery_v2 { */ confusionMatrixList?: Schema$ConfusionMatrix[]; } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](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`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + */ + 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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + version?: number | null; + } export interface Schema$ProjectList { /** * A hash of the page of results @@ -2212,6 +2315,19 @@ export namespace bigquery_v2 { */ stackFrames?: Schema$ScriptStackFrame[]; } + /** + * 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"` + */ + updateMask?: string | null; + } /** * 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"}} ]}} */ @@ -2518,6 +2634,24 @@ export namespace bigquery_v2 { */ fields?: Schema$TableFieldSchema[]; } + /** + * 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[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } 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. @@ -7045,6 +7179,136 @@ export namespace bigquery_v2 { } } + /** + * bigquery.tables.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. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/bigquery.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const bigquery = google.bigquery('v2'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/bigquery.readonly', + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await bigquery.tables.getIamPolicy({ + * // 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/datasets/my-dataset/tables/my-table', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "options": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias bigquery.tables.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.requestBody 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$Tables$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Tables$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Tables$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Tables$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Tables$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tables$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/bigquery/v2/{+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); + } + } + /** * bigquery.tables.insert * @desc Creates a new, empty table in the dataset. @@ -7539,6 +7803,270 @@ export namespace bigquery_v2 { } } + /** + * bigquery.tables.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/bigquery.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const bigquery = google.bigquery('v2'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await bigquery.tables.setIamPolicy({ + * // 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/datasets/my-dataset/tables/my-table', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias bigquery.tables.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.requestBody 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$Tables$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Tables$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Tables$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Tables$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Tables$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tables$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/bigquery/v2/{+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); + } + } + + /** + * bigquery.tables.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. + * @example + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/bigquery.googleapis.com + * // - Login into gcloud by running: + * // `$ gcloud auth application-default login` + * // - Install the npm module by running: + * // `$ npm install googleapis` + * + * const {google} = require('googleapis'); + * const bigquery = google.bigquery('v2'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/bigquery.readonly', + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options('auth', authClient); + * + * // Do the magic + * const res = await bigquery.tables.testIamPermissions({ + * // 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/datasets/my-dataset/tables/my-table', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * @alias bigquery.tables.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.requestBody 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$Tables$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Tables$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Tables$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Tables$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Tables$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tables$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/bigquery/v2/{+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); + } + } + /** * 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. @@ -7765,6 +8293,23 @@ export namespace bigquery_v2 { */ tableId?: string; } + export interface Params$Resource$Tables$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$Tables$Insert extends StandardParameters { /** * Auth client or API Key for the request @@ -7832,6 +8377,40 @@ export namespace bigquery_v2 { */ requestBody?: Schema$Table; } + export interface Params$Resource$Tables$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$Tables$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$Tables$Update extends StandardParameters { /** * Auth client or API Key for the request diff --git a/src/apis/bigqueryconnection/v1beta1.ts b/src/apis/bigqueryconnection/v1beta1.ts index 9b6b684988c..d34e3f9b3ca 100644 --- a/src/apis/bigqueryconnection/v1beta1.ts +++ b/src/apis/bigqueryconnection/v1beta1.ts @@ -144,7 +144,7 @@ export namespace bigqueryconnection_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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -271,7 +271,7 @@ export namespace bigqueryconnection_v1beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -289,7 +289,7 @@ export namespace bigqueryconnection_v1beta1 { nextPageToken?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -305,7 +305,7 @@ export namespace bigqueryconnection_v1beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index b6835955814..8129e95ee7f 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -865,7 +865,7 @@ export namespace bigtableadmin_v2 { * // Do the magic * const res = await bigtableadmin.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'operations/.+', + * name: 'operations/.*', * }); * console.log(res.data); * @@ -980,7 +980,7 @@ export namespace bigtableadmin_v2 { * // Do the magic * const res = await bigtableadmin.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'operations/.+', + * name: 'operations/.*', * }); * console.log(res.data); * @@ -1096,7 +1096,7 @@ export namespace bigtableadmin_v2 { * // Do the magic * const res = await bigtableadmin.operations.get({ * // The name of the operation resource. - * name: 'operations/.+', + * name: 'operations/.*', * }); * console.log(res.data); * @@ -1275,7 +1275,7 @@ export namespace bigtableadmin_v2 { * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'operations/projects/.+', + * name: 'operations/projects/.*', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -4308,7 +4308,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.clusters.backups.getIamPolicy - * @desc Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set. + * @desc Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set. * @example * // Before running the sample: * // - Enable the API at: @@ -4443,7 +4443,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.clusters.backups.setIamPolicy - * @desc Sets the access control policy on a Table or Backup resource. Replaces any existing policy. + * @desc Sets the access control policy on a Table resource. Replaces any existing policy. * @example * // Before running the sample: * // - Enable the API at: @@ -5561,7 +5561,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.getIamPolicy - * @desc Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set. + * @desc Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set. * @example * // Before running the sample: * // - Enable the API at: @@ -5970,7 +5970,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.setIamPolicy - * @desc Sets the access control policy on a Table or Backup resource. Replaces any existing policy. + * @desc Sets the access control policy on a Table resource. Replaces any existing policy. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 9b67049a962..70fa57959f7 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -500,7 +500,15 @@ export namespace chat_v1 { */ name?: string | null; /** - * Output only. The type of a space. + * Whether the space is a DM between a bot and a single human. + */ + singleUserBotDm?: boolean | null; + /** + * Whether the messages are threaded in this space. + */ + threaded?: boolean | null; + /** + * Output only. The type of a space. This is deprecated. Use `single_user_bot_dm` instead. */ type?: string | null; } @@ -636,6 +644,8 @@ export namespace chat_v1 { * // { * // "displayName": "my_displayName", * // "name": "my_name", + * // "singleUserBotDm": false, + * // "threaded": false, * // "type": "my_type" * // } * } diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index d4e5cd51055..1765eea0585 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -576,7 +576,7 @@ export namespace cloudbuild_v1 { */ branch?: string | null; /** - * Whether to block builds on a "/gcbrun" comment from a repository admin or collaborator. + * Configure builds to run only when a repository owner or collaborator comments `/gcbrun`. */ commentControl?: string | null; /** diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 7f768c5320e..c7dd2217d1f 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -146,7 +146,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -512,7 +512,7 @@ export namespace cloudfunctions_v1 { versionId?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -528,7 +528,7 @@ export namespace cloudfunctions_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -545,7 +545,7 @@ export namespace cloudfunctions_v1 { */ 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"` */ updateMask?: string | null; } @@ -1878,6 +1878,10 @@ export namespace cloudfunctions_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -1903,7 +1907,7 @@ export namespace cloudfunctions_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -2616,7 +2620,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index afacfc58126..e782dd8828a 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -494,6 +494,19 @@ export namespace cloudidentity_v1beta1 { */ updateTime?: string | null; } + /** + * Response message that is returned in LRO result of ListClientStates Operation. + */ + export interface Schema$ListClientStatesResponse { + /** + * Client states meeting the list restrictions. + */ + clientStates?: Schema$ClientState[]; + /** + * Token to retrieve the next page of results. Empty if there are no more results. + */ + nextPageToken?: string | null; + } /** * Response message that is returned in LRO result of ListDevices Operation. */ diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index b250a838429..762a1062d95 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -161,7 +161,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -332,7 +332,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -574,7 +574,7 @@ export namespace cloudresourcemanager_v1 { version?: number | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -590,7 +590,7 @@ export namespace cloudresourcemanager_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 82f2d66bd95..6b1fe926edc 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -155,7 +155,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -249,7 +249,7 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -318,7 +318,7 @@ export namespace cloudresourcemanager_v1beta1 { directoryCustomerId?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -334,7 +334,7 @@ export namespace cloudresourcemanager_v1beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 6ac308c076d..3b4e1a1364c 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -146,7 +146,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -248,7 +248,7 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -300,7 +300,7 @@ export namespace cloudresourcemanager_v2 { response?: {[key: string]: any} | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -316,7 +316,7 @@ export namespace cloudresourcemanager_v2 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 022df338391..a914328b924 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -146,7 +146,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -248,7 +248,7 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -300,7 +300,7 @@ export namespace cloudresourcemanager_v2beta1 { response?: {[key: string]: any} | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -316,7 +316,7 @@ export namespace cloudresourcemanager_v2beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 0f974e2fad6..4a677fe231a 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -185,7 +185,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -249,7 +249,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -377,7 +377,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$PauseQueueRequest {} /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -389,7 +389,7 @@ export namespace cloudtasks_v2 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 1ce29776ca0..2d8a328716a 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -203,7 +203,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -280,7 +280,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -383,7 +383,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$PauseQueueRequest {} /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -395,7 +395,7 @@ export namespace cloudtasks_v2beta2 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 0fa95e0b69a..5bedc33a549 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -194,7 +194,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -258,7 +258,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -386,7 +386,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$PauseQueueRequest {} /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -398,7 +398,7 @@ export namespace cloudtasks_v2beta3 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/commentanalyzer/README.md b/src/apis/commentanalyzer/README.md deleted file mode 100644 index 4cb8e6d1530..00000000000 --- a/src/apis/commentanalyzer/README.md +++ /dev/null @@ -1,47 +0,0 @@ -Google Inc. logo - -# commentanalyzer - -> 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. - -## 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/commentanalyzer -$ npm install -$ npm run webpack -``` - -The generated bundle will be written to `dist/commentanalyzer.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/commentanalyzer/index.ts b/src/apis/commentanalyzer/index.ts deleted file mode 100644 index 70587c6e0da..00000000000 --- a/src/apis/commentanalyzer/index.ts +++ /dev/null @@ -1,37 +0,0 @@ -// Copyright 2020 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 {commentanalyzer_v1alpha1} from './v1alpha1'; - -export const VERSIONS = { - v1alpha1: commentanalyzer_v1alpha1.Commentanalyzer, -}; - -export function commentanalyzer( - version: 'v1alpha1' -): commentanalyzer_v1alpha1.Commentanalyzer; -export function commentanalyzer( - options: commentanalyzer_v1alpha1.Options -): commentanalyzer_v1alpha1.Commentanalyzer; -export function commentanalyzer( - this: GoogleConfigurable, - versionOrOptions: 'v1alpha1' | commentanalyzer_v1alpha1.Options -) { - return getAPI('commentanalyzer', versionOrOptions, VERSIONS, this); -} - -const auth = new AuthPlus(); -export {auth}; diff --git a/src/apis/commentanalyzer/package.json b/src/apis/commentanalyzer/package.json deleted file mode 100644 index e3dca52129c..00000000000 --- a/src/apis/commentanalyzer/package.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "name": "@google/commentanalyzer", - "version": "0.1.0", - "description": "commentanalyzer", - "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": ">=10.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": "^4.1.0" - }, - "devDependencies": { - "gts": "^2.0.0", - "null-loader": "^4.0.0", - "ts-loader": "^7.0.0", - "typedoc": "^0.17.0", - "typescript": "~3.7.0", - "webpack": "^4.35.3", - "webpack-cli": "^3.3.5" - } -} diff --git a/src/apis/commentanalyzer/tsconfig.json b/src/apis/commentanalyzer/tsconfig.json deleted file mode 100644 index e0810904968..00000000000 --- a/src/apis/commentanalyzer/tsconfig.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "extends": "./node_modules/gts/tsconfig-google.json", - "compilerOptions": { - "rootDir": ".", - "outDir": "build" - }, - "include": [ - "*.ts", - ] -} diff --git a/src/apis/commentanalyzer/v1alpha1.ts b/src/apis/commentanalyzer/v1alpha1.ts deleted file mode 100644 index 03728656ca9..00000000000 --- a/src/apis/commentanalyzer/v1alpha1.ts +++ /dev/null @@ -1,620 +0,0 @@ -// Copyright 2020 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. - -/* eslint-disable @typescript-eslint/no-explicit-any */ -/* eslint-disable @typescript-eslint/class-name-casing */ -/* eslint-disable @typescript-eslint/no-unused-vars */ -/* eslint-disable @typescript-eslint/no-empty-interface */ -/* eslint-disable @typescript-eslint/no-namespace */ -/* eslint-disable no-irregular-whitespace */ - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, - GaxiosPromise, - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; - -export namespace commentanalyzer_v1alpha1 { - export interface Options extends GlobalOptions { - version: 'v1alpha1'; - } - - 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; - } - - /** - * 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. - * - * @example - * const {google} = require('googleapis'); - * const commentanalyzer = google.commentanalyzer('v1alpha1'); - * - * @namespace commentanalyzer - * @type {Function} - * @version v1alpha1 - * @variation v1alpha1 - * @param {object=} options Options for Commentanalyzer - */ - export class Commentanalyzer { - context: APIRequestContext; - comments: Resource$Comments; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.comments = new Resource$Comments(this.context); - } - } - - /** - * The comment analysis request message. LINT.IfChange - */ - export interface Schema$AnalyzeCommentRequest { - /** - * Opaque token that is echoed from the request to the response. - */ - clientToken?: string | null; - /** - * The comment to analyze. - */ - 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. - */ - communityId?: string | null; - /** - * The context of the comment. - */ - 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. - */ - doNotStore?: boolean | null; - /** - * The language(s) of the comment and context. If none are specified, we attempt to automatically detect the language. Specifying multiple languages means the text contains multiple lanugages. Both ISO and BCP-47 language codes are accepted. The server returns an error if no language was specified and language detection fails. The server also returns an error if the languages (either specified by the caller, or auto-detected) are not *all* supported by the service. - */ - languages?: string[] | null; - /** - * Specification of requested attributes. The AttributeParameters serve as configuration for each associated attribute. The map keys are attribute names. The available attributes may be different on each RFE installation, and can be seen by calling ListAttributes (see above). For the prod installation, known as Perspective API, at blade:commentanalyzer-esf and commentanalyzer.googleapis.com, see go/checker-models (internal) and https://github.com/conversationai/perspectiveapi/blob/master/2-api/models.md#all-attribute-types. - */ - requestedAttributes?: {[key: string]: Schema$AttributeParameters} | null; - /** - * 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 | null; - /** - * 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 | null; - } - /** - * The comment analysis response message. - */ - 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). - */ - attributeScores?: {[key: string]: Schema$AttributeScores} | null; - /** - * Same token from the original AnalyzeCommentRequest. - */ - clientToken?: string | null; - /** - * Contains the languages detected from the text content, sorted in order of likelihood. - */ - detectedLanguages?: string[] | null; - /** - * The language(s) used by CommentAnalyzer service to choose which Model to use when analyzing the comment. Might better be called "effective_languages". The logic used to make the choice is as follows: if !Request.languages.empty() effective_languages = Request.languages else effective_languages = detected_languages[0] - */ - languages?: string[] | null; - } - /** - * 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). - */ - 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. - */ - parentComment?: Schema$TextEntry; - } - /** - * Configurable parameters for attribute scoring. - */ - 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. - */ - scoreThreshold?: number | null; - /** - * What type of scores to return. If unset, defaults to probability scores. - */ - scoreType?: string | null; - } - /** - * 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 { - /** - * Per-span scores. - */ - spanScores?: Schema$SpanScore[]; - /** - * Overall score for comment as a whole. - */ - 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. - */ - export interface Schema$Context { - /** - * 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. - */ - entries?: Schema$TextEntry[]; - } - /** - * Analysis scores are described by a value and a ScoreType. - */ - export interface Schema$Score { - /** - * The type of the above value. - */ - type?: string | null; - /** - * Score value. Semantics described by type below. - */ - value?: number | null; - } - /** - * This is a single score for a given span of text. - */ - 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?: number | null; - end?: number | null; - /** - * The score value. - */ - score?: Schema$Score; - } - /** - * The comment score suggestion request message. - */ - 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. - */ - attributeScores?: {[key: string]: Schema$AttributeScores} | null; - /** - * Opaque token that is echoed from the request to the response. - */ - clientToken?: string | null; - /** - * The comment being scored. - */ - 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. - */ - communityId?: string | null; - /** - * The context of the comment. - */ - context?: Schema$Context; - /** - * The language(s) of the comment and context. If none are specified, we attempt to automatically detect the language. Both ISO and BCP-47 language codes are accepted. - */ - languages?: string[] | null; - /** - * 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 | null; - } - /** - * The comment score suggestion response message. - */ - export interface Schema$SuggestCommentScoreResponse { - /** - * Same token from the original SuggestCommentScoreRequest. - */ - clientToken?: string | null; - /** - * The list of languages detected from the comment text. - */ - detectedLanguages?: string[] | null; - /** - * The list of languages provided in the request. - */ - requestedLanguages?: string[] | null; - } - /** - * Represents a body of text. - */ - export interface Schema$TextEntry { - /** - * UTF-8 encoded text. - */ - text?: string | null; - /** - * Type of the text field. - */ - type?: string | null; - } - - export class Resource$Comments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * commentanalyzer.comments.analyze - * @desc Analyzes the provided text and returns scores for requested attributes. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/commentanalyzer.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const commentanalyzer = google.commentanalyzer('v1alpha1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/userinfo.email'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await commentanalyzer.comments.analyze({ - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientToken": "my_clientToken", - * // "comment": {}, - * // "communityId": "my_communityId", - * // "context": {}, - * // "doNotStore": false, - * // "languages": [], - * // "requestedAttributes": {}, - * // "sessionId": "my_sessionId", - * // "spanAnnotations": false - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "attributeScores": {}, - * // "clientToken": "my_clientToken", - * // "detectedLanguages": [], - * // "languages": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias commentanalyzer.comments.analyze - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().AnalyzeCommentRequest} params.requestBody 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 - */ - analyze( - params?: Params$Resource$Comments$Analyze, - options?: MethodOptions - ): GaxiosPromise; - analyze( - params: Params$Resource$Comments$Analyze, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - analyze( - params: Params$Resource$Comments$Analyze, - callback: BodyResponseCallback - ): void; - analyze( - callback: BodyResponseCallback - ): void; - analyze( - paramsOrCallback?: - | Params$Resource$Comments$Analyze - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Comments$Analyze; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Comments$Analyze; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://commentanalyzer.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/comments:analyze').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * commentanalyzer.comments.suggestscore - * @desc Suggest comment scores as training data. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/commentanalyzer.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const commentanalyzer = google.commentanalyzer('v1alpha1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/userinfo.email'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await commentanalyzer.comments.suggestscore({ - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "attributeScores": {}, - * // "clientToken": "my_clientToken", - * // "comment": {}, - * // "communityId": "my_communityId", - * // "context": {}, - * // "languages": [], - * // "sessionId": "my_sessionId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientToken": "my_clientToken", - * // "detectedLanguages": [], - * // "requestedLanguages": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias commentanalyzer.comments.suggestscore - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().SuggestCommentScoreRequest} params.requestBody 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 - */ - suggestscore( - params?: Params$Resource$Comments$Suggestscore, - options?: MethodOptions - ): GaxiosPromise; - suggestscore( - params: Params$Resource$Comments$Suggestscore, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - suggestscore( - params: Params$Resource$Comments$Suggestscore, - callback: BodyResponseCallback - ): void; - suggestscore( - callback: BodyResponseCallback - ): void; - suggestscore( - paramsOrCallback?: - | Params$Resource$Comments$Suggestscore - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Comments$Suggestscore; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Comments$Suggestscore; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://commentanalyzer.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/comments:suggestscore').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$Comments$Analyze extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$AnalyzeCommentRequest; - } - export interface Params$Resource$Comments$Suggestscore - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$SuggestCommentScoreRequest; - } -} diff --git a/src/apis/commentanalyzer/webpack.config.js b/src/apis/commentanalyzer/webpack.config.js deleted file mode 100644 index be5684d2664..00000000000 --- a/src/apis/commentanalyzer/webpack.config.js +++ /dev/null @@ -1,69 +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. - -// 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: 'Commentanalyzer', - filename: 'commentanalyzer.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/container/v1.ts b/src/apis/container/v1.ts index 5882e407c33..b15751d4c84 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -221,7 +221,7 @@ 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/x. */ name?: string | null; /** @@ -580,7 +580,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -610,7 +610,7 @@ export namespace container_v1 { */ 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/x. */ parent?: string | null; /** @@ -635,7 +635,7 @@ 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/x. */ parent?: string | null; /** @@ -1453,7 +1453,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1516,7 +1516,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1541,7 +1541,7 @@ export namespace container_v1 { */ labelFingerprint?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1570,7 +1570,7 @@ export namespace container_v1 { */ enabled?: boolean | null; /** - * 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/x. */ name?: string | null; /** @@ -1595,7 +1595,7 @@ export namespace container_v1 { */ locations?: string[] | null; /** - * 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/x. */ name?: string | null; /** @@ -1620,7 +1620,7 @@ export namespace container_v1 { */ loggingService?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1645,7 +1645,7 @@ export namespace container_v1 { */ 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/x. */ name?: string | null; /** @@ -1670,7 +1670,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1699,7 +1699,7 @@ export namespace container_v1 { */ monitoringService?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1720,7 +1720,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1749,7 +1749,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1778,7 +1778,7 @@ 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/x. */ name?: string | null; /** @@ -1803,7 +1803,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1854,7 +1854,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1905,7 +1905,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1934,7 +1934,7 @@ export namespace container_v1 { */ masterVersion?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1963,7 +1963,7 @@ export namespace container_v1 { */ locations?: string[] | null; /** - * 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/x. */ name?: string | null; /** @@ -2145,7 +2145,7 @@ export namespace container_v1 { * // previous list requests to get the next page of results. * pageToken: 'placeholder-value', * // The parent project where subnetworks are usable. - * // Specified in the format 'projects/x'. + * // Specified in the format `projects/x`. * parent: 'projects/my-project', * }); * console.log(res.data); @@ -2169,7 +2169,7 @@ export namespace container_v1 { * @param {string=} params.filter 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. * @param {integer=} params.pageSize 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) * @param {string=} params.pageToken Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results. - * @param {string} params.parent The parent project where subnetworks are usable. Specified in the format 'projects/x'. + * @param {string} params.parent The parent project where subnetworks are usable. Specified in the format `projects/x`. * @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 @@ -2265,7 +2265,7 @@ export namespace container_v1 { */ 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; } @@ -2310,7 +2310,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.getServerConfig({ * // The name (project and location) of the server config to get, - * // specified in the format 'projects/x/locations/x'. + * // specified in the format `projects/x/locations/x`. * name: 'projects/my-project/locations/my-location', * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -2343,7 +2343,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. + * @param {string} params.name The name (project and location) of the server config to get, specified in the format `projects/x/locations/x`. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2421,7 +2421,7 @@ 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; /** @@ -2476,7 +2476,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.completeIpRotation({ * // The name (project, location, cluster id) of the cluster to complete IP - * // rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * // rotation. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -2520,7 +2520,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().CompleteIPRotationRequest} params.requestBody 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. @@ -2616,7 +2616,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.create({ * // The parent (project and location) where the cluster will be created. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -2660,7 +2660,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent (project and location) where the cluster will be created. Specified in the format 'projects/x/locations/x'. + * @param {string} params.parent The parent (project and location) where the cluster will be created. Specified in the format `projects/x/locations/x`. * @param {().CreateClusterRequest} params.requestBody 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. @@ -2759,7 +2759,7 @@ export namespace container_v1 { * // This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to delete. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -2802,7 +2802,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. - * @param {string} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2899,7 +2899,7 @@ export namespace container_v1 { * // This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to retrieve. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -2978,7 +2978,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. - * @param {string} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3070,7 +3070,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.getJwks({ * // The cluster (project, location, cluster id) to get keys for. Specified in - * // the format 'projects/x/locations/x/clusters/x'. + * // the format `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', * }); * console.log(res.data); @@ -3091,7 +3091,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The cluster (project, location, cluster id) to get keys for. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.parent The cluster (project, location, cluster id) to get keys for. Specified in the format `projects/x/locations/x/clusters/x`. * @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 @@ -3187,7 +3187,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.list({ * // The parent (project and location) where the clusters will be listed. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * // Location "-" matches all zones and all regions. * parent: 'projects/my-project/locations/my-location', * // Deprecated. The Google Developers Console [project ID or project @@ -3218,7 +3218,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent 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. + * @param {string} params.parent 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. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3317,7 +3317,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.setAddons({ * // The name (project, location, cluster) of the cluster to set addons. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -3362,7 +3362,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetAddonsConfigRequest} params.requestBody 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. @@ -3458,7 +3458,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.setLegacyAbac({ * // The name (project, location, cluster id) of the cluster to set legacy abac. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -3503,7 +3503,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetLegacyAbacRequest} params.requestBody 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. @@ -3599,7 +3599,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.setLocations({ * // The name (project, location, cluster) of the cluster to set locations. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -3644,7 +3644,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetLocationsRequest} params.requestBody 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. @@ -3740,7 +3740,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.setLogging({ * // The name (project, location, cluster) of the cluster to set logging. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -3785,7 +3785,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetLoggingServiceRequest} params.requestBody 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. @@ -3882,7 +3882,7 @@ export namespace container_v1 { * const res = await container.projects.locations.clusters.setMaintenancePolicy({ * // The name (project, location, cluster id) of the cluster to set maintenance * // policy. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -3927,7 +3927,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetMaintenancePolicyRequest} params.requestBody 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. @@ -4025,7 +4025,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.setMasterAuth({ * // The name (project, location, cluster) of the cluster to set auth. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4071,7 +4071,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetMasterAuthRequest} params.requestBody 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. @@ -4167,7 +4167,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.setMonitoring({ * // The name (project, location, cluster) of the cluster to set monitoring. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4212,7 +4212,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetMonitoringServiceRequest} params.requestBody 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. @@ -4308,7 +4308,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.setNetworkPolicy({ * // The name (project, location, cluster id) of the cluster to set networking - * // policy. Specified in the format 'projects/x/locations/x/clusters/x'. + * // policy. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4353,7 +4353,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetNetworkPolicyRequest} params.requestBody 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. @@ -4449,7 +4449,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.setResourceLabels({ * // The name (project, location, cluster id) of the cluster to set labels. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4495,7 +4495,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetLabelsRequest} params.requestBody 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. @@ -4591,7 +4591,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.startIpRotation({ * // The name (project, location, cluster id) of the cluster to start IP - * // rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * // rotation. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4636,7 +4636,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().StartIPRotationRequest} params.requestBody 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. @@ -4732,7 +4732,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.update({ * // The name (project, location, cluster) of the cluster to update. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4777,7 +4777,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to update. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().UpdateClusterRequest} params.requestBody 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. @@ -4870,7 +4870,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.clusters.updateMaster({ * // The name (project, location, cluster) of the cluster to update. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4915,7 +4915,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to update. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().UpdateMasterRequest} params.requestBody 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. @@ -4992,7 +4992,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; @@ -5009,7 +5009,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; @@ -5030,7 +5030,7 @@ export namespace container_v1 { */ 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; /** @@ -5054,7 +5054,7 @@ export namespace container_v1 { */ 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; /** @@ -5074,7 +5074,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; } @@ -5086,7 +5086,7 @@ 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; /** @@ -5106,7 +5106,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; @@ -5123,7 +5123,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; @@ -5140,7 +5140,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; @@ -5157,7 +5157,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; @@ -5174,7 +5174,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; @@ -5191,7 +5191,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; @@ -5208,7 +5208,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; @@ -5225,7 +5225,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; @@ -5242,7 +5242,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; @@ -5259,7 +5259,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; @@ -5276,7 +5276,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; @@ -5293,7 +5293,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; @@ -5338,7 +5338,7 @@ export namespace container_v1 { * const res = await container.projects.locations.clusters.nodePools.create({ * // The parent (project, location, cluster id) where the node pool will be * // created. Specified in the format - * // 'projects/x/locations/x/clusters/x'. + * // `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -5383,7 +5383,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.parent The parent (project, location, cluster id) where the node pool will be created. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().CreateNodePoolRequest} params.requestBody 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. @@ -5483,7 +5483,7 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * // Deprecated. The name of the node pool to delete. @@ -5530,7 +5530,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {string=} params.nodePoolId Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -5629,7 +5629,7 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * // Deprecated. The name of the node pool. @@ -5677,7 +5677,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {string=} params.nodePoolId Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -5773,7 +5773,7 @@ export namespace container_v1 { * // This field has been deprecated and replaced by the parent field. * clusterId: 'placeholder-value', * // The parent (project, location, cluster id) where the node pools will be - * // listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * // listed. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). @@ -5803,7 +5803,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - * @param {string} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5903,7 +5903,7 @@ export namespace container_v1 { * const res = await container.projects.locations.clusters.nodePools.rollback({ * // 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'. + * // Specified in the format `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -5949,7 +5949,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().RollbackNodePoolUpgradeRequest} params.requestBody 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. @@ -6047,7 +6047,7 @@ export namespace container_v1 { * { * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6095,7 +6095,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().SetNodePoolAutoscalingRequest} params.requestBody 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. @@ -6193,7 +6193,7 @@ export namespace container_v1 { * { * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6241,7 +6241,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().SetNodePoolManagementRequest} params.requestBody 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. @@ -6338,7 +6338,7 @@ export namespace container_v1 { * const res = await container.projects.locations.clusters.nodePools.setSize({ * // 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'. + * // Specified in the format `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6385,7 +6385,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().SetNodePoolSizeRequest} params.requestBody 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. @@ -6482,7 +6482,7 @@ export namespace container_v1 { * const res = await container.projects.locations.clusters.nodePools.update({ * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6533,7 +6533,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().UpdateNodePoolRequest} params.requestBody 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. @@ -6607,7 +6607,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; @@ -6628,7 +6628,7 @@ export namespace container_v1 { */ 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; /** @@ -6656,7 +6656,7 @@ export namespace container_v1 { */ 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; /** @@ -6684,7 +6684,7 @@ export namespace container_v1 { */ 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; /** @@ -6704,7 +6704,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; @@ -6721,7 +6721,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; @@ -6738,7 +6738,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; @@ -6755,7 +6755,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; @@ -6772,7 +6772,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; @@ -6819,7 +6819,7 @@ export namespace container_v1 { * known.getOpenid - * configuration({ * // The cluster (project, location, cluster id) to get the discovery document - * // for. Specified in the format 'projects/x/locations/x/clusters/x'. + * // for. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', * }); * console.log(res.data); @@ -6846,7 +6846,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The cluster (project, location, cluster id) to get the discovery document for. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.parent The cluster (project, location, cluster id) to get the discovery document for. Specified in the format `projects/x/locations/x/clusters/x`. * @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 @@ -6925,7 +6925,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; } @@ -6964,7 +6964,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.operations.cancel({ * // The name (project, location, operation id) of the operation to cancel. - * // Specified in the format 'projects/x/locations/x/operations/x'. + * // Specified in the format `projects/x/locations/x/operations/x`. * name: 'projects/my-project/locations/my-location/operations/my-operation', * * // Request body metadata @@ -6993,7 +6993,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/x/locations/x/operations/x'. + * @param {string} params.name The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/x/locations/x/operations/x`. * @param {().CancelOperationRequest} params.requestBody 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. @@ -7084,7 +7084,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.operations.get({ * // The name (project, location, operation id) of the operation to get. - * // Specified in the format 'projects/x/locations/x/operations/x'. + * // Specified in the format `projects/x/locations/x/operations/x`. * name: 'projects/my-project/locations/my-location/operations/my-operation', * // Deprecated. The server-assigned `name` of the operation. * // This field has been deprecated and replaced by the name field. @@ -7129,7 +7129,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. + * @param {string} params.name The name (project, location, operation id) of the operation to get. Specified in the format `projects/x/locations/x/operations/x`. * @param {string=} params.operationId Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -7224,7 +7224,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.locations.operations.list({ * // The parent (project and location) where the operations will be listed. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * // Location "-" matches all zones and all regions. * parent: 'projects/my-project/locations/my-location', * // Deprecated. The Google Developers Console [project ID or project @@ -7255,7 +7255,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent 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. + * @param {string} params.parent 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. * @param {string=} params.projectId 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. * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7335,7 +7335,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; @@ -7352,7 +7352,7 @@ 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; /** @@ -7376,7 +7376,7 @@ 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; /** @@ -7427,7 +7427,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.zones.getServerconfig({ * // The name (project and location) of the server config to get, - * // specified in the format 'projects/x/locations/x'. + * // specified in the format `projects/x/locations/x`. * name: 'placeholder-value', * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -7460,7 +7460,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.name The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. + * @param {string=} params.name The name (project and location) of the server config to get, specified in the format `projects/x/locations/x`. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7537,7 +7537,7 @@ 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; /** @@ -8040,7 +8040,7 @@ export namespace container_v1 { * // This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to delete. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'placeholder-value', * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -8083,7 +8083,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. - * @param {string=} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string=} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8183,7 +8183,7 @@ export namespace container_v1 { * // This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to retrieve. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'placeholder-value', * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -8262,7 +8262,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. - * @param {string=} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string=} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8509,7 +8509,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.zones.clusters.list({ * // The parent (project and location) where the clusters will be listed. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * // Location "-" matches all zones and all regions. * parent: 'placeholder-value', * // Deprecated. The Google Developers Console [project ID or project @@ -8540,7 +8540,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.parent 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. + * @param {string=} params.parent 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. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10215,7 +10215,7 @@ export namespace container_v1 { */ 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; /** @@ -10239,7 +10239,7 @@ export namespace container_v1 { */ 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; /** @@ -10284,7 +10284,7 @@ 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; /** @@ -10894,7 +10894,7 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: 'placeholder-value', * // Deprecated. The name of the node pool to delete. * // This field has been deprecated and replaced by the name field. @@ -10940,7 +10940,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string=} params.name 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'. + * @param {string=} params.name 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`. * @param {string} params.nodePoolId Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -11042,7 +11042,7 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: 'placeholder-value', * // Deprecated. The name of the node pool. * // This field has been deprecated and replaced by the name field. @@ -11089,7 +11089,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string=} params.name 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'. + * @param {string=} params.name 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`. * @param {string} params.nodePoolId Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -11188,7 +11188,7 @@ export namespace container_v1 { * // This field has been deprecated and replaced by the parent field. * clusterId: 'placeholder-value', * // The parent (project, location, cluster id) where the node pools will be - * // listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * // listed. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'placeholder-value', * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). @@ -11218,7 +11218,7 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - * @param {string=} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string=} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11987,7 +11987,7 @@ export namespace container_v1 { */ 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; /** @@ -12015,7 +12015,7 @@ export namespace container_v1 { */ 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; /** @@ -12043,7 +12043,7 @@ export namespace container_v1 { */ 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; /** @@ -12340,7 +12340,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.zones.operations.get({ * // The name (project, location, operation id) of the operation to get. - * // Specified in the format 'projects/x/locations/x/operations/x'. + * // Specified in the format `projects/x/locations/x/operations/x`. * name: 'placeholder-value', * // Deprecated. The server-assigned `name` of the operation. * // This field has been deprecated and replaced by the name field. @@ -12385,7 +12385,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.name The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. + * @param {string=} params.name The name (project, location, operation id) of the operation to get. Specified in the format `projects/x/locations/x/operations/x`. * @param {string} params.operationId Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -12483,7 +12483,7 @@ export namespace container_v1 { * // Do the magic * const res = await container.projects.zones.operations.list({ * // The parent (project and location) where the operations will be listed. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * // Location "-" matches all zones and all regions. * parent: 'placeholder-value', * // Deprecated. The Google Developers Console [project ID or project @@ -12514,7 +12514,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.parent 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. + * @param {string=} params.parent 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. * @param {string} params.projectId 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. * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12618,7 +12618,7 @@ 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; /** @@ -12642,7 +12642,7 @@ 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; /** diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 82d95b2196a..58be5fa3ec8 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -258,7 +258,7 @@ 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/x. */ name?: string | null; /** @@ -674,7 +674,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -713,7 +713,7 @@ export namespace container_v1beta1 { */ 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/x. */ parent?: string | null; /** @@ -738,7 +738,7 @@ 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/x. */ parent?: string | null; /** @@ -1100,7 +1100,7 @@ export namespace container_v1beta1 { */ 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/x. */ name?: string | null; /** @@ -1683,7 +1683,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1754,7 +1754,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1779,7 +1779,7 @@ export namespace container_v1beta1 { */ labelFingerprint?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1808,7 +1808,7 @@ export namespace container_v1beta1 { */ enabled?: boolean | null; /** - * 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/x. */ name?: string | null; /** @@ -1833,7 +1833,7 @@ export namespace container_v1beta1 { */ locations?: string[] | null; /** - * 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/x. */ name?: string | null; /** @@ -1858,7 +1858,7 @@ export namespace container_v1beta1 { */ loggingService?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1883,7 +1883,7 @@ export namespace container_v1beta1 { */ 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/x. */ name?: string | null; /** @@ -1908,7 +1908,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1937,7 +1937,7 @@ export namespace container_v1beta1 { */ monitoringService?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1958,7 +1958,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -1987,7 +1987,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -2016,7 +2016,7 @@ 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/x. */ name?: string | null; /** @@ -2041,7 +2041,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -2092,7 +2092,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -2160,7 +2160,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -2189,7 +2189,7 @@ export namespace container_v1beta1 { */ masterVersion?: string | null; /** - * 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/x. */ name?: string | null; /** @@ -2218,7 +2218,7 @@ export namespace container_v1beta1 { */ locations?: string[] | null; /** - * 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/x. */ name?: string | null; /** @@ -2408,7 +2408,7 @@ export namespace container_v1beta1 { * // previous list requests to get the next page of results. * pageToken: 'placeholder-value', * // Required. The parent project where subnetworks are usable. - * // Specified in the format 'projects/x'. + * // Specified in the format `projects/x`. * parent: 'projects/my-project', * }); * console.log(res.data); @@ -2432,7 +2432,7 @@ export namespace container_v1beta1 { * @param {string=} params.filter 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. * @param {integer=} params.pageSize 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) * @param {string=} params.pageToken Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results. - * @param {string} params.parent Required. The parent project where subnetworks are usable. Specified in the format 'projects/x'. + * @param {string} params.parent Required. The parent project where subnetworks are usable. Specified in the format `projects/x`. * @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 @@ -2528,7 +2528,7 @@ export namespace container_v1beta1 { */ pageToken?: string; /** - * Required. The parent project where subnetworks are usable. Specified in the format 'projects/x'. + * Required. The parent project where subnetworks are usable. Specified in the format `projects/x`. */ parent?: string; } @@ -2573,7 +2573,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.getServerConfig({ * // The name (project and location) of the server config to get, - * // specified in the format 'projects/x/locations/x'. + * // specified in the format `projects/x/locations/x`. * name: 'projects/my-project/locations/my-location', * // Required. Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -2607,7 +2607,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. + * @param {string} params.name The name (project and location) of the server config to get, specified in the format `projects/x/locations/x`. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2704,7 +2704,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.list({ * // Required. Contains the name of the resource requested. - * // Specified in the format 'projects/x'. + * // Specified in the format `projects/x`. * parent: 'projects/my-project', * }); * console.log(res.data); @@ -2725,7 +2725,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Contains the name of the resource requested. Specified in the format 'projects/x'. + * @param {string} params.parent Required. Contains the name of the resource requested. Specified in the format `projects/x`. * @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 @@ -2803,7 +2803,7 @@ 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; /** @@ -2823,7 +2823,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Contains the name of the resource requested. Specified in the format 'projects/x'. + * Required. Contains the name of the resource requested. Specified in the format `projects/x`. */ parent?: string; } @@ -2870,7 +2870,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.completeIpRotation({ * // The name (project, location, cluster id) of the cluster to complete IP - * // rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * // rotation. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -2914,7 +2914,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().CompleteIPRotationRequest} params.requestBody 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. @@ -3010,7 +3010,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.create({ * // The parent (project and location) where the cluster will be created. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -3054,7 +3054,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent (project and location) where the cluster will be created. Specified in the format 'projects/x/locations/x'. + * @param {string} params.parent The parent (project and location) where the cluster will be created. Specified in the format `projects/x/locations/x`. * @param {().CreateClusterRequest} params.requestBody 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. @@ -3153,7 +3153,7 @@ export namespace container_v1beta1 { * // This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to delete. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * // Required. Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -3196,7 +3196,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. - * @param {string} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3293,7 +3293,7 @@ export namespace container_v1beta1 { * // This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to retrieve. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * // Required. Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -3378,7 +3378,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. - * @param {string} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3470,7 +3470,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.getJwks({ * // The cluster (project, location, cluster id) to get keys for. Specified in - * // the format 'projects/x/locations/x/clusters/x'. + * // the format `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', * }); * console.log(res.data); @@ -3491,7 +3491,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The cluster (project, location, cluster id) to get keys for. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.parent The cluster (project, location, cluster id) to get keys for. Specified in the format `projects/x/locations/x/clusters/x`. * @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 @@ -3590,7 +3590,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.list({ * // The parent (project and location) where the clusters will be listed. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * // Location "-" matches all zones and all regions. * parent: 'projects/my-project/locations/my-location', * // Required. Deprecated. The Google Developers Console [project ID or project @@ -3621,7 +3621,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent 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. + * @param {string} params.parent 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. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3720,7 +3720,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.setAddons({ * // The name (project, location, cluster) of the cluster to set addons. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -3765,7 +3765,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetAddonsConfigRequest} params.requestBody 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. @@ -3861,7 +3861,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.setLegacyAbac({ * // The name (project, location, cluster id) of the cluster to set legacy abac. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -3906,7 +3906,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetLegacyAbacRequest} params.requestBody 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. @@ -4002,7 +4002,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.setLocations({ * // The name (project, location, cluster) of the cluster to set locations. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4047,7 +4047,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetLocationsRequest} params.requestBody 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. @@ -4143,7 +4143,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.setLogging({ * // The name (project, location, cluster) of the cluster to set logging. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4188,7 +4188,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetLoggingServiceRequest} params.requestBody 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. @@ -4285,7 +4285,7 @@ export namespace container_v1beta1 { * const res = await container.projects.locations.clusters.setMaintenancePolicy({ * // The name (project, location, cluster id) of the cluster to set maintenance * // policy. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4330,7 +4330,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetMaintenancePolicyRequest} params.requestBody 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. @@ -4428,7 +4428,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.setMasterAuth({ * // The name (project, location, cluster) of the cluster to set auth. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4474,7 +4474,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetMasterAuthRequest} params.requestBody 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. @@ -4570,7 +4570,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.setMonitoring({ * // The name (project, location, cluster) of the cluster to set monitoring. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4615,7 +4615,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetMonitoringServiceRequest} params.requestBody 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. @@ -4711,7 +4711,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.setNetworkPolicy({ * // The name (project, location, cluster id) of the cluster to set networking - * // policy. Specified in the format 'projects/x/locations/x/clusters/x'. + * // policy. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4756,7 +4756,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetNetworkPolicyRequest} params.requestBody 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. @@ -4852,7 +4852,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.setResourceLabels({ * // The name (project, location, cluster id) of the cluster to set labels. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -4898,7 +4898,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().SetLabelsRequest} params.requestBody 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. @@ -4994,7 +4994,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.startIpRotation({ * // The name (project, location, cluster id) of the cluster to start IP - * // rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * // rotation. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -5039,7 +5039,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().StartIPRotationRequest} params.requestBody 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. @@ -5135,7 +5135,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.update({ * // The name (project, location, cluster) of the cluster to update. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -5180,7 +5180,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to update. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().UpdateClusterRequest} params.requestBody 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. @@ -5273,7 +5273,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.clusters.updateMaster({ * // The name (project, location, cluster) of the cluster to update. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -5318,7 +5318,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.name The name (project, location, cluster) of the cluster to update. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().UpdateMasterRequest} params.requestBody 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. @@ -5395,7 +5395,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; @@ -5412,7 +5412,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; @@ -5433,7 +5433,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -5457,7 +5457,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -5477,7 +5477,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; } @@ -5489,7 +5489,7 @@ 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; /** @@ -5509,7 +5509,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; @@ -5526,7 +5526,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; @@ -5543,7 +5543,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; @@ -5560,7 +5560,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; @@ -5577,7 +5577,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; @@ -5594,7 +5594,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; @@ -5611,7 +5611,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; @@ -5628,7 +5628,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; @@ -5645,7 +5645,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; @@ -5662,7 +5662,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; @@ -5679,7 +5679,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; @@ -5696,7 +5696,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; @@ -5741,7 +5741,7 @@ export namespace container_v1beta1 { * const res = await container.projects.locations.clusters.nodePools.create({ * // The parent (project, location, cluster id) where the node pool will be * // created. Specified in the format - * // 'projects/x/locations/x/clusters/x'. + * // `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', * * // Request body metadata @@ -5786,7 +5786,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.parent The parent (project, location, cluster id) where the node pool will be created. Specified in the format `projects/x/locations/x/clusters/x`. * @param {().CreateNodePoolRequest} params.requestBody 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. @@ -5886,7 +5886,7 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * // Required. Deprecated. The name of the node pool to delete. @@ -5933,7 +5933,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {string=} params.nodePoolId Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -6032,7 +6032,7 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * // Required. Deprecated. The name of the node pool. @@ -6080,7 +6080,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {string=} params.nodePoolId Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -6176,7 +6176,7 @@ export namespace container_v1beta1 { * // This field has been deprecated and replaced by the parent field. * clusterId: 'placeholder-value', * // The parent (project, location, cluster id) where the node pools will be - * // listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * // listed. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', * // Required. Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). @@ -6206,7 +6206,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - * @param {string} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6306,7 +6306,7 @@ export namespace container_v1beta1 { * const res = await container.projects.locations.clusters.nodePools.rollback({ * // 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'. + * // Specified in the format `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6352,7 +6352,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().RollbackNodePoolUpgradeRequest} params.requestBody 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. @@ -6450,7 +6450,7 @@ export namespace container_v1beta1 { * { * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6498,7 +6498,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().SetNodePoolAutoscalingRequest} params.requestBody 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. @@ -6596,7 +6596,7 @@ export namespace container_v1beta1 { * { * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6644,7 +6644,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().SetNodePoolManagementRequest} params.requestBody 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. @@ -6741,7 +6741,7 @@ export namespace container_v1beta1 { * const res = await container.projects.locations.clusters.nodePools.setSize({ * // 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'. + * // Specified in the format `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6788,7 +6788,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().SetNodePoolSizeRequest} params.requestBody 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. @@ -6885,7 +6885,7 @@ export namespace container_v1beta1 { * const res = await container.projects.locations.clusters.nodePools.update({ * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: * 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * @@ -6936,7 +6936,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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'. + * @param {string} params.name 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`. * @param {().UpdateNodePoolRequest} params.requestBody 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. @@ -7010,7 +7010,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; @@ -7031,7 +7031,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -7059,7 +7059,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -7087,7 +7087,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -7107,7 +7107,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; @@ -7124,7 +7124,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; @@ -7141,7 +7141,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; @@ -7158,7 +7158,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; @@ -7175,7 +7175,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; @@ -7222,7 +7222,7 @@ export namespace container_v1beta1 { * known.getOpenid - * configuration({ * // The cluster (project, location, cluster id) to get the discovery document - * // for. Specified in the format 'projects/x/locations/x/clusters/x'. + * // for. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', * }); * console.log(res.data); @@ -7249,7 +7249,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The cluster (project, location, cluster id) to get the discovery document for. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string} params.parent The cluster (project, location, cluster id) to get the discovery document for. Specified in the format `projects/x/locations/x/clusters/x`. * @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 @@ -7328,7 +7328,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; } @@ -7367,7 +7367,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.operations.cancel({ * // The name (project, location, operation id) of the operation to cancel. - * // Specified in the format 'projects/x/locations/x/operations/x'. + * // Specified in the format `projects/x/locations/x/operations/x`. * name: 'projects/my-project/locations/my-location/operations/my-operation', * * // Request body metadata @@ -7396,7 +7396,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/x/locations/x/operations/x'. + * @param {string} params.name The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/x/locations/x/operations/x`. * @param {().CancelOperationRequest} params.requestBody 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. @@ -7490,7 +7490,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.operations.get({ * // The name (project, location, operation id) of the operation to get. - * // Specified in the format 'projects/x/locations/x/operations/x'. + * // Specified in the format `projects/x/locations/x/operations/x`. * name: 'projects/my-project/locations/my-location/operations/my-operation', * // Required. Deprecated. The server-assigned `name` of the operation. * // This field has been deprecated and replaced by the name field. @@ -7535,7 +7535,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. + * @param {string} params.name The name (project, location, operation id) of the operation to get. Specified in the format `projects/x/locations/x/operations/x`. * @param {string=} params.operationId Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -7630,7 +7630,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.locations.operations.list({ * // The parent (project and location) where the operations will be listed. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * // Location "-" matches all zones and all regions. * parent: 'projects/my-project/locations/my-location', * // Required. Deprecated. The Google Developers Console [project ID or project @@ -7661,7 +7661,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent 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. + * @param {string} params.parent 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. * @param {string=} params.projectId Required. 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. * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7741,7 +7741,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; @@ -7758,7 +7758,7 @@ 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; /** @@ -7782,7 +7782,7 @@ 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; /** @@ -7833,7 +7833,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.zones.getServerconfig({ * // The name (project and location) of the server config to get, - * // specified in the format 'projects/x/locations/x'. + * // specified in the format `projects/x/locations/x`. * name: 'placeholder-value', * // Required. Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -7867,7 +7867,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.name The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. + * @param {string=} params.name The name (project and location) of the server config to get, specified in the format `projects/x/locations/x`. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7945,7 +7945,7 @@ 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; /** @@ -8448,7 +8448,7 @@ export namespace container_v1beta1 { * // This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to delete. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'placeholder-value', * // Required. Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -8491,7 +8491,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. - * @param {string=} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string=} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8591,7 +8591,7 @@ export namespace container_v1beta1 { * // This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to retrieve. - * // Specified in the format 'projects/x/locations/x/clusters/x'. + * // Specified in the format `projects/x/locations/x/clusters/x`. * name: 'placeholder-value', * // Required. Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). @@ -8676,7 +8676,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. - * @param {string=} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string=} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8923,7 +8923,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.zones.clusters.list({ * // The parent (project and location) where the clusters will be listed. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * // Location "-" matches all zones and all regions. * parent: 'placeholder-value', * // Required. Deprecated. The Google Developers Console [project ID or project @@ -8954,7 +8954,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.parent 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. + * @param {string=} params.parent 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. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10629,7 +10629,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -10653,7 +10653,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -10698,7 +10698,7 @@ 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; /** @@ -11308,7 +11308,7 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: 'placeholder-value', * // Required. Deprecated. The name of the node pool to delete. * // This field has been deprecated and replaced by the name field. @@ -11354,7 +11354,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string=} params.name 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'. + * @param {string=} params.name 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`. * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -11456,7 +11456,7 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // 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'. + * // `projects/x/locations/x/clusters/x/nodePools/x`. * name: 'placeholder-value', * // Required. Deprecated. The name of the node pool. * // This field has been deprecated and replaced by the name field. @@ -11503,7 +11503,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string=} params.name 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'. + * @param {string=} params.name 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`. * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -11602,7 +11602,7 @@ export namespace container_v1beta1 { * // This field has been deprecated and replaced by the parent field. * clusterId: 'placeholder-value', * // The parent (project, location, cluster id) where the node pools will be - * // listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * // listed. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'placeholder-value', * // Required. Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). @@ -11632,7 +11632,7 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - * @param {string=} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * @param {string=} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format `projects/x/locations/x/clusters/x`. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12401,7 +12401,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -12429,7 +12429,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -12457,7 +12457,7 @@ export namespace container_v1beta1 { */ 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; /** @@ -12754,7 +12754,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.zones.operations.get({ * // The name (project, location, operation id) of the operation to get. - * // Specified in the format 'projects/x/locations/x/operations/x'. + * // Specified in the format `projects/x/locations/x/operations/x`. * name: 'placeholder-value', * // Required. Deprecated. The server-assigned `name` of the operation. * // This field has been deprecated and replaced by the name field. @@ -12799,7 +12799,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.name The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. + * @param {string=} params.name The name (project, location, operation id) of the operation to get. Specified in the format `projects/x/locations/x/operations/x`. * @param {string} params.operationId Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. @@ -12897,7 +12897,7 @@ export namespace container_v1beta1 { * // Do the magic * const res = await container.projects.zones.operations.list({ * // The parent (project and location) where the operations will be listed. - * // Specified in the format 'projects/x/locations/x'. + * // Specified in the format `projects/x/locations/x`. * // Location "-" matches all zones and all regions. * parent: 'placeholder-value', * // Required. Deprecated. The Google Developers Console [project ID or project @@ -12928,7 +12928,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.parent 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. + * @param {string=} params.parent 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. * @param {string} params.projectId Required. 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. * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13032,7 +13032,7 @@ 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; /** @@ -13056,7 +13056,7 @@ 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; /** diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 1b5d33e9667..68b03758667 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -175,7 +175,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -565,7 +565,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -1018,7 +1018,7 @@ export namespace containeranalysis_v1alpha1 { signature?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -1030,7 +1030,7 @@ export namespace containeranalysis_v1alpha1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/customsearch/v1.ts b/src/apis/customsearch/v1.ts index b61388b6a80..df60eaebfad 100644 --- a/src/apis/customsearch/v1.ts +++ b/src/apis/customsearch/v1.ts @@ -39,9 +39,21 @@ export namespace customsearch_v1 { interface StandardParameters { /** - * Data format for the response. + * 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. */ @@ -59,17 +71,21 @@ export namespace customsearch_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must 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; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** - * CustomSearch API + * Custom Search API * * Searches over a website or collection of websites * @@ -97,71 +113,75 @@ export namespace customsearch_v1 { } } - export interface Schema$Context { - facets?: Array< - Array<{anchor?: string; label?: string; label_with_op?: string}> - > | null; - title?: string | null; - } + /** + * Promotion result. + */ export interface Schema$Promotion { + /** + * An array of block objects for this promotion. See [Google WebSearch Protocol reference](https://developers.google.com/custom-search/docs/xml_results) for more information. + */ bodyLines?: Array<{ htmlTitle?: string; link?: string; title?: string; url?: string; }> | null; + /** + * An abridged version of this search's result URL, e.g. www.example.com. + */ displayLink?: string | null; + /** + * The title of the promotion, in HTML. + */ htmlTitle?: string | null; + /** + * Image belonging to a promotion. + */ image?: {height?: number; source?: string; width?: number} | null; + /** + * The URL of the promotion. + */ link?: string | null; + /** + * The title of the promotion. + */ title?: string | null; } - export interface Schema$Query { - count?: number | null; - cr?: string | null; - cx?: string | null; - dateRestrict?: string | null; - disableCnTwTranslation?: string | null; - exactTerms?: string | null; - excludeTerms?: string | null; - fileType?: string | null; - filter?: string | null; - gl?: string | null; - googleHost?: string | null; - highRange?: string | null; - hl?: string | null; - hq?: string | null; - imgColorType?: string | null; - imgDominantColor?: string | null; - imgSize?: string | null; - imgType?: string | null; - inputEncoding?: string | null; - language?: string | null; - linkSite?: string | null; - lowRange?: string | null; - orTerms?: string | null; - outputEncoding?: string | null; - relatedSite?: string | null; - rights?: string | null; - safe?: string | null; - searchTerms?: string | null; - searchType?: string | null; - siteSearch?: string | null; - siteSearchFilter?: string | null; - sort?: string | null; - startIndex?: number | null; - startPage?: number | null; - title?: string | null; - totalResults?: string | null; - } + /** + * A custom search result. + */ export interface Schema$Result { + /** + * Indicates the ID of Google's cached version of the search result. + */ cacheId?: string | null; + /** + * An abridged version of this search result’s URL, e.g. www.example.com. + */ displayLink?: string | null; + /** + * The file format of the search result. + */ fileFormat?: string | null; + /** + * The URL displayed after the snippet for each search result. + */ formattedUrl?: string | null; + /** + * The HTML-formatted URL displayed after the snippet for each search result. + */ htmlFormattedUrl?: string | null; + /** + * The snippet of the search result, in HTML. + */ htmlSnippet?: string | null; + /** + * The title of the search result, in HTML. + */ htmlTitle?: string | null; + /** + * Image belonging to a custom search result. + */ image?: { byteSize?: number; contextLink?: string; @@ -171,31 +191,194 @@ export namespace customsearch_v1 { thumbnailWidth?: number; width?: number; } | null; + /** + * A unique identifier for the type of current object. For this API, it is `customsearch#result.` + */ kind?: string | null; + /** + * Encapsulates all information about [refinement labels](https://developers.google.com/custom-search/docs/xml_results). + */ labels?: Array<{ displayName?: string; label_with_op?: string; name?: string; }> | null; + /** + * The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar. + */ link?: string | null; + /** + * The MIME type of the search result. + */ mime?: string | null; - pagemap?: {[key: string]: Array<{[key: string]: any}>} | null; + /** + * Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result. + */ + pagemap?: {[key: string]: any} | null; + /** + * The snippet of the search result, in plain text. + */ snippet?: string | null; + /** + * The title of the search result, in plain text. + */ title?: string | null; } + /** + * Response to a custom search request. + */ export interface Schema$Search { - context?: Schema$Context; + /** + * Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of [facet objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search. + */ + context?: {[key: string]: any} | null; + /** + * The current set of custom search results. + */ items?: Schema$Result[]; + /** + * Unique identifier for the type of current object. For this API, it is customsearch#search. + */ kind?: string | null; + /** + * The set of [promotions](https://developers.google.com/custom-search/docs/promotions). Present only if the custom search engine's configuration files define any promotions for the given query. + */ promotions?: Schema$Promotion[]; - queries?: {[key: string]: Schema$Query[]} | null; + /** + * Query metadata for the previous, current, and next pages of results. + */ + queries?: { + nextPage?: Array<{ + count?: number; + cr?: string; + cx?: string; + dateRestrict?: string; + disableCnTwTranslation?: string; + exactTerms?: string; + excludeTerms?: string; + fileType?: string; + filter?: string; + gl?: string; + googleHost?: string; + highRange?: string; + hl?: string; + hq?: string; + imgColorType?: string; + imgDominantColor?: string; + imgSize?: string; + imgType?: string; + inputEncoding?: string; + language?: string; + linkSite?: string; + lowRange?: string; + orTerms?: string; + outputEncoding?: string; + relatedSite?: string; + rights?: string; + safe?: string; + searchTerms?: string; + searchType?: string; + siteSearch?: string; + siteSearchFilter?: string; + sort?: string; + startIndex?: number; + startPage?: number; + title?: string; + totalResults?: string; + }>; + previousPage?: Array<{ + count?: number; + cr?: string; + cx?: string; + dateRestrict?: string; + disableCnTwTranslation?: string; + exactTerms?: string; + excludeTerms?: string; + fileType?: string; + filter?: string; + gl?: string; + googleHost?: string; + highRange?: string; + hl?: string; + hq?: string; + imgColorType?: string; + imgDominantColor?: string; + imgSize?: string; + imgType?: string; + inputEncoding?: string; + language?: string; + linkSite?: string; + lowRange?: string; + orTerms?: string; + outputEncoding?: string; + relatedSite?: string; + rights?: string; + safe?: string; + searchTerms?: string; + searchType?: string; + siteSearch?: string; + siteSearchFilter?: string; + sort?: string; + startIndex?: number; + startPage?: number; + title?: string; + totalResults?: string; + }>; + request?: Array<{ + count?: number; + cr?: string; + cx?: string; + dateRestrict?: string; + disableCnTwTranslation?: string; + exactTerms?: string; + excludeTerms?: string; + fileType?: string; + filter?: string; + gl?: string; + googleHost?: string; + highRange?: string; + hl?: string; + hq?: string; + imgColorType?: string; + imgDominantColor?: string; + imgSize?: string; + imgType?: string; + inputEncoding?: string; + language?: string; + linkSite?: string; + lowRange?: string; + orTerms?: string; + outputEncoding?: string; + relatedSite?: string; + rights?: string; + safe?: string; + searchTerms?: string; + searchType?: string; + siteSearch?: string; + siteSearchFilter?: string; + sort?: string; + startIndex?: number; + startPage?: number; + title?: string; + totalResults?: string; + }>; + } | null; + /** + * Metadata about a search operation. + */ searchInformation?: { formattedSearchTime?: string; formattedTotalResults?: string; searchTime?: number; totalResults?: string; } | null; + /** + * Spell correction information for a query. + */ spelling?: {correctedQuery?: string; htmlCorrectedQuery?: string} | null; + /** + * OpenSearch template and URL. + */ url?: {template?: string; type?: string} | null; } @@ -234,67 +417,307 @@ export namespace customsearch_v1 { * * // Do the magic * const res = await search.cse.list({ - * // Turns off the translation between zh-CN and zh-TW. + * // Enables or disables [Simplified and Traditional Chinese + * // Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). + * // + * // The default value for this parameter is 0 (zero), meaning that the feature + * // is enabled. Supported values are: + * // + * // * `1`: Disabled + * // + * // * `0`: Enabled (default) * c2coff: 'placeholder-value', - * // Country restrict(s). + * // Restricts search results to documents originating in a particular country. + * // You may use [Boolean + * // operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) + * // in the cr parameter's value. + * // + * // Google Search determines the country of a document by analyzing: + * // + * // * the top-level domain (TLD) of the document's URL + * // + * // * the geographic location of the Web server's IP address + * // + * // See the [Country Parameter + * // Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) + * // page for a list of valid values for this parameter. * cr: 'placeholder-value', - * // The custom search engine ID to scope this search query + * // The custom search engine ID to use for this request. * cx: 'placeholder-value', - * // Specifies all search results are from a time period + * // Restricts results to URLs based on date. Supported values include: + * // + * // * `d[number]`: requests results from the specified number of past days. + * // + * // * `w[number]`: requests results from the specified number of past weeks. + * // + * // * `m[number]`: requests results from the specified number of past months. + * // + * // * `y[number]`: requests results from the specified number of past years. * dateRestrict: 'placeholder-value', - * // Identifies a phrase that all documents in the search results must contain + * // Identifies a phrase that all documents in the search results must contain. * exactTerms: 'placeholder-value', - * // 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: 'placeholder-value', - * // Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... + * // Restricts results to files of a specified extension. A list of file types + * // indexable by Google can be found in Search Console [Help + * // Center](https://support.google.com/webmasters/answer/35287). * fileType: 'placeholder-value', * // Controls turning on or off the duplicate content filter. + * // + * // * See [Automatic + * // Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) + * // for more information about Google's search results filters. Note that host + * // crowding filtering applies only to multi-site searches. + * // + * // * By default, Google applies filtering to all search results to improve the + * // quality of those results. + * // + * // Acceptable values are: + * // + * // * `0`: Turns off duplicate content filter. + * // + * // * `1`: Turns on duplicate content filter. * filter: 'placeholder-value', * // Geolocation of end user. + * // + * // * The `gl` parameter value is a two-letter country code. The `gl` parameter + * // boosts search results whose country of origin matches the parameter value. + * // See the [Country + * // Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) + * // page for a list of valid values. + * // + * // * Specifying a `gl` parameter value should lead to more relevant results. + * // This is particularly true for international customers and, even more + * // specifically, for customers in English- speaking countries other than the + * // United States. * gl: 'placeholder-value', - * // The local Google domain to use to perform the search. + * // **Deprecated**. Use the `gl` parameter for a similar effect. + * // + * // The local Google domain (for example, google.com, google.de, or + * // google.fr) to use to perform the search. * googlehost: 'placeholder-value', - * // Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * // Specifies the ending value for a search range. + * // + * // * Use `lowRange` and `highRange` to append an inclusive search range of + * // `lowRange...highRange` to the query. * highRange: 'placeholder-value', * // Sets the user interface language. + * // + * // * Explicitly setting this parameter improves the performance and the + * // quality of your search results. + * // + * // * See the [Interface + * // Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) + * // section of [Internationalizing Queries and Results + * // Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) + * // for more information, and (Supported Interface + * // Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] + * // for a list of supported languages. * hl: 'placeholder-value', - * // Appends the extra query terms to the query. + * // Appends the specified query terms to the query, as if they were combined + * // with a logical AND operator. * hq: 'placeholder-value', - * // Returns black and white, grayscale, or color images: mono, gray, and color. + * // Returns black and white, grayscale, transparent, or color images. + * // Acceptable values are: + * // + * // * `"color"` + * // + * // * `"gray"` + * // + * // * `"mono"`: black and white + * // + * // * `"trans"`: transparent background * imgColorType: 'placeholder-value', - * // 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. Acceptable values are: + * // + * // * `"black"` + * // + * // * `"blue"` + * // + * // * `"brown"` + * // + * // * `"gray"` + * // + * // * `"green"` + * // + * // * `"orange"` + * // + * // * `"pink"` + * // + * // * `"purple"` + * // + * // * `"red"` + * // + * // * `"teal"` + * // + * // * `"white"` + * // + * // * `"yellow"` * imgDominantColor: 'placeholder-value', - * // 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. Acceptable values are: + * // + * // * `"huge"` + * // + * // * `"icon"` + * // + * // * `"large"` + * // + * // * `"medium"` + * // + * // * `"small"` + * // + * // * `"xlarge"` + * // + * // * `"xxlarge"` * imgSize: 'placeholder-value', - * // Returns images of a type, which can be one of: clipart, face, lineart, news, and photo. + * // Returns images of a type. Acceptable values are: + * // + * // * `"clipart"` + * // + * // * `"face"` + * // + * // * `"lineart"` + * // + * // * `"stock"` + * // + * // * `"photo"` + * // + * // * `"animated"` * imgType: 'placeholder-value', - * // 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: 'placeholder-value', - * // Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * // Specifies the starting value for a search range. Use `lowRange` and + * // `highRange` to append an inclusive search range of `lowRange...highRange` + * // to the query. * lowRange: 'placeholder-value', - * // The language restriction for the search results + * // Restricts the search to documents written in a particular language (e.g., + * // `lr=lang_ja`). + * // + * // Acceptable values are: + * // + * // * `"lang_ar"`: Arabic + * // + * // * `"lang_bg"`: Bulgarian + * // + * // * `"lang_ca"`: Catalan + * // + * // * `"lang_cs"`: Czech + * // + * // * `"lang_da"`: Danish + * // + * // * `"lang_de"`: German + * // + * // * `"lang_el"`: Greek + * // + * // * `"lang_en"`: English + * // + * // * `"lang_es"`: Spanish + * // + * // * `"lang_et"`: Estonian + * // + * // * `"lang_fi"`: Finnish + * // + * // * `"lang_fr"`: French + * // + * // * `"lang_hr"`: Croatian + * // + * // * `"lang_hu"`: Hungarian + * // + * // * `"lang_id"`: Indonesian + * // + * // * `"lang_is"`: Icelandic + * // + * // * `"lang_it"`: Italian + * // + * // * `"lang_iw"`: Hebrew + * // + * // * `"lang_ja"`: Japanese + * // + * // * `"lang_ko"`: Korean + * // + * // * `"lang_lt"`: Lithuanian + * // + * // * `"lang_lv"`: Latvian + * // + * // * `"lang_nl"`: Dutch + * // + * // * `"lang_no"`: Norwegian + * // + * // * `"lang_pl"`: Polish + * // + * // * `"lang_pt"`: Portuguese + * // + * // * `"lang_ro"`: Romanian + * // + * // * `"lang_ru"`: Russian + * // + * // * `"lang_sk"`: Slovak + * // + * // * `"lang_sl"`: Slovenian + * // + * // * `"lang_sr"`: Serbian + * // + * // * `"lang_sv"`: Swedish + * // + * // * `"lang_tr"`: Turkish + * // + * // * `"lang_zh-CN"`: Chinese (Simplified) + * // + * // * `"lang_zh-TW"`: Chinese (Traditional) * lr: 'placeholder-value', - * // Number of search results to return + * // Number of search results to return. + * // + * // * Valid values are integers between 1 and 10, inclusive. * num: 'placeholder-value', - * // 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: 'placeholder-value', * // Query * q: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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. See [typical + * // combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). * rights: 'placeholder-value', - * // Search safety level + * // Search safety level. Acceptable values are: + * // + * // * `"active"`: Enables SafeSearch filtering. + * // + * // * `"off"`: Disables SafeSearch filtering. (default) * safe: 'placeholder-value', - * // Specifies the search type: image. + * // Specifies the search type: `image`. If unspecified, results are limited to + * // webpages. + * // + * // Acceptable values are: + * // + * // * `"image"`: custom image search. * searchType: 'placeholder-value', - * // Specifies all search results should be pages from a given site + * // Specifies a given site which should always be included or excluded from + * // results (see `siteSearchFilter` parameter, below). * siteSearch: 'placeholder-value', - * // 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 + * // `siteSearch` parameter. + * // + * // Acceptable values are: + * // + * // * `"e"`: exclude + * // + * // * `"i"`: include * siteSearchFilter: 'placeholder-value', - * // The sort expression to apply to the results + * // The sort expression to apply to the results. * sort: 'placeholder-value', - * // The index of the first result to return + * // The index of the first result to return. The default number of results per + * // page is 10, so `&start=11` would start at the top of the second page of + * // results. **Note**: The JSON API will never return more than 100 results, + * // even if more than 100 documents match the query, so setting the sum of + * // `start + num` to a number greater than 100 will produce an error. Also note + * // that the maximum value for `num` is 10. * start: 'placeholder-value', * }); * console.log(res.data); @@ -321,37 +744,37 @@ export namespace customsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.c2coff Turns off the translation between zh-CN and zh-TW. - * @param {string=} params.cr Country restrict(s). - * @param {string=} params.cx The custom search engine ID to scope this search query - * @param {string=} params.dateRestrict Specifies all search results are from a time period - * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain - * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results - * @param {string=} params.fileType Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... - * @param {string=} params.filter Controls turning on or off the duplicate content filter. - * @param {string=} params.gl Geolocation of end user. - * @param {string=} params.googlehost The local Google domain to use to perform the search. - * @param {string=} params.highRange Creates a range in form as_nlo value..as_nhi value and attempts to append it to query - * @param {string=} params.hl Sets the user interface language. - * @param {string=} params.hq Appends the extra query terms to the query. - * @param {string=} params.imgColorType Returns black and white, grayscale, or color images: mono, gray, and color. - * @param {string=} params.imgDominantColor Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown. - * @param {string=} params.imgSize Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge. - * @param {string=} params.imgType Returns images of a type, which can be one of: clipart, face, lineart, news, and photo. - * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL - * @param {string=} params.lowRange Creates a range in form as_nlo value..as_nhi value and attempts to append it to query - * @param {string=} params.lr The language restriction for the search results - * @param {integer=} params.num Number of search results to return - * @param {string=} params.orTerms 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 - * @param {string} params.q Query - * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL - * @param {string=} params.rights Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. - * @param {string=} params.safe Search safety level - * @param {string=} params.searchType Specifies the search type: image. - * @param {string=} params.siteSearch Specifies all search results should be pages from a given site - * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the as_sitesearch parameter - * @param {string=} params.sort The sort expression to apply to the results - * @param {integer=} params.start The index of the first result to return + * @param {string=} params.c2coff Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) + * @param {string=} params.cr Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter. + * @param {string=} params.cx The custom search engine ID to use for this request. + * @param {string=} params.dateRestrict Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. + * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain. + * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results. + * @param {string=} params.fileType Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). + * @param {string=} params.filter Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. + * @param {string=} params.gl Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. + * @param {string=} params.googlehost **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. + * @param {string=} params.highRange Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.hl Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. + * @param {string=} params.hq Appends the specified query terms to the query, as if they were combined with a logical AND operator. + * @param {string=} params.imgColorType Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background + * @param {string=} params.imgDominantColor Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` + * @param {string=} params.imgSize Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` + * @param {string=} params.imgType Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` + * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL. + * @param {string=} params.lowRange Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.lr Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional) + * @param {integer=} params.num Number of search results to return. * Valid values are integers between 1 and 10, inclusive. + * @param {string=} params.orTerms 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. + * @param {string=} params.q Query + * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL. + * @param {string=} params.rights Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). + * @param {string=} params.safe Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) + * @param {string=} params.searchType Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. + * @param {string=} params.siteSearch Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). + * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include + * @param {string=} params.sort The sort expression to apply to the results. + * @param {integer=} params.start The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. * @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 @@ -391,7 +814,7 @@ export namespace customsearch_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://customsearch.googleapis.com/'; const parameters = { options: Object.assign( { @@ -401,7 +824,7 @@ export namespace customsearch_v1 { options ), params, - requiredParams: ['q'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -420,91 +843,91 @@ export namespace customsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Turns off the translation between zh-CN and zh-TW. + * Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) */ c2coff?: string; /** - * Country restrict(s). + * Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter. */ cr?: string; /** - * The custom search engine ID to scope this search query + * The custom search engine ID to use for this request. */ cx?: string; /** - * Specifies all search results are from a time period + * Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. */ dateRestrict?: string; /** - * Identifies a phrase that all documents in the search results must contain + * Identifies a phrase that all documents in the search results must contain. */ 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, ... + * Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). */ fileType?: string; /** - * Controls turning on or off the duplicate content filter. + * Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. */ filter?: string; /** - * Geolocation of end user. + * Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. */ gl?: string; /** - * The local Google domain to use to perform the search. + * **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. */ googlehost?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ highRange?: string; /** - * Sets the user interface language. + * Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. */ hl?: string; /** - * Appends the extra query terms to the query. + * Appends the specified query terms to the query, as if they were combined with a logical AND operator. */ hq?: string; /** - * Returns black and white, grayscale, or color images: mono, gray, and color. + * Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */ 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. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` */ 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. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */ imgSize?: string; /** - * Returns images of a type, which can be one of: clipart, face, lineart, news, and photo. + * Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */ 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 + * Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ lowRange?: string; /** - * The language restriction for the search results + * Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional) */ lr?: string; /** - * Number of search results to return + * Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */ 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; /** @@ -512,35 +935,35 @@ 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. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). */ rights?: string; /** - * Search safety level + * Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */ safe?: string; /** - * Specifies the search type: image. + * Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */ searchType?: string; /** - * Specifies all search results should be pages from a given site + * Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */ 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 `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */ siteSearchFilter?: string; /** - * The sort expression to apply to the results + * The sort expression to apply to the results. */ sort?: string; /** - * The index of the first result to return + * The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. */ start?: number; } @@ -578,67 +1001,307 @@ export namespace customsearch_v1 { * * // Do the magic * const res = await search.cse.siterestrict.list({ - * // Turns off the translation between zh-CN and zh-TW. + * // Enables or disables [Simplified and Traditional Chinese + * // Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). + * // + * // The default value for this parameter is 0 (zero), meaning that the feature + * // is enabled. Supported values are: + * // + * // * `1`: Disabled + * // + * // * `0`: Enabled (default) * c2coff: 'placeholder-value', - * // Country restrict(s). + * // Restricts search results to documents originating in a particular country. + * // You may use [Boolean + * // operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) + * // in the cr parameter's value. + * // + * // Google Search determines the country of a document by analyzing: + * // + * // * the top-level domain (TLD) of the document's URL + * // + * // * the geographic location of the Web server's IP address + * // + * // See the [Country Parameter + * // Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) + * // page for a list of valid values for this parameter. * cr: 'placeholder-value', - * // The custom search engine ID to scope this search query + * // The custom search engine ID to use for this request. * cx: 'placeholder-value', - * // Specifies all search results are from a time period + * // Restricts results to URLs based on date. Supported values include: + * // + * // * `d[number]`: requests results from the specified number of past days. + * // + * // * `w[number]`: requests results from the specified number of past weeks. + * // + * // * `m[number]`: requests results from the specified number of past months. + * // + * // * `y[number]`: requests results from the specified number of past years. * dateRestrict: 'placeholder-value', - * // Identifies a phrase that all documents in the search results must contain + * // Identifies a phrase that all documents in the search results must contain. * exactTerms: 'placeholder-value', - * // 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: 'placeholder-value', - * // Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... + * // Restricts results to files of a specified extension. A list of file types + * // indexable by Google can be found in Search Console [Help + * // Center](https://support.google.com/webmasters/answer/35287). * fileType: 'placeholder-value', * // Controls turning on or off the duplicate content filter. + * // + * // * See [Automatic + * // Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) + * // for more information about Google's search results filters. Note that host + * // crowding filtering applies only to multi-site searches. + * // + * // * By default, Google applies filtering to all search results to improve the + * // quality of those results. + * // + * // Acceptable values are: + * // + * // * `0`: Turns off duplicate content filter. + * // + * // * `1`: Turns on duplicate content filter. * filter: 'placeholder-value', * // Geolocation of end user. + * // + * // * The `gl` parameter value is a two-letter country code. The `gl` parameter + * // boosts search results whose country of origin matches the parameter value. + * // See the [Country + * // Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) + * // page for a list of valid values. + * // + * // * Specifying a `gl` parameter value should lead to more relevant results. + * // This is particularly true for international customers and, even more + * // specifically, for customers in English- speaking countries other than the + * // United States. * gl: 'placeholder-value', - * // The local Google domain to use to perform the search. + * // **Deprecated**. Use the `gl` parameter for a similar effect. + * // + * // The local Google domain (for example, google.com, google.de, or + * // google.fr) to use to perform the search. * googlehost: 'placeholder-value', - * // Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * // Specifies the ending value for a search range. + * // + * // * Use `lowRange` and `highRange` to append an inclusive search range of + * // `lowRange...highRange` to the query. * highRange: 'placeholder-value', * // Sets the user interface language. + * // + * // * Explicitly setting this parameter improves the performance and the + * // quality of your search results. + * // + * // * See the [Interface + * // Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) + * // section of [Internationalizing Queries and Results + * // Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) + * // for more information, and (Supported Interface + * // Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] + * // for a list of supported languages. * hl: 'placeholder-value', - * // Appends the extra query terms to the query. + * // Appends the specified query terms to the query, as if they were combined + * // with a logical AND operator. * hq: 'placeholder-value', - * // Returns black and white, grayscale, or color images: mono, gray, and color. + * // Returns black and white, grayscale, transparent, or color images. + * // Acceptable values are: + * // + * // * `"color"` + * // + * // * `"gray"` + * // + * // * `"mono"`: black and white + * // + * // * `"trans"`: transparent background * imgColorType: 'placeholder-value', - * // 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. Acceptable values are: + * // + * // * `"black"` + * // + * // * `"blue"` + * // + * // * `"brown"` + * // + * // * `"gray"` + * // + * // * `"green"` + * // + * // * `"orange"` + * // + * // * `"pink"` + * // + * // * `"purple"` + * // + * // * `"red"` + * // + * // * `"teal"` + * // + * // * `"white"` + * // + * // * `"yellow"` * imgDominantColor: 'placeholder-value', - * // 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. Acceptable values are: + * // + * // * `"huge"` + * // + * // * `"icon"` + * // + * // * `"large"` + * // + * // * `"medium"` + * // + * // * `"small"` + * // + * // * `"xlarge"` + * // + * // * `"xxlarge"` * imgSize: 'placeholder-value', - * // Returns images of a type, which can be one of: clipart, face, lineart, news, and photo. + * // Returns images of a type. Acceptable values are: + * // + * // * `"clipart"` + * // + * // * `"face"` + * // + * // * `"lineart"` + * // + * // * `"stock"` + * // + * // * `"photo"` + * // + * // * `"animated"` * imgType: 'placeholder-value', - * // 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: 'placeholder-value', - * // Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * // Specifies the starting value for a search range. Use `lowRange` and + * // `highRange` to append an inclusive search range of `lowRange...highRange` + * // to the query. * lowRange: 'placeholder-value', - * // The language restriction for the search results + * // Restricts the search to documents written in a particular language (e.g., + * // `lr=lang_ja`). + * // + * // Acceptable values are: + * // + * // * `"lang_ar"`: Arabic + * // + * // * `"lang_bg"`: Bulgarian + * // + * // * `"lang_ca"`: Catalan + * // + * // * `"lang_cs"`: Czech + * // + * // * `"lang_da"`: Danish + * // + * // * `"lang_de"`: German + * // + * // * `"lang_el"`: Greek + * // + * // * `"lang_en"`: English + * // + * // * `"lang_es"`: Spanish + * // + * // * `"lang_et"`: Estonian + * // + * // * `"lang_fi"`: Finnish + * // + * // * `"lang_fr"`: French + * // + * // * `"lang_hr"`: Croatian + * // + * // * `"lang_hu"`: Hungarian + * // + * // * `"lang_id"`: Indonesian + * // + * // * `"lang_is"`: Icelandic + * // + * // * `"lang_it"`: Italian + * // + * // * `"lang_iw"`: Hebrew + * // + * // * `"lang_ja"`: Japanese + * // + * // * `"lang_ko"`: Korean + * // + * // * `"lang_lt"`: Lithuanian + * // + * // * `"lang_lv"`: Latvian + * // + * // * `"lang_nl"`: Dutch + * // + * // * `"lang_no"`: Norwegian + * // + * // * `"lang_pl"`: Polish + * // + * // * `"lang_pt"`: Portuguese + * // + * // * `"lang_ro"`: Romanian + * // + * // * `"lang_ru"`: Russian + * // + * // * `"lang_sk"`: Slovak + * // + * // * `"lang_sl"`: Slovenian + * // + * // * `"lang_sr"`: Serbian + * // + * // * `"lang_sv"`: Swedish + * // + * // * `"lang_tr"`: Turkish + * // + * // * `"lang_zh-CN"`: Chinese (Simplified) + * // + * // * `"lang_zh-TW"`: Chinese (Traditional) * lr: 'placeholder-value', - * // Number of search results to return + * // Number of search results to return. + * // + * // * Valid values are integers between 1 and 10, inclusive. * num: 'placeholder-value', - * // 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: 'placeholder-value', * // Query * q: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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. See [typical + * // combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). * rights: 'placeholder-value', - * // Search safety level + * // Search safety level. Acceptable values are: + * // + * // * `"active"`: Enables SafeSearch filtering. + * // + * // * `"off"`: Disables SafeSearch filtering. (default) * safe: 'placeholder-value', - * // Specifies the search type: image. + * // Specifies the search type: `image`. If unspecified, results are limited to + * // webpages. + * // + * // Acceptable values are: + * // + * // * `"image"`: custom image search. * searchType: 'placeholder-value', - * // Specifies all search results should be pages from a given site + * // Specifies a given site which should always be included or excluded from + * // results (see `siteSearchFilter` parameter, below). * siteSearch: 'placeholder-value', - * // 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 + * // `siteSearch` parameter. + * // + * // Acceptable values are: + * // + * // * `"e"`: exclude + * // + * // * `"i"`: include * siteSearchFilter: 'placeholder-value', - * // The sort expression to apply to the results + * // The sort expression to apply to the results. * sort: 'placeholder-value', - * // The index of the first result to return + * // The index of the first result to return. The default number of results per + * // page is 10, so `&start=11` would start at the top of the second page of + * // results. **Note**: The JSON API will never return more than 100 results, + * // even if more than 100 documents match the query, so setting the sum of + * // `start + num` to a number greater than 100 will produce an error. Also note + * // that the maximum value for `num` is 10. * start: 'placeholder-value', * }); * console.log(res.data); @@ -665,37 +1328,37 @@ export namespace customsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.c2coff Turns off the translation between zh-CN and zh-TW. - * @param {string=} params.cr Country restrict(s). - * @param {string=} params.cx The custom search engine ID to scope this search query - * @param {string=} params.dateRestrict Specifies all search results are from a time period - * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain - * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results - * @param {string=} params.fileType Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... - * @param {string=} params.filter Controls turning on or off the duplicate content filter. - * @param {string=} params.gl Geolocation of end user. - * @param {string=} params.googlehost The local Google domain to use to perform the search. - * @param {string=} params.highRange Creates a range in form as_nlo value..as_nhi value and attempts to append it to query - * @param {string=} params.hl Sets the user interface language. - * @param {string=} params.hq Appends the extra query terms to the query. - * @param {string=} params.imgColorType Returns black and white, grayscale, or color images: mono, gray, and color. - * @param {string=} params.imgDominantColor Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown. - * @param {string=} params.imgSize Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge. - * @param {string=} params.imgType Returns images of a type, which can be one of: clipart, face, lineart, news, and photo. - * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL - * @param {string=} params.lowRange Creates a range in form as_nlo value..as_nhi value and attempts to append it to query - * @param {string=} params.lr The language restriction for the search results - * @param {integer=} params.num Number of search results to return - * @param {string=} params.orTerms 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 - * @param {string} params.q Query - * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL - * @param {string=} params.rights Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. - * @param {string=} params.safe Search safety level - * @param {string=} params.searchType Specifies the search type: image. - * @param {string=} params.siteSearch Specifies all search results should be pages from a given site - * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the as_sitesearch parameter - * @param {string=} params.sort The sort expression to apply to the results - * @param {integer=} params.start The index of the first result to return + * @param {string=} params.c2coff Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) + * @param {string=} params.cr Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter. + * @param {string=} params.cx The custom search engine ID to use for this request. + * @param {string=} params.dateRestrict Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. + * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain. + * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results. + * @param {string=} params.fileType Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). + * @param {string=} params.filter Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. + * @param {string=} params.gl Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. + * @param {string=} params.googlehost **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. + * @param {string=} params.highRange Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.hl Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. + * @param {string=} params.hq Appends the specified query terms to the query, as if they were combined with a logical AND operator. + * @param {string=} params.imgColorType Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background + * @param {string=} params.imgDominantColor Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` + * @param {string=} params.imgSize Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` + * @param {string=} params.imgType Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` + * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL. + * @param {string=} params.lowRange Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.lr Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional) + * @param {integer=} params.num Number of search results to return. * Valid values are integers between 1 and 10, inclusive. + * @param {string=} params.orTerms 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. + * @param {string=} params.q Query + * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL. + * @param {string=} params.rights Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). + * @param {string=} params.safe Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) + * @param {string=} params.searchType Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. + * @param {string=} params.siteSearch Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). + * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include + * @param {string=} params.sort The sort expression to apply to the results. + * @param {integer=} params.start The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. * @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 @@ -736,7 +1399,7 @@ export namespace customsearch_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://customsearch.googleapis.com/'; const parameters = { options: Object.assign( { @@ -749,7 +1412,7 @@ export namespace customsearch_v1 { options ), params, - requiredParams: ['q'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -769,91 +1432,91 @@ export namespace customsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Turns off the translation between zh-CN and zh-TW. + * Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) */ c2coff?: string; /** - * Country restrict(s). + * Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter. */ cr?: string; /** - * The custom search engine ID to scope this search query + * The custom search engine ID to use for this request. */ cx?: string; /** - * Specifies all search results are from a time period + * Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. */ dateRestrict?: string; /** - * Identifies a phrase that all documents in the search results must contain + * Identifies a phrase that all documents in the search results must contain. */ 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, ... + * Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). */ fileType?: string; /** - * Controls turning on or off the duplicate content filter. + * Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. */ filter?: string; /** - * Geolocation of end user. + * Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. */ gl?: string; /** - * The local Google domain to use to perform the search. + * **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. */ googlehost?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ highRange?: string; /** - * Sets the user interface language. + * Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. */ hl?: string; /** - * Appends the extra query terms to the query. + * Appends the specified query terms to the query, as if they were combined with a logical AND operator. */ hq?: string; /** - * Returns black and white, grayscale, or color images: mono, gray, and color. + * Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */ 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. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` */ 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. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */ imgSize?: string; /** - * Returns images of a type, which can be one of: clipart, face, lineart, news, and photo. + * Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */ 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 + * Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ lowRange?: string; /** - * The language restriction for the search results + * Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional) */ lr?: string; /** - * Number of search results to return + * Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */ 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; /** @@ -861,35 +1524,35 @@ 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. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). */ rights?: string; /** - * Search safety level + * Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */ safe?: string; /** - * Specifies the search type: image. + * Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */ searchType?: string; /** - * Specifies all search results should be pages from a given site + * Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */ 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 `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */ siteSearchFilter?: string; /** - * The sort expression to apply to the results + * The sort expression to apply to the results. */ sort?: string; /** - * The index of the first result to return + * The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. */ start?: number; } diff --git a/src/apis/datacatalog/v1beta1.ts b/src/apis/datacatalog/v1beta1.ts index d70d7c724fc..5fa02ffc63a 100644 --- a/src/apis/datacatalog/v1beta1.ts +++ b/src/apis/datacatalog/v1beta1.ts @@ -380,7 +380,7 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest { /** - * Inline source used for taxonomies import + * Inline source used for taxonomies to be imported. */ inlineSource?: Schema$GoogleCloudDatacatalogV1beta1InlineSource; } @@ -551,6 +551,10 @@ export namespace datacatalog_v1beta1 { * The list of project IDs to search within. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects. */ includeProjectIds?: string[] | null; + /** + * Optional. The list of locations to search within. 1. If empty, search will be performed in all locations; 2. If any of the locations are NOT in the valid locations list, error will be returned; 3. Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the `SearchCatalogResponse.unreachable` field, users can repeat the search request with this parameter set to get additional information on the error. Valid locations: * asia-east1 * asia-east2 * asia-northeast1 * asia-northeast2 * asia-northeast3 * asia-south1 * asia-southeast1 * australia-southeast1 * eu * europe-north1 * europe-west1 * europe-west2 * europe-west3 * europe-west4 * europe-west6 * global * northamerica-northeast1 * southamerica-east1 * us * us-central1 * us-east1 * us-east4 * us-west1 * us-west2 + */ + restrictedLocations?: string[] | null; } /** * Response message for SearchCatalog. @@ -564,6 +568,10 @@ export namespace datacatalog_v1beta1 { * Search results. */ results?: Schema$GoogleCloudDatacatalogV1beta1SearchCatalogResult[]; + /** + * Unreachable locations. Search result does not include data from those locations. Users can get additional information on the error by repeating the search request with a more restrictive parameter -- setting the value for `SearchDataCatalogRequest.scope.include_locations`. + */ + unreachable?: string[] | null; } /** * A result that appears in the response of a search request. Each result captures details of one entry that matches the search. @@ -602,6 +610,10 @@ export namespace datacatalog_v1beta1 { * Required. Display name of the policy tag. Max 200 bytes when encoded in UTF-8. */ displayName?: string | null; + /** + * Resource name of the policy tag. This field will be ignored when calling ImportTaxonomies. + */ + policyTag?: string | null; } /** * Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation. @@ -884,7 +896,8 @@ export namespace datacatalog_v1beta1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "results": [] + * // "results": [], + * // "unreachable": [] * // } * } * @@ -7346,8 +7359,7 @@ export namespace datacatalog_v1beta1 { * * // Do the magic * const res = await datacatalog.projects.locations.taxonomies.import({ - * // Required. Resource name of project that the newly created taxonomies will - * // belong to. + * // Required. Resource name of project that the imported taxonomies will belong to. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -7375,7 +7387,7 @@ export namespace datacatalog_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Resource name of project that the newly created taxonomies will belong to. + * @param {string} params.parent Required. Resource name of project that the imported taxonomies will belong to. * @param {().GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest} params.requestBody 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. @@ -8114,7 +8126,7 @@ export namespace datacatalog_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of project that the newly created taxonomies will belong to. + * Required. Resource name of project that the imported taxonomies will belong to. */ parent?: string; diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 70dac5af6b4..008c2e66ee9 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -470,7 +470,7 @@ export namespace dialogflow_v2 { */ events?: string[] | null; /** - * 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. + * Output 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[]; /** @@ -494,7 +494,7 @@ export namespace dialogflow_v2 { */ mlEnabled?: boolean | null; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. + * Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ name?: string | null; /** @@ -506,11 +506,11 @@ 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>`. + * Optional. 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 | null; /** - * The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. + * Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. */ priority?: number | null; /** @@ -518,7 +518,7 @@ export namespace dialogflow_v2 { */ resetContexts?: boolean | null; /** - * 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>`. + * Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ rootFollowupIntentName?: string | null; /** @@ -1342,7 +1342,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata { /** - * Required. The current state of this operation. + * Required. Output only. The current state of this operation. */ state?: string | null; } @@ -1514,31 +1514,31 @@ export namespace dialogflow_v2 { */ endInteraction?: boolean | null; /** - * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. + * Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. */ 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 rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller. */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; /** - * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. + * Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller. */ fulfillmentText?: string | null; /** - * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. + * Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller. */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** - * Optional. This field can be used to pass custom data from your webhook to the API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate `QueryResult.webhook_payload` sent to the API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + * Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) */ payload?: {[key: string]: any} | null; /** - * 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. Setting the session entity types inside webhook overwrites the session entity types that have been set through `DetectIntentRequest.query_params.session_entity_types`. + * 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. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[]; /** - * Optional. This value is passed directly to `QueryResult.webhook_source`. + * Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller. */ source?: string | null; } @@ -1796,7 +1796,7 @@ export namespace dialogflow_v2 { */ requestHeaders?: {[key: string]: string} | null; /** - * Required. The fulfillment URI for receiving POST requests. + * Required. The fulfillment URI for receiving POST requests. It must use https protocol. */ uri?: string | null; /** @@ -2847,7 +2847,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2SpeechContext { /** - * Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search. + * Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search. */ boost?: number | null; /** @@ -2962,34 +2962,47 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2WebhookResponse { /** - * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. + * Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. */ 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 rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller. */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. + * Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller. */ fulfillmentText?: string | null; /** - * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. + * Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller. */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** - * Optional. This field can be used to pass custom data from your webhook to the API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate `QueryResult.webhook_payload` sent to the API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + * Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) */ payload?: {[key: string]: any} | null; /** - * 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. Setting the session entity types inside webhook overwrites the session entity types that have been set through `DetectIntentRequest.query_params.session_entity_types`. + * 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. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2SessionEntityType[]; /** - * Optional. This value is passed directly to `QueryResult.webhook_source`. + * Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller. */ source?: string | null; } + /** + * The response message for Agents.ExportAgent. + */ + export interface Schema$GoogleCloudDialogflowV3alpha1ExportAgentResponse { + /** + * Uncompressed raw byte content for agent. + */ + agentContent?: string | null; + /** + * The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest. + */ + agentUri?: string | null; + } /** * The response message for Operations.ListOperations. */ diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 93f6cb9a9f3..bd43bea417c 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -463,7 +463,7 @@ export namespace dialogflow_v2beta1 { */ mimeType?: string | null; /** - * The document resource name. The name must be empty when creating a document. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. + * Optional. 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 | null; /** @@ -650,7 +650,7 @@ export namespace dialogflow_v2beta1 { */ requestHeaders?: {[key: string]: string} | null; /** - * Required. The fulfillment URI for receiving POST requests. + * Required. The fulfillment URI for receiving POST requests. It must use https protocol. */ uri?: string | null; /** @@ -746,7 +746,7 @@ export namespace dialogflow_v2beta1 { */ events?: string[] | null; /** - * 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. + * Output 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[]; /** @@ -770,7 +770,7 @@ export namespace dialogflow_v2beta1 { */ mlEnabled?: boolean | null; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. + * Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ name?: string | null; /** @@ -782,11 +782,11 @@ 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>`. + * Optional. 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 | null; /** - * The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. + * Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. */ priority?: number | null; /** @@ -794,7 +794,7 @@ export namespace dialogflow_v2beta1 { */ resetContexts?: boolean | null; /** - * 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>`. + * Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ rootFollowupIntentName?: string | null; /** @@ -1644,7 +1644,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata { /** - * Required. The current state of this operation. + * Required. Output only. The current state of this operation. */ state?: string | null; } @@ -2001,7 +2001,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1SpeechContext { /** - * Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search. + * Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search. */ boost?: number | null; /** @@ -2137,31 +2137,31 @@ export namespace dialogflow_v2beta1 { */ endInteraction?: boolean | null; /** - * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. + * Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. */ 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 rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller. */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; /** - * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. + * Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller. */ fulfillmentText?: string | null; /** - * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. + * Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller. */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** - * Optional. This field can be used to pass custom data from your webhook to the API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate `QueryResult.webhook_payload` sent to the API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + * Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) */ payload?: {[key: string]: any} | null; /** - * 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. Setting the session entity types inside webhook overwrites the session entity types that have been set through `DetectIntentRequest.query_params.session_entity_types`. + * 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. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[]; /** - * Optional. This value is passed directly to `QueryResult.webhook_source`. + * Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller. */ source?: string | null; } @@ -3109,34 +3109,47 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2WebhookResponse { /** - * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. + * Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. */ 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 rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller. */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. + * Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller. */ fulfillmentText?: string | null; /** - * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. + * Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller. */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** - * Optional. This field can be used to pass custom data from your webhook to the API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate `QueryResult.webhook_payload` sent to the API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + * Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) */ payload?: {[key: string]: any} | null; /** - * 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. Setting the session entity types inside webhook overwrites the session entity types that have been set through `DetectIntentRequest.query_params.session_entity_types`. + * 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. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2SessionEntityType[]; /** - * Optional. This value is passed directly to `QueryResult.webhook_source`. + * Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller. */ source?: string | null; } + /** + * The response message for Agents.ExportAgent. + */ + export interface Schema$GoogleCloudDialogflowV3alpha1ExportAgentResponse { + /** + * Uncompressed raw byte content for agent. + */ + agentContent?: string | null; + /** + * The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest. + */ + agentUri?: string | null; + } /** * The response message for Operations.ListOperations. */ @@ -4411,7 +4424,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). * @example * // Before running the sample: * // - Enable the API at: @@ -4999,7 +5012,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 * @example * // Before running the sample: * // - Enable the API at: @@ -5136,7 +5149,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 * @example * // Before running the sample: * // - Enable the API at: @@ -9752,7 +9765,7 @@ export namespace dialogflow_v2beta1 { * // [Multilingual intent and entity * // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). * languageCode: 'placeholder-value', - * // The unique identifier of this intent. + * // Optional. The unique identifier of this intent. * // Required for Intents.UpdateIntent and Intents.BatchUpdateIntents * // methods. * // Format: `projects//agent/intents/`. @@ -9825,7 +9838,7 @@ export namespace dialogflow_v2beta1 { * @param {object} params Parameters for request * @param {string=} params.intentView Optional. The resource view to apply to the returned intent. * @param {string=} params.languageCode Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - * @param {string} params.name The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. + * @param {string} params.name Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1Intent} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10036,7 +10049,7 @@ export namespace dialogflow_v2beta1 { */ languageCode?: string; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. + * Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. */ name?: string; /** @@ -10904,7 +10917,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.agent.knowledgeBases.documents.create({ - * // Required. The knoweldge base to create a document for. + * // The knoweldge base to create a document for. * // Format: `projects//knowledgeBases/`. * parent: 'projects/my-project/agent/knowledgeBases/my-knowledgeBase', * @@ -10945,7 +10958,7 @@ export namespace dialogflow_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. + * @param {string} params.parent The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. * @param {().GoogleCloudDialogflowV2beta1Document} params.requestBody 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. @@ -11050,7 +11063,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.agent.knowledgeBases.documents.delete({ - * // The name of the document to delete. + * // Required. The name of the document to delete. * // Format: `projects//knowledgeBases//documents/`. * name: @@ -11077,7 +11090,7 @@ export namespace dialogflow_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the document to delete. Format: `projects//knowledgeBases//documents/`. + * @param {string} params.name Required. The name of the document to delete. Format: `projects//knowledgeBases//documents/`. * @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 @@ -11470,7 +11483,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.agent.knowledgeBases.documents.patch({ - * // The document resource name. + * // Optional. The document resource name. * // The name must be empty when creating a document. * // Format: `projects//knowledgeBases//documents/`. @@ -11518,7 +11531,7 @@ export namespace dialogflow_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. + * @param {string} params.name Optional. The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. * @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. * @param {().GoogleCloudDialogflowV2beta1Document} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11621,7 +11634,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.agent.knowledgeBases.documents.reload({ - * // The name of the document to reload. + * // Required. The name of the document to reload. * // Format: `projects//knowledgeBases//documents/` * name: @@ -11656,7 +11669,7 @@ export namespace dialogflow_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the document to reload. Format: `projects//knowledgeBases//documents/` + * @param {string} params.name Required. The name of the document to reload. Format: `projects//knowledgeBases//documents/` * @param {().GoogleCloudDialogflowV2beta1ReloadDocumentRequest} params.requestBody 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. @@ -11740,7 +11753,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. + * The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. */ parent?: string; @@ -11757,7 +11770,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the document to delete. Format: `projects//knowledgeBases//documents/`. + * Required. The name of the document to delete. Format: `projects//knowledgeBases//documents/`. */ name?: string; } @@ -11801,7 +11814,7 @@ 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/`. + * Optional. The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. */ name?: string; /** @@ -11822,7 +11835,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the document to reload. Format: `projects//knowledgeBases//documents/` + * Required. The name of the document to reload. Format: `projects//knowledgeBases//documents/` */ name?: string; @@ -14651,7 +14664,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.knowledgeBases.documents.create({ - * // Required. The knoweldge base to create a document for. + * // The knoweldge base to create a document for. * // Format: `projects//knowledgeBases/`. * parent: 'projects/my-project/knowledgeBases/my-knowledgeBase', * @@ -14692,7 +14705,7 @@ export namespace dialogflow_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. + * @param {string} params.parent The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. * @param {().GoogleCloudDialogflowV2beta1Document} params.requestBody 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. @@ -14797,7 +14810,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.knowledgeBases.documents.delete({ - * // The name of the document to delete. + * // Required. The name of the document to delete. * // Format: `projects//knowledgeBases//documents/`. * name: @@ -14824,7 +14837,7 @@ export namespace dialogflow_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the document to delete. Format: `projects//knowledgeBases//documents/`. + * @param {string} params.name Required. The name of the document to delete. Format: `projects//knowledgeBases//documents/`. * @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 @@ -15217,7 +15230,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.knowledgeBases.documents.patch({ - * // The document resource name. + * // Optional. The document resource name. * // The name must be empty when creating a document. * // Format: `projects//knowledgeBases//documents/`. @@ -15265,7 +15278,7 @@ export namespace dialogflow_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. + * @param {string} params.name Optional. The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. * @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. * @param {().GoogleCloudDialogflowV2beta1Document} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15368,7 +15381,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.knowledgeBases.documents.reload({ - * // The name of the document to reload. + * // Required. The name of the document to reload. * // Format: `projects//knowledgeBases//documents/` * name: @@ -15403,7 +15416,7 @@ export namespace dialogflow_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the document to reload. Format: `projects//knowledgeBases//documents/` + * @param {string} params.name Required. The name of the document to reload. Format: `projects//knowledgeBases//documents/` * @param {().GoogleCloudDialogflowV2beta1ReloadDocumentRequest} params.requestBody 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. @@ -15487,7 +15500,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. + * The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. */ parent?: string; @@ -15504,7 +15517,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the document to delete. Format: `projects//knowledgeBases//documents/`. + * Required. The name of the document to delete. Format: `projects//knowledgeBases//documents/`. */ name?: string; } @@ -15548,7 +15561,7 @@ 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/`. + * Optional. The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. */ name?: string; /** @@ -15569,7 +15582,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the document to reload. Format: `projects//knowledgeBases//documents/` + * Required. The name of the document to reload. Format: `projects//knowledgeBases//documents/` */ name?: string; @@ -17033,7 +17046,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.locations.agent.entityTypes.batchDelete - * @desc Deletes entity types in the specified agent. Operation + * @desc Deletes entity types in the specified agent. Operation * @example * // Before running the sample: * // - Enable the API at: @@ -17172,7 +17185,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.locations.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 * @example * // Before running the sample: * // - Enable the API at: @@ -21804,7 +21817,7 @@ export namespace dialogflow_v2beta1 { * // [Multilingual intent and entity * // data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). * languageCode: 'placeholder-value', - * // The unique identifier of this intent. + * // Optional. The unique identifier of this intent. * // Required for Intents.UpdateIntent and Intents.BatchUpdateIntents * // methods. * // Format: `projects//agent/intents/`. @@ -21877,7 +21890,7 @@ export namespace dialogflow_v2beta1 { * @param {object} params Parameters for request * @param {string=} params.intentView Optional. The resource view to apply to the returned intent. * @param {string=} params.languageCode Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). - * @param {string} params.name The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. + * @param {string} params.name Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1Intent} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22088,7 +22101,7 @@ export namespace dialogflow_v2beta1 { */ languageCode?: string; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. + * Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. */ name?: string; /** diff --git a/src/apis/displayvideo/v1.ts b/src/apis/displayvideo/v1.ts index d0d84511e15..fba59ba1921 100644 --- a/src/apis/displayvideo/v1.ts +++ b/src/apis/displayvideo/v1.ts @@ -1970,6 +1970,10 @@ export namespace displayvideo_v1 { * Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. */ budgetAmountMicros?: string | null; + /** + * The ID of the campaign budget linked to this insertion order budget segment. + */ + campaignBudgetId?: string | null; /** * Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. */ diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index cc58046f0ec..6bf75ffd2a2 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -1284,11 +1284,11 @@ export namespace dlp_v2 { */ bucketSize?: number | null; /** - * 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. 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". */ lowerBound?: Schema$GooglePrivacyDlpV2Value; /** - * 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. 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+". */ upperBound?: Schema$GooglePrivacyDlpV2Value; } diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index cfae242cab0..95886eec83a 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -970,7 +970,7 @@ export namespace firebase_v1beta1 { /** * firebase.projects.addFirebase - * @desc Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects).

Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` uses underlying GCP identifiers (most importantly, the `projectId`) as its own for easy interop with GCP APIs.

The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation.

This method does not modify any billing account information on the underlying GCP `Project`.

To call `AddFirebase`, a member must be an Editor or Owner for the existing GCP `Project`. Service accounts cannot call `AddFirebase`. + * @desc Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects).

Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` uses underlying GCP identifiers (most importantly, the `projectId`) as its own for easy interop with GCP APIs.

The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation.

This method does not modify any billing account information on the underlying GCP `Project`.

To call `AddFirebase`, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): `firebase.projects.update`, `resourcemanager.projects.get`, `serviceusage.services.enable`, and `serviceusage.services.get`. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/gameservices/v1beta.ts b/src/apis/gameservices/v1beta.ts index 33392a1e7c3..3458c8a0253 100644 --- a/src/apis/gameservices/v1beta.ts +++ b/src/apis/gameservices/v1beta.ts @@ -155,7 +155,7 @@ export namespace gameservices_v1beta { */ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -246,7 +246,7 @@ export namespace gameservices_v1beta { logMode?: string | null; } /** - * The Game Server Cluster changes made by the Game Server Deployment. + * The game server cluster changes made by the game server deployment. */ export interface Schema$DeployedClusterState { /** @@ -254,7 +254,7 @@ export namespace gameservices_v1beta { */ cluster?: string | null; /** - * The details about the Agones fleets and autoscalers created in the Game Server Cluster. + * The details about the Agones fleets and autoscalers created in the game server cluster. */ fleetDetails?: Schema$DeployedFleetDetails[]; } @@ -364,11 +364,11 @@ export namespace gameservices_v1beta { */ export interface Schema$FetchDeploymentStateResponse { /** - * The state of the Game Server Deployment in each Game Server Cluster. + * The state of the game server deployment in each game server cluster. */ clusterState?: Schema$DeployedClusterState[]; /** - * List of Locations that could not be reached. + * List of locations that could not be reached. */ unavailable?: string[] | null; } @@ -386,11 +386,11 @@ export namespace gameservices_v1beta { name?: string | null; } /** - * A Game Server Cluster resource. + * A game server cluster resource. */ export interface Schema$GameServerCluster { /** - * Game Server Cluster connection information. This information is used to manage Game Server Clusters. + * The game server cluster connection information. This information is used to manage game server clusters. */ connectionInfo?: Schema$GameServerClusterConnectionInfo; /** @@ -406,11 +406,11 @@ export namespace gameservices_v1beta { */ etag?: string | null; /** - * The labels associated with this Game Server Cluster. Each label is a key-value pair. + * The labels associated with this game server cluster. Each label is a key-value pair. */ labels?: {[key: string]: string} | null; /** - * Required. The resource name of the Game Server Cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. + * Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. */ name?: string | null; /** @@ -419,7 +419,7 @@ export namespace gameservices_v1beta { updateTime?: string | null; } /** - * The Game Server Cluster connection information. + * The game server cluster connection information. */ export interface Schema$GameServerClusterConnectionInfo { /** @@ -427,12 +427,12 @@ export namespace gameservices_v1beta { */ gkeClusterReference?: Schema$GkeClusterReference; /** - * Namespace designated on the Game Server Cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation. + * Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation. */ namespace?: string | null; } /** - * A Game Server Config resource. + * A game server config resource. */ export interface Schema$GameServerConfig { /** @@ -440,7 +440,7 @@ export namespace gameservices_v1beta { */ createTime?: string | null; /** - * The description of the Game Server Config. + * The description of the game server config. */ description?: string | null; /** @@ -448,11 +448,11 @@ export namespace gameservices_v1beta { */ fleetConfigs?: Schema$FleetConfig[]; /** - * The labels associated with this Game Server Config. Each label is a key-value pair. + * The labels associated with this game server config. Each label is a key-value pair. */ labels?: {[key: string]: string} | null; /** - * The resource name of the Game Server Config. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`. + * The resource name of the game server config. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`. */ name?: string | null; /** @@ -465,7 +465,7 @@ export namespace gameservices_v1beta { updateTime?: string | null; } /** - * A Game Server Config override. + * A game server config override. */ export interface Schema$GameServerConfigOverride { /** @@ -478,7 +478,7 @@ export namespace gameservices_v1beta { realmsSelector?: Schema$RealmSelector; } /** - * A Game Server Deployment resource. + * A game server deployment resource. */ export interface Schema$GameServerDeployment { /** @@ -486,7 +486,7 @@ export namespace gameservices_v1beta { */ createTime?: string | null; /** - * Human readable description of the Game Server Deployment. + * Human readable description of the game server delpoyment. */ description?: string | null; /** @@ -494,11 +494,11 @@ export namespace gameservices_v1beta { */ etag?: string | null; /** - * The labels associated with this Game Server Deployment. Each label is a key-value pair. + * The labels associated with this game server deployment. Each label is a key-value pair. */ labels?: {[key: string]: string} | null; /** - * The resource name of the Game Server Deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`. + * The resource name of the game server deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`. */ name?: string | null; /** @@ -507,7 +507,7 @@ export namespace gameservices_v1beta { updateTime?: string | null; } /** - * The Game Server Deployment Rollout which represents the desired rollout state. + * The game server deployment rollout which represents the desired rollout state. */ export interface Schema$GameServerDeploymentRollout { /** @@ -515,7 +515,7 @@ export namespace gameservices_v1beta { */ createTime?: string | null; /** - * The default Game Server Config is applied to all Realms unless overridden in the Rollout. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`. + * The default game server config is applied to all realms unless overridden in the rollout. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`. */ defaultGameServerConfig?: string | null; /** @@ -523,11 +523,11 @@ export namespace gameservices_v1beta { */ etag?: string | null; /** - * Contains the Game Server Config Rollout overrides. Overrides are processed in the order they are listed. Once a match is found for a Realm, the rest of the list is not processed. + * Contains the game server config rollout overrides. Overrides are processed in the order they are listed. Once a match is found for a realm, the rest of the list is not processed. */ gameServerConfigOverrides?: Schema$GameServerConfigOverride[]; /** - * The resource name of the Game Server Deployment Rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. + * The resource name of the game server deployment rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. */ name?: string | null; /** @@ -558,7 +558,7 @@ export namespace gameservices_v1beta { */ export interface Schema$ListGameServerClustersResponse { /** - * The list of Game Server Clusters. + * The list of game server clusters. */ gameServerClusters?: Schema$GameServerCluster[]; /** @@ -566,7 +566,7 @@ export namespace gameservices_v1beta { */ nextPageToken?: string | null; /** - * List of Locations that could not be reached. + * List of locations that could not be reached. */ unreachable?: string[] | null; } @@ -575,7 +575,7 @@ export namespace gameservices_v1beta { */ export interface Schema$ListGameServerConfigsResponse { /** - * The list of Game Server Configs. + * The list of game server configs. */ gameServerConfigs?: Schema$GameServerConfig[]; /** @@ -583,7 +583,7 @@ export namespace gameservices_v1beta { */ nextPageToken?: string | null; /** - * List of Locations that could not be reached. + * List of locations that could not be reached. */ unreachable?: string[] | null; } @@ -592,7 +592,7 @@ export namespace gameservices_v1beta { */ export interface Schema$ListGameServerDeploymentsResponse { /** - * The list of Game Server Delpoyments. + * The list of game server deployments. */ gameServerDeployments?: Schema$GameServerDeployment[]; /** @@ -600,7 +600,7 @@ export namespace gameservices_v1beta { */ nextPageToken?: string | null; /** - * List of Locations that could not be reached. + * List of locations that could not be reached. */ unreachable?: string[] | null; } @@ -639,11 +639,11 @@ export namespace gameservices_v1beta { */ nextPageToken?: string | null; /** - * The list of Realms. + * The list of realms. */ realms?: Schema$Realm[]; /** - * List of Locations that could not be reached. + * List of locations that could not be reached. */ unreachable?: string[] | null; } @@ -731,7 +731,7 @@ export namespace gameservices_v1beta { */ endTime?: string | null; /** - * Output only. Operation status for gameservices API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message. + * Output only. Operation status for Game Services API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message. */ operationStatus?: {[key: string]: Schema$OperationStatus} | null; /** @@ -770,7 +770,7 @@ export namespace gameservices_v1beta { errorMessage?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -791,7 +791,7 @@ export namespace gameservices_v1beta { */ rules?: Schema$Rule[]; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -826,7 +826,7 @@ export namespace gameservices_v1beta { */ export interface Schema$PreviewGameServerDeploymentRolloutResponse { /** - * ETag of the Game Server Deployment. + * ETag of the game server deployment. */ etag?: string | null; /** @@ -865,7 +865,7 @@ export namespace gameservices_v1beta { targetState?: Schema$TargetState; } /** - * A Realm resource. + * A realm resource. */ export interface Schema$Realm { /** @@ -873,7 +873,7 @@ export namespace gameservices_v1beta { */ createTime?: string | null; /** - * Human readable description of the Realm. + * Human readable description of the realm. */ description?: string | null; /** @@ -881,15 +881,15 @@ export namespace gameservices_v1beta { */ etag?: string | null; /** - * The labels associated with this Realm. Each label is a key-value pair. + * The labels associated with this realm. Each label is a key-value pair. */ labels?: {[key: string]: string} | null; /** - * The resource name of the Realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. + * The resource name of the realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. */ name?: string | null; /** - * Required. Time zone where all policies targeting this Realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones. + * Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones. */ timeZone?: string | null; /** @@ -898,11 +898,11 @@ export namespace gameservices_v1beta { updateTime?: string | null; } /** - * The Realm selector, used to match Realm resources. + * The realm selector, used to match realm resources. */ export interface Schema$RealmSelector { /** - * List of Realms to match. + * List of realms to match. */ realms?: string[] | null; } @@ -956,7 +956,7 @@ export namespace gameservices_v1beta { */ schedules?: Schema$Schedule[]; /** - * Labels used to identify the Game Server Clusters to which this Agones scaling config applies. A Game Server Cluster is subject to this Agones scaling config if its labels match any of the selector entries. + * Labels used to identify the game server clusters to which this Agones scaling config applies. A game server cluster is subject to this Agones scaling config if its labels match any of the selector entries. */ selectors?: Schema$LabelSelector[]; } @@ -969,7 +969,7 @@ export namespace gameservices_v1beta { */ cronJobDuration?: string | null; /** - * The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the Realm. + * The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm. */ cronSpec?: string | null; /** @@ -999,7 +999,7 @@ export namespace gameservices_v1beta { */ export interface Schema$SpecSource { /** - * The Game Server Config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`. + * The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`. */ gameServerConfigName?: string | null; /** @@ -1029,15 +1029,15 @@ export namespace gameservices_v1beta { */ export interface Schema$TargetDetails { /** - * Agones fleet details for Game Server Clusters and Game Server Deployments. + * Agones fleet details for game server clusters and game server deployments. */ fleetDetails?: Schema$TargetFleetDetails[]; /** - * The Game Server Cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. + * The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. */ gameServerClusterName?: string | null; /** - * The Game Server Deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`. + * The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`. */ gameServerDeploymentName?: string | null; } @@ -1430,7 +1430,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.create - * @desc Creates a new Game Server Deployment in a given project and Location. + * @desc Creates a new game server deployment in a given project and location. * @example * // Before running the sample: * // - Enable the API at: @@ -1456,7 +1456,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.create( * { - * // Required. The ID of the Game Server Deployment resource to be created. + * // Required. The ID of the game server delpoyment resource to be created. * deploymentId: 'placeholder-value', * // Required. The parent resource name. Uses the form: * // `projects/{project}/locations/{location}`. @@ -1497,7 +1497,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.deploymentId Required. The ID of the Game Server Deployment resource to be created. + * @param {string=} params.deploymentId Required. The ID of the game server delpoyment resource to be created. * @param {string} params.parent Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`. * @param {().GameServerDeployment} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1568,7 +1568,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.delete - * @desc Deletes a single Game Server Deployment. + * @desc Deletes a single game server deployment. * @example * // Before running the sample: * // - Enable the API at: @@ -1594,7 +1594,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.delete( * { - * // Required. The name of the Game Server Deployment to delete. Uses the form: + * // Required. The name of the game server delpoyment to delete. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. * name: @@ -1622,7 +1622,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Deployment to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. + * @param {string} params.name Required. The name of the game server delpoyment to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. * @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 @@ -1688,7 +1688,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.fetchDeploymentState - * @desc Retrieves information about the current state of the Game Server Ddeployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the Game Server Deployment. + * @desc Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment. * @example * // Before running the sample: * // - Enable the API at: @@ -1714,7 +1714,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.fetchDeploymentState( * { - * // Required. The name of the Game Server Deployment. Uses the form: + * // Required. The name of the game server delpoyment. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. * name: @@ -1745,7 +1745,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. + * @param {string} params.name Required. The name of the game server delpoyment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. * @param {().FetchDeploymentStateRequest} params.requestBody 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. @@ -1824,7 +1824,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.get - * @desc Gets details of a single Game Server Deployment. + * @desc Gets details of a single game server deployment. * @example * // Before running the sample: * // - Enable the API at: @@ -1849,7 +1849,7 @@ export namespace gameservices_v1beta { * * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.get({ - * // Required. The name of the Game Server Deployment to retrieve. Uses the form: + * // Required. The name of the game server delpoyment to retrieve. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. * name: @@ -1877,7 +1877,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Deployment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. + * @param {string} params.name Required. The name of the game server delpoyment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. * @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 @@ -1979,6 +1979,10 @@ export namespace gameservices_v1beta { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -2008,7 +2012,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -2076,7 +2080,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.getRollout - * @desc Gets details a single Game Server Deployment Rollout. + * @desc Gets details a single game server deployment rollout. * @example * // Before running the sample: * // - Enable the API at: @@ -2102,7 +2106,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.getRollout( * { - * // Required. The name of the Game Server Deployment to retrieve. Uses the form: + * // Required. The name of the game server delpoyment to retrieve. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. * name: @@ -2131,7 +2135,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Deployment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. + * @param {string} params.name Required. The name of the game server delpoyment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. * @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 @@ -2207,7 +2211,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.list - * @desc Lists Game Server Deployments in a given project and Location. + * @desc Lists game server deployments in a given project and location. * @example * // Before running the sample: * // - Enable the API at: @@ -2237,8 +2241,8 @@ export namespace gameservices_v1beta { * // Optional. Specifies the ordering of results following syntax at * // https://cloud.google.com/apis/design/design_patterns#sorting_order. * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, server - * // will pick an appropriate default. Server may return fewer items than + * // Optional. The maximum number of items to return. If unspecified, the server + * // will pick an appropriate default. The server may return fewer items than * // requested. A caller should only rely on response's * // next_page_token to * // determine if there are more GameServerDeployments left to be queried. @@ -2271,7 +2275,7 @@ export namespace gameservices_v1beta { * @param {object} params Parameters for request * @param {string=} params.filter Optional. The filter to apply to list results. * @param {string=} params.orderBy Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. - * @param {integer=} params.pageSize Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerDeployments left to be queried. + * @param {integer=} params.pageSize Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerDeployments left to be queried. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous List request, if any. * @param {string} params.parent Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2351,7 +2355,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.patch - * @desc Patches a Game Server Deployment. + * @desc Patches a game server deployment. * @example * // Before running the sample: * // - Enable the API at: @@ -2377,7 +2381,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.patch( * { - * // The resource name of the Game Server Deployment. Uses the form: + * // The resource name of the game server deployment. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. * // For example, @@ -2428,7 +2432,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Game Server Deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`. + * @param {string} params.name The resource name of the game server deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`. * @param {string=} params.updateMask Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask * @param {().GameServerDeployment} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2496,7 +2500,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.previewRollout - * @desc Previews the Game Server Deployment Rollout. This API does not mutate the Rollout resource. + * @desc Previews the game server deployment rollout. This API does not mutate the rollout resource. * @example * // Before running the sample: * // - Enable the API at: @@ -2522,7 +2526,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.previewRollout( * { - * // The resource name of the Game Server Deployment Rollout. Uses the form: + * // The resource name of the game server deployment rollout. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. * // For example, @@ -2531,7 +2535,7 @@ export namespace gameservices_v1beta { * name: * 'projects/my-project/locations/my-location/gameServerDeployments/my-gameServerDeployment', * // Optional. The target timestamp to compute the preview. Defaults to the immediately - * // after the proposed Rollout completes. + * // after the proposed rollout completes. * previewTime: 'placeholder-value', * // Optional. Mask of fields to update. At least one path must be supplied in * // this field. For the `FieldMask` definition, see @@ -2574,8 +2578,8 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Game Server Deployment Rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. - * @param {string=} params.previewTime Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed Rollout completes. + * @param {string} params.name The resource name of the game server deployment rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. + * @param {string=} params.previewTime Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes. * @param {string=} params.updateMask Optional. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask * @param {().GameServerDeploymentRollout} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2934,7 +2938,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.updateRollout - * @desc Patches a single Game Server Deployment Rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error. + * @desc Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error. * @example * // Before running the sample: * // - Enable the API at: @@ -2960,7 +2964,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.updateRollout( * { - * // The resource name of the Game Server Deployment Rollout. Uses the form: + * // The resource name of the game server deployment rollout. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. * // For example, @@ -3011,7 +3015,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Game Server Deployment Rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. + * @param {string} params.name The resource name of the game server deployment rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. * @param {string=} params.updateMask Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask * @param {().GameServerDeploymentRollout} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3089,7 +3093,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The ID of the Game Server Deployment resource to be created. + * Required. The ID of the game server delpoyment resource to be created. */ deploymentId?: string; /** @@ -3110,7 +3114,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Deployment to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. + * Required. The name of the game server delpoyment to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. */ name?: string; } @@ -3122,7 +3126,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. + * Required. The name of the game server delpoyment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. */ name?: string; @@ -3139,7 +3143,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Deployment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. + * Required. The name of the game server delpoyment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. */ name?: string; } @@ -3151,7 +3155,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -3167,7 +3171,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Deployment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. + * Required. The name of the game server delpoyment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. */ name?: string; } @@ -3187,7 +3191,7 @@ export namespace gameservices_v1beta { */ orderBy?: string; /** - * Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerDeployments left to be queried. + * Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerDeployments left to be queried. */ pageSize?: number; /** @@ -3207,7 +3211,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Game Server Deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`. + * The resource name of the game server deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`. */ name?: string; /** @@ -3228,11 +3232,11 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Game Server Deployment Rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. + * The resource name of the game server deployment rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. */ name?: string; /** - * Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed Rollout completes. + * Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes. */ previewTime?: string; /** @@ -3287,7 +3291,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Game Server Deployment Rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. + * The resource name of the game server deployment rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. */ name?: string; /** @@ -3309,7 +3313,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.configs.create - * @desc Creates a new Game Server Config in a given project, Location, and Game Server Deployment. Game Server Configs are immutable, and are not applied until referenced in the Game Server Deployment Rollout resource. + * @desc Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource. * @example * // Before running the sample: * // - Enable the API at: @@ -3335,7 +3339,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.configs.create( * { - * // Required. The ID of the Game Server Config resource to be created. + * // Required. The ID of the game server config resource to be created. * configId: 'placeholder-value', * // Required. The parent resource name. Uses the form: * // @@ -3379,7 +3383,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.configId Required. The ID of the Game Server Config resource to be created. + * @param {string=} params.configId Required. The ID of the game server config resource to be created. * @param {string} params.parent Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`. * @param {().GameServerConfig} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3450,7 +3454,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.configs.delete - * @desc Deletes a single Game Server Config. The deletion will fail if the Game Server Config is referenced in a Game Server Deployment Rollout. + * @desc Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout. * @example * // Before running the sample: * // - Enable the API at: @@ -3476,7 +3480,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.configs.delete( * { - * // Required. The name of the Game Server Config to delete. Uses the form: + * // Required. The name of the game server config to delete. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. * name: @@ -3504,7 +3508,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Config to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. + * @param {string} params.name Required. The name of the game server config to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. * @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 @@ -3570,7 +3574,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.configs.get - * @desc Gets details of a single Game Server Config. + * @desc Gets details of a single game server config. * @example * // Before running the sample: * // - Enable the API at: @@ -3596,7 +3600,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.gameServerDeployments.configs.get( * { - * // Required. The name of the Game Server Config to retrieve. Uses the form: + * // Required. The name of the game server config to retrieve. Uses the form: * // * // `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. * name: @@ -3626,7 +3630,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Config to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. + * @param {string} params.name Required. The name of the game server config to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. * @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 @@ -3692,7 +3696,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.configs.list - * @desc Lists Game Server Configs in a given project, Location, and Game Server Deployment. + * @desc Lists game server configs in a given project, location, and game server deployment. * @example * // Before running the sample: * // - Enable the API at: @@ -3729,7 +3733,7 @@ export namespace gameservices_v1beta { * // next_page_token to * // determine if there are more GameServerConfigs left to be queried. * pageSize: 'placeholder-value', - * // Optional. The next_page_token value returned from a previous List request, if any. + * // Optional. The next_page_token value returned from a previous list request, if any. * pageToken: 'placeholder-value', * // Required. The parent resource name. Uses the form: * // @@ -3760,7 +3764,7 @@ export namespace gameservices_v1beta { * @param {string=} params.filter Optional. The filter to apply to list results. * @param {string=} params.orderBy Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. * @param {integer=} params.pageSize Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerConfigs left to be queried. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous List request, if any. + * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request, if any. * @param {string} params.parent Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/x`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3846,7 +3850,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The ID of the Game Server Config resource to be created. + * Required. The ID of the game server config resource to be created. */ configId?: string; /** @@ -3867,7 +3871,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Config to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. + * Required. The name of the game server config to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. */ name?: string; } @@ -3879,7 +3883,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Config to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. + * Required. The name of the game server config to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. */ name?: string; } @@ -3903,7 +3907,7 @@ export namespace gameservices_v1beta { */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous List request, if any. + * Optional. The next_page_token value returned from a previous list request, if any. */ pageToken?: string; /** @@ -4462,7 +4466,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.realms.create - * @desc Creates a new Realm in a given project and Location. + * @desc Creates a new realm in a given project and location. * @example * // Before running the sample: * // - Enable the API at: @@ -4490,7 +4494,7 @@ export namespace gameservices_v1beta { * // Required. The parent resource name. Uses the form: * // `projects/{project}/locations/{location}`. * parent: 'projects/my-project/locations/my-location', - * // Required. The ID of the Realm resource to be created. + * // Required. The ID of the realm resource to be created. * realmId: 'placeholder-value', * * // Request body metadata @@ -4529,7 +4533,7 @@ export namespace gameservices_v1beta { * * @param {object} params Parameters for request * @param {string} params.parent Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`. - * @param {string=} params.realmId Required. The ID of the Realm resource to be created. + * @param {string=} params.realmId Required. The ID of the realm resource to be created. * @param {().Realm} params.requestBody 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. @@ -4599,7 +4603,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.realms.delete - * @desc Deletes a single Realm. + * @desc Deletes a single realm. * @example * // Before running the sample: * // - Enable the API at: @@ -4624,7 +4628,7 @@ export namespace gameservices_v1beta { * * // Do the magic * const res = await gameservices.projects.locations.realms.delete({ - * // Required. The name of the Realm to delete. Uses the form: + * // Required. The name of the realm to delete. Uses the form: * // `projects/{project}/locations/{location}/realms/{realm}`. * name: 'projects/my-project/locations/my-location/realms/my-realm', * }); @@ -4649,7 +4653,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Realm to delete. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. + * @param {string} params.name Required. The name of the realm to delete. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. * @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 @@ -4715,7 +4719,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.realms.get - * @desc Gets details of a single Realm. + * @desc Gets details of a single realm. * @example * // Before running the sample: * // - Enable the API at: @@ -4740,7 +4744,7 @@ export namespace gameservices_v1beta { * * // Do the magic * const res = await gameservices.projects.locations.realms.get({ - * // Required. The name of the Realm to retrieve. Uses the form: + * // Required. The name of the realm to retrieve. Uses the form: * // `projects/{project}/locations/{location}/realms/{realm}`. * name: 'projects/my-project/locations/my-location/realms/my-realm', * }); @@ -4767,7 +4771,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Realm to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. + * @param {string} params.name Required. The name of the realm to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. * @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 @@ -4831,7 +4835,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.realms.list - * @desc Lists Realms in a given project and Location. + * @desc Lists realms in a given project and location. * @example * // Before running the sample: * // - Enable the API at: @@ -4865,7 +4869,7 @@ export namespace gameservices_v1beta { * // will pick an appropriate default. Server may return fewer items than * // requested. A caller should only rely on response's * // next_page_token to - * // determine if there are more Realms left to be queried. + * // determine if there are more realms left to be queried. * pageSize: 'placeholder-value', * // Optional. The next_page_token value returned from a previous List request, * // if any. @@ -4895,7 +4899,7 @@ export namespace gameservices_v1beta { * @param {object} params Parameters for request * @param {string=} params.filter Optional. The filter to apply to list results. * @param {string=} params.orderBy Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. - * @param {integer=} params.pageSize Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more Realms left to be queried. + * @param {integer=} params.pageSize Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more realms left to be queried. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous List request, if any. * @param {string} params.parent Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4966,7 +4970,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.realms.patch - * @desc Patches a single Realm. + * @desc Patches a single realm. * @example * // Before running the sample: * // - Enable the API at: @@ -4991,7 +4995,7 @@ export namespace gameservices_v1beta { * * // Do the magic * const res = await gameservices.projects.locations.realms.patch({ - * // The resource name of the Realm. Uses the form: + * // The resource name of the realm. Uses the form: * // `projects/{project}/locations/{location}/realms/{realm}`. For * // example, `projects/my-project/locations/{location}/realms/my-realm`. * name: 'projects/my-project/locations/my-location/realms/my-realm', @@ -5038,7 +5042,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. + * @param {string} params.name The resource name of the realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. * @param {string=} params.updateMask Required. The update mask applies to the resource. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask * @param {().Realm} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5106,7 +5110,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.realms.previewUpdate - * @desc Previews patches to a single Realm. + * @desc Previews patches to a single realm. * @example * // Before running the sample: * // - Enable the API at: @@ -5131,7 +5135,7 @@ export namespace gameservices_v1beta { * * // Do the magic * const res = await gameservices.projects.locations.realms.previewUpdate({ - * // The resource name of the Realm. Uses the form: + * // The resource name of the realm. Uses the form: * // `projects/{project}/locations/{location}/realms/{realm}`. For * // example, `projects/my-project/locations/{location}/realms/my-realm`. * name: 'projects/my-project/locations/my-location/realms/my-realm', @@ -5177,7 +5181,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. + * @param {string} params.name The resource name of the realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. * @param {string=} params.previewTime Optional. The target timestamp to compute the preview. * @param {string=} params.updateMask Required. The update mask applies to the resource. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask * @param {().Realm} params.requestBody Request body data @@ -5267,7 +5271,7 @@ export namespace gameservices_v1beta { */ parent?: string; /** - * Required. The ID of the Realm resource to be created. + * Required. The ID of the realm resource to be created. */ realmId?: string; @@ -5284,7 +5288,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Realm to delete. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. + * Required. The name of the realm to delete. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. */ name?: string; } @@ -5296,7 +5300,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Realm to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. + * Required. The name of the realm to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. */ name?: string; } @@ -5316,7 +5320,7 @@ export namespace gameservices_v1beta { */ orderBy?: string; /** - * Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more Realms left to be queried. + * Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more realms left to be queried. */ pageSize?: number; /** @@ -5336,7 +5340,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. + * The resource name of the realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. */ name?: string; /** @@ -5357,7 +5361,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. + * The resource name of the realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. */ name?: string; /** @@ -5409,7 +5413,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.realms.gameServerClusters.create( * { - * // Required. The ID of the Game Server Cluster resource to be created. + * // Required. The ID of the game server cluster resource to be created. * gameServerClusterId: 'placeholder-value', * // Required. The parent resource name. Uses the form: * // `projects/{project}/locations/{location}/realms/{realm-id}`. @@ -5451,7 +5455,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.gameServerClusterId Required. The ID of the Game Server Cluster resource to be created. + * @param {string=} params.gameServerClusterId Required. The ID of the game server cluster resource to be created. * @param {string} params.parent Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}`. * @param {().GameServerCluster} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5548,7 +5552,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.realms.gameServerClusters.delete( * { - * // Required. The name of the Game Server Cluster to delete. Uses the form: + * // Required. The name of the game server cluster to delete. Uses the form: * // `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. * name: * 'projects/my-project/locations/my-location/realms/my-realm/gameServerClusters/my-gameServerCluster', @@ -5575,7 +5579,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. + * @param {string} params.name Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. * @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 @@ -5667,7 +5671,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.realms.gameServerClusters.get( * { - * // Required. The name of the Game Server Cluster to retrieve. Uses the form: + * // Required. The name of the game server cluster to retrieve. Uses the form: * // * // `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. * name: @@ -5697,7 +5701,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Cluster to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. + * @param {string} params.name Required. The name of the game server cluster to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. * @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 @@ -5763,7 +5767,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.realms.gameServerClusters.list - * @desc Lists Game Server Clusters in a given project and location. + * @desc Lists game server clusters in a given project and location. * @example * // Before running the sample: * // - Enable the API at: @@ -5794,8 +5798,8 @@ export namespace gameservices_v1beta { * // Optional. Specifies the ordering of results following syntax at * // https://cloud.google.com/apis/design/design_patterns#sorting_order. * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, server - * // will pick an appropriate default. Server may return fewer items than + * // Optional. The maximum number of items to return. If unspecified, the server + * // will pick an appropriate default. The server may return fewer items than * // requested. A caller should only rely on response's * // next_page_token to * // determine if there are more GameServerClusters left to be queried. @@ -5828,7 +5832,7 @@ export namespace gameservices_v1beta { * @param {object} params Parameters for request * @param {string=} params.filter Optional. The filter to apply to list results. * @param {string=} params.orderBy Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. - * @param {integer=} params.pageSize Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried. + * @param {integer=} params.pageSize Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous List request, if any. * @param {string} params.parent Required. The parent resource name. Uses the form: "projects/{project}/locations/{location}/realms/{realm}". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5934,7 +5938,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.realms.gameServerClusters.patch( * { - * // Required. The resource name of the Game Server Cluster. Uses the form: + * // Required. The resource name of the game server cluster. Uses the form: * // * // `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. * // For example, @@ -5986,7 +5990,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the Game Server Cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. + * @param {string} params.name Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. * @param {string=} params.updateMask Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask * @param {().GameServerCluster} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6080,7 +6084,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.realms.gameServerClusters.previewCreate( * { - * // Required. The ID of the Game Server Cluster resource to be created. + * // Required. The ID of the game server cluster resource to be created. * gameServerClusterId: 'placeholder-value', * // Required. The parent resource name. Uses the form: * // `projects/{project}/locations/{location}/realms/{realm}`. @@ -6121,7 +6125,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.gameServerClusterId Required. The ID of the Game Server Cluster resource to be created. + * @param {string=} params.gameServerClusterId Required. The ID of the game server cluster resource to be created. * @param {string} params.parent Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. * @param {string=} params.previewTime Optional. The target timestamp to compute the preview. * @param {().GameServerCluster} params.requestBody Request body data @@ -6235,7 +6239,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.realms.gameServerClusters.previewDelete( * { - * // Required. The name of the Game Server Cluster to delete. Uses the form: + * // Required. The name of the game server cluster to delete. Uses the form: * // `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. * name: * 'projects/my-project/locations/my-location/realms/my-realm/gameServerClusters/my-gameServerCluster', @@ -6261,7 +6265,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the Game Server Cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. + * @param {string} params.name Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. * @param {string=} params.previewTime Optional. The target timestamp to compute the preview. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6374,7 +6378,7 @@ export namespace gameservices_v1beta { * // Do the magic * const res = await gameservices.projects.locations.realms.gameServerClusters.previewUpdate( * { - * // Required. The resource name of the Game Server Cluster. Uses the form: + * // Required. The resource name of the game server cluster. Uses the form: * // * // `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. * // For example, @@ -6425,7 +6429,7 @@ export namespace gameservices_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the Game Server Cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. + * @param {string} params.name Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. * @param {string=} params.previewTime Optional. The target timestamp to compute the preview. * @param {string=} params.updateMask Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask * @param {().GameServerCluster} params.requestBody Request body data @@ -6521,7 +6525,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The ID of the Game Server Cluster resource to be created. + * Required. The ID of the game server cluster resource to be created. */ gameServerClusterId?: string; /** @@ -6542,7 +6546,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. + * Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. */ name?: string; } @@ -6554,7 +6558,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Cluster to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. + * Required. The name of the game server cluster to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. */ name?: string; } @@ -6574,7 +6578,7 @@ export namespace gameservices_v1beta { */ orderBy?: string; /** - * Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried. + * Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried. */ pageSize?: number; /** @@ -6594,7 +6598,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the Game Server Cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. + * Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. */ name?: string; /** @@ -6615,7 +6619,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The ID of the Game Server Cluster resource to be created. + * Required. The ID of the game server cluster resource to be created. */ gameServerClusterId?: string; /** @@ -6640,7 +6644,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the Game Server Cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. + * Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. */ name?: string; /** @@ -6656,7 +6660,7 @@ export namespace gameservices_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the Game Server Cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. + * Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. */ name?: string; /** diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index 74e854fe477..a3b284941d4 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -144,7 +144,7 @@ export namespace healthcare_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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -542,7 +542,7 @@ export namespace healthcare_v1 { */ filter?: string | null; /** - * The [Cloud Pubsub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time at which the message was published. Note that 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 Pubsub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification cannot be published to Cloud Pub/Sub, errors will be logged to Stackdriver (see [Viewing logs](/healthcare/docs/how- tos/stackdriver-logging)). + * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time at which the message was published. Note that 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 API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification cannot be published to Cloud Pub/Sub, errors will be logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how- tos/logging)). */ pubsubTopic?: string | null; } @@ -802,7 +802,7 @@ export namespace healthcare_v1 { */ 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 contains 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 causes the calls that send notifications to fail. If a notification can't be published to Cloud Pub/Sub, errors are logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). If the number of errors exceeds a certain rate, some aren't submitted. + * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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 API service account must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Cloud Pub/Sub, errors are logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. */ pubsubTopic?: string | null; } @@ -853,7 +853,7 @@ export namespace healthcare_v1 { */ endTime?: string | null; /** - * A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at https://cloud.google.com/healthcare/docs/how-tos/stackdriver-logging. + * A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at [Viewing logs](/healthcare/docs/how-tos/logging). */ logsUrl?: string | null; } @@ -890,7 +890,7 @@ export namespace healthcare_v1 { value?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -906,7 +906,7 @@ export namespace healthcare_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -992,7 +992,7 @@ export namespace healthcare_v1 { */ 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"` */ updateMask?: string | null; } @@ -1018,7 +1018,7 @@ export namespace healthcare_v1 { */ export interface Schema$StreamConfig { /** - * The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are appended to the corresponding BigQuery tables. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Stackdriver (see [Viewing logs](/healthcare/docs/how- tos/stackdriver-logging)). + * The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are appended to the corresponding BigQuery tables. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1FhirBigQueryDestination; /** @@ -1235,7 +1235,7 @@ export namespace healthcare_v1 { /** * 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, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Stackdriver Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + * @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, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/logging). * @example * // Before running the sample: * // - Enable the API at: @@ -1617,6 +1617,10 @@ export namespace healthcare_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -1642,7 +1646,7 @@ export namespace healthcare_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -1961,7 +1965,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -2087,7 +2091,7 @@ export namespace healthcare_v1 { /** * 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. * @example * // Before running the sample: * // - Enable the API at: @@ -2287,7 +2291,7 @@ export namespace healthcare_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -2514,7 +2518,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.dicomStores.deidentify - * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). * @example * // Before running the sample: * // - Enable the API at: @@ -2755,7 +2759,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.dicomStores.export - * @desc Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Stackdriver Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The metadata field type is OperationMetadata. + * @desc Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. * @example * // Before running the sample: * // - Enable the API at: @@ -3031,6 +3035,10 @@ export namespace healthcare_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -3058,7 +3066,7 @@ export namespace healthcare_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -3126,7 +3134,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.dicomStores.import - * @desc Imports data into the DICOM store by copying it from the specified source. Errors are logged to Stackdriver Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The metadata field type is OperationMetadata. + * @desc Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. * @example * // Before running the sample: * // - Enable the API at: @@ -3879,7 +3887,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -4141,7 +4149,7 @@ export namespace healthcare_v1 { /** * 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. + * @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 the sample: * // - Enable the API at: @@ -4361,7 +4369,7 @@ export namespace healthcare_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -6964,7 +6972,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.fhirStores.deidentify - * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). * @example * // Before running the sample: * // - Enable the API at: @@ -7205,7 +7213,7 @@ export namespace healthcare_v1 { /** * 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, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). 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, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). 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. * @example * // Before running the sample: * // - Enable the API at: @@ -7486,6 +7494,10 @@ export namespace healthcare_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -7513,7 +7525,7 @@ export namespace healthcare_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -7581,7 +7593,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.fhirStores.import - * @desc Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger PubSub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. 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, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). 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. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. 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, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). 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. * @example * // Before running the sample: * // - Enable the API at: @@ -7977,128 +7989,9 @@ export namespace healthcare_v1 { } } - /** - * healthcare.projects.locations.datasets.fhirStores.search - * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/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. 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 ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/healthcare.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const healthcare = google.healthcare('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await healthcare.projects.locations.datasets.fhirStores.search({ - * // Name of the FHIR store to retrieve resources from. - * parent: - * 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhirStore', - * // The FHIR resource type to search, such as Patient or Observation. For a - * // complete list, see the FHIR Resource Index - * // ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - * // [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - * // [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). - * resourceType: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias healthcare.projects.locations.datasets.fhirStores.search - * @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 FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/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 - */ - search( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Search, - options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Search, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Search, - callback: BodyResponseCallback - ): void; - search(callback: BodyResponseCallback): void; - search( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Search - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Search; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Search; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/fhir').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * healthcare.projects.locations.datasets.fhirStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -8227,7 +8120,7 @@ export namespace healthcare_v1 { /** * 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. + * @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 the sample: * // - Enable the API at: @@ -8447,7 +8340,7 @@ export namespace healthcare_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -8517,22 +8410,6 @@ export namespace healthcare_v1 { */ requestBody?: Schema$FhirStore; } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$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; - /** - * The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). - */ - resourceType?: string; - } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy extends StandardParameters { /** @@ -9341,7 +9218,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything - * @desc Retrieves all the resources directly referenced by a patient, as well as all of the resources in the patient compartment. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/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. + * @desc Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/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. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. * @example * // Before running the sample: * // - Enable the API at: @@ -10677,6 +10554,10 @@ export namespace healthcare_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -10704,7 +10585,7 @@ export namespace healthcare_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -11036,7 +10917,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -11165,7 +11046,7 @@ export namespace healthcare_v1 { /** * 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. + * @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 the sample: * // - Enable the API at: @@ -11351,7 +11232,7 @@ export namespace healthcare_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 355da609125..7bb4a3a66bf 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -144,7 +144,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -729,7 +729,7 @@ export namespace healthcare_v1beta1 { */ filter?: string | null; /** - * The [Cloud Pubsub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time at which the message was published. Note that 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 Pubsub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification cannot be published to Cloud Pub/Sub, errors will be logged to Stackdriver (see [Viewing logs](/healthcare/docs/how- tos/stackdriver-logging)). + * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time at which the message was published. Note that 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 API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification cannot be published to Cloud Pub/Sub, errors will be logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how- tos/logging)). */ pubsubTopic?: string | null; } @@ -1040,7 +1040,7 @@ 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 contains 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 causes the calls that send notifications to fail. If a notification can't be published to Cloud Pub/Sub, errors are logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). If the number of errors exceeds a certain rate, some aren't submitted. + * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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 API service account must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Cloud Pub/Sub, errors are logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. */ pubsubTopic?: string | null; } @@ -1091,7 +1091,7 @@ export namespace healthcare_v1beta1 { */ endTime?: string | null; /** - * A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at https://cloud.google.com/healthcare/docs/how-tos/stackdriver-logging. + * A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at [Viewing logs](/healthcare/docs/how-tos/logging). */ logsUrl?: string | null; } @@ -1132,7 +1132,7 @@ export namespace healthcare_v1beta1 { value?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -1148,7 +1148,7 @@ export namespace healthcare_v1beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -1310,7 +1310,7 @@ export namespace healthcare_v1beta1 { */ 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"` */ updateMask?: string | null; } @@ -1336,7 +1336,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$StreamConfig { /** - * The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are appended to the corresponding BigQuery tables. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Stackdriver (see [Viewing logs](/healthcare/docs/how- tos/stackdriver-logging)). + * The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are appended to the corresponding BigQuery tables. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how- tos/logging)). */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1beta1FhirBigQueryDestination; /** @@ -1863,7 +1863,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, error details field type is DeidentifyErrorDetails. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in DeidentifySummary.failure_resource_count. Error details are also logged to Stackdriver Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + * @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, error details field type is DeidentifyErrorDetails. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in DeidentifySummary.failure_resource_count. Error details are also logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/logging). * @example * // Before running the sample: * // - Enable the API at: @@ -2245,6 +2245,10 @@ export namespace healthcare_v1beta1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -2270,7 +2274,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -2589,7 +2593,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -2715,7 +2719,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. * @example * // Before running the sample: * // - Enable the API at: @@ -2915,7 +2919,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -3041,6 +3045,10 @@ export namespace healthcare_v1beta1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -3068,7 +3076,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -3136,7 +3144,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.annotationStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -3265,7 +3273,7 @@ export namespace healthcare_v1beta1 { /** * 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. 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 the sample: * // - Enable the API at: @@ -3406,7 +3414,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -3592,7 +3600,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.deidentify - * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error details field type is DeidentifyErrorDetails. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in DeidentifySummary.failure_resource_count. Error details are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error details field type is DeidentifyErrorDetails. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in DeidentifySummary.failure_resource_count. Error details are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). * @example * // Before running the sample: * // - Enable the API at: @@ -3833,7 +3841,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. Errors are also logged to Stackdriver Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The metadata field type is OperationMetadata. + * @desc Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. * @example * // Before running the sample: * // - Enable the API at: @@ -4112,6 +4120,10 @@ export namespace healthcare_v1beta1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -4139,7 +4151,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -4207,7 +4219,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 is populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which hold finer-grained error information. Errors are also logged to Stackdriver Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The metadata field type is OperationMetadata. + * @desc Imports data into the DICOM store by copying it from the specified source. For errors, the Operation is populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which hold finer-grained error information. Errors are also logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. * @example * // Before running the sample: * // - Enable the API at: @@ -4960,7 +4972,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. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -5221,7 +5233,7 @@ 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. + * @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 the sample: * // - Enable the API at: @@ -5441,7 +5453,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -8014,7 +8026,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.deidentify - * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error details field type is DeidentifyErrorDetails. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error details field type is DeidentifyErrorDetails. Errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). * @example * // Before running the sample: * // - Enable the API at: @@ -8255,7 +8267,7 @@ export namespace healthcare_v1beta1 { /** * 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, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). 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, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). 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. * @example * // Before running the sample: * // - Enable the API at: @@ -8540,6 +8552,10 @@ export namespace healthcare_v1beta1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -8567,7 +8583,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -8635,7 +8651,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. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Cloud Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. 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, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). 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. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Cloud Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. 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, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). 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. * @example * // Before running the sample: * // - Enable the API at: @@ -9036,131 +9052,9 @@ export namespace healthcare_v1beta1 { } } - /** - * healthcare.projects.locations.datasets.fhirStores.search - * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/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. 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 ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/healthcare.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const healthcare = google.healthcare('v1beta1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await healthcare.projects.locations.datasets.fhirStores.search({ - * // Name of the FHIR store to retrieve resources from. - * parent: - * 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhirStore', - * // The FHIR resource type to search, such as Patient or Observation. For a - * // complete list, see the FHIR Resource Index - * // ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - * // [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - * // [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). - * resourceType: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias healthcare.projects.locations.datasets.fhirStores.search - * @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 FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/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 - */ - search( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Search, - options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Search, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Search, - callback: BodyResponseCallback - ): void; - search(callback: BodyResponseCallback): void; - search( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Search - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Search; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Search; - 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: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * healthcare.projects.locations.datasets.fhirStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -9289,7 +9183,7 @@ 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. + * @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 the sample: * // - Enable the API at: @@ -9509,7 +9403,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -9579,22 +9473,6 @@ export namespace healthcare_v1beta1 { */ requestBody?: Schema$FhirStore; } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$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; - /** - * The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). - */ - resourceType?: string; - } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy extends StandardParameters { /** @@ -10024,7 +9902,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete - * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.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. + * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.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. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. * @example * // Before running the sample: * // - Enable the API at: @@ -10144,7 +10022,7 @@ export namespace healthcare_v1beta1 { /** * 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 ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. 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. + * @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 ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. 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. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. * @example * // Before running the sample: * // - Enable the API at: @@ -10279,7 +10157,7 @@ export namespace healthcare_v1beta1 { /** * 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 ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), [R4](http://hl7.org/implement/standards/fhir/R4/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. + * @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 ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), [R4](http://hl7.org/implement/standards/fhir/R4/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. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. * @example * // Before running the sample: * // - Enable the API at: @@ -10665,7 +10543,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle - * @desc Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](http://hl7.org/implement/standards/fhir/R4/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 ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)). 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. + * @desc Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](http://hl7.org/implement/standards/fhir/R4/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 ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)). 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. This method requires permission for executing the requests in the bundle. The `executeBundle` permission grants permission to execute the request in the bundle but you must grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a `create` request, you must have permission to execute the `create` request. Logging is available for the `executeBundle` permission. * @example * // Before running the sample: * // - Enable the API at: @@ -11182,7 +11060,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything - * @desc Retrieves all the resources directly referenced by a patient, as well as all of the resources in the patient compartment. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/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. + * @desc Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/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. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. * @example * // Before running the sample: * // - Enable the API at: @@ -12654,6 +12532,10 @@ export namespace healthcare_v1beta1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -12681,7 +12563,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -13015,7 +12897,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. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -13144,7 +13026,7 @@ 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. + * @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 the sample: * // - Enable the API at: @@ -13330,7 +13212,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 2c3ee038da2..bd8f8caed19 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -153,6 +153,10 @@ export namespace iap_v1 { * Customization for Access Denied page. */ accessDeniedPageSettings?: Schema$AccessDeniedPageSettings; + /** + * The Domain value to set for cookies generated by IAP. This value is not validated by the API, but will be ignored at runtime if invalid. + */ + cookieDomain?: string | null; /** * Settings to configure IAP's behavior for a CSM mesh. */ @@ -163,7 +167,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -188,7 +192,7 @@ export namespace iap_v1 { */ name?: string | null; /** - * Output only. Whether the brand is only intended for usage inside the GSuite organization only. + * Output only. Whether the brand is only intended for usage inside the G Suite organization only. */ orgInternalOnly?: boolean | null; /** @@ -257,7 +261,7 @@ export namespace iap_v1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -266,7 +270,7 @@ export namespace iap_v1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -340,7 +344,7 @@ export namespace iap_v1 { loginHint?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -352,7 +356,7 @@ export namespace iap_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -380,7 +384,7 @@ export namespace iap_v1 { export interface Schema$PolicyName { id?: string | null; /** - * For Cloud IAM: The location of the Policy. Must be empty or "global" for Policies owned by global IAM. Must name a region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see http://go/iam-faq#where-is-iam-currently-deployed. For Local IAM: This field should be set to "local". + * For Cloud IAM: The location of the Policy. Must be empty or "global" for Policies owned by global IAM. Must name a region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see go/iam-faq#where-is-iam-currently-deployed. For Local IAM: This field should be set to "local". */ region?: string | null; /** @@ -892,7 +896,7 @@ export namespace iap_v1 { * // Required. Path to create the client in. * // In the following format: * // projects/{project_number/id}/brands/{brand}. - * // The project must belong to a GSuite account. + * // The project must belong to a G Suite account. * parent: 'projects/my-project/brands/my-brand', * * // Request body metadata @@ -924,7 +928,7 @@ export namespace iap_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a GSuite account. + * @param {string} params.parent Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a G Suite account. * @param {().IdentityAwareProxyClient} params.requestBody 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. @@ -1510,7 +1514,7 @@ export namespace iap_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a GSuite account. + * Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a G Suite account. */ parent?: string; diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index 8c8bf51c01c..dfed96aff65 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -118,7 +118,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -156,7 +156,7 @@ export namespace iap_v1beta1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -165,12 +165,12 @@ export namespace iap_v1beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -182,7 +182,7 @@ export namespace iap_v1beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/index.ts b/src/apis/index.ts index fd2df51839a..4e7ddb8413c 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -61,7 +61,6 @@ import * as cloudsearch from './cloudsearch'; import * as cloudshell from './cloudshell'; import * as cloudtasks from './cloudtasks'; import * as cloudtrace from './cloudtrace'; -import * as commentanalyzer from './commentanalyzer'; import * as composer from './composer'; import * as compute from './compute'; import * as container from './container'; @@ -237,7 +236,6 @@ export const APIS: APIList = { cloudshell: cloudshell.VERSIONS, cloudtasks: cloudtasks.VERSIONS, cloudtrace: cloudtrace.VERSIONS, - commentanalyzer: commentanalyzer.VERSIONS, composer: composer.VERSIONS, compute: compute.VERSIONS, container: container.VERSIONS, @@ -410,7 +408,6 @@ export class GeneratedAPIs { cloudshell = cloudshell.cloudshell; cloudtasks = cloudtasks.cloudtasks; cloudtrace = cloudtrace.cloudtrace; - commentanalyzer = commentanalyzer.commentanalyzer; composer = composer.composer; compute = compute.compute; container = container.container; diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index 93bb503cba7..cf33eb6253c 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -470,7 +470,7 @@ 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, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. */ filterable?: boolean | null; /** diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 54ff4d30d33..8347d79b733 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -140,7 +140,7 @@ export namespace logging_v2 { */ export interface Schema$BigQueryOptions { /** - * Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone. + * Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone. */ usePartitionedTables?: boolean | null; /** @@ -166,11 +166,11 @@ export namespace logging_v2 { linearBuckets?: Schema$Linear; } /** - * Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information. + * Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. */ export interface Schema$CmekSettings { /** - * The resource name for the configured Cloud KMS key.KMS key name format: "projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY"For example: "projects/my-project-id/locations/my-region/keyRings/key-ring-name/cryptoKeys/key-name"To enable CMEK for the Logs Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Logs Router, set this field to an empty string.See Enabling CMEK for Logs Router for more information. + * The resource name for the configured Cloud KMS key.KMS key name format: "projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY"For example: "projects/my-project-id/locations/my-region/keyRings/key-ring-name/cryptoKeys/key-name"To enable CMEK for the Logs Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Logs Router, set this field to an empty string.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. */ kmsKeyName?: string | null; /** @@ -178,7 +178,7 @@ export namespace logging_v2 { */ name?: string | null; /** - * Output only. The service account that will be used by the Logs Router to access your Cloud KMS key.Before enabling CMEK for Logs Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Logs Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router for more information. + * Output only. The service account that will be used by the Logs Router to access your Cloud KMS key.Before enabling CMEK for Logs Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Logs Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. */ serviceAccountId?: string | null; } @@ -342,7 +342,7 @@ export namespace logging_v2 { */ export interface Schema$ListLogEntriesRequest { /** - * Optional. A filter that chooses which log entries to return. See Advanced Logs Queries. 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 Queries (https://cloud.google.com/logging/docs/view/advanced-queries). 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 | null; /** @@ -485,7 +485,7 @@ export namespace logging_v2 { */ logName?: string | null; /** - * Output only. Deprecated. 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. + * Output only. Deprecated. 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 system labels that were present in the metadata.systemLabels field will no longer be available in the LogEntry. */ metadata?: Schema$MonitoredResourceMetadata; /** @@ -521,7 +521,7 @@ export namespace logging_v2 { */ textPayload?: string | null; /** - * 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 must have timestamps that don't exceed the logs retention period in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging. + * 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 must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging. */ timestamp?: string | null; /** @@ -588,7 +588,7 @@ export namespace logging_v2 { */ disabled?: boolean | null; /** - * 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 query matches 99% of low-severity log entries from Google Cloud Storage buckets:"resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)" + * Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:"resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)" */ filter?: string | null; /** @@ -638,7 +638,7 @@ export namespace logging_v2 { */ description?: string | null; /** - * 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 (https://cloud.google.com/logging/docs/view/advanced_filters) 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 | null; /** @@ -683,7 +683,7 @@ export namespace logging_v2 { */ description?: string | null; /** - * 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 (https://cloud.google.com/logging/docs/api/tasks/exporting-logs). */ destination?: string | null; /** @@ -691,7 +691,7 @@ export namespace logging_v2 { */ disabled?: boolean | null; /** - * 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 (https://cloud.google.com/logging/docs/view/advanced-queries). 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 | null; /** @@ -703,7 +703,7 @@ export namespace logging_v2 { */ name?: string | null; /** - * 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. This field is unused. */ outputVersionFormat?: string | null; /** @@ -711,7 +711,7 @@ export namespace logging_v2 { */ updateTime?: string | null; /** - * 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 (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity. */ writerIdentity?: string | null; } @@ -1012,7 +1012,7 @@ export namespace logging_v2 { */ dryRun?: boolean | null; /** - * 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 (https://cloud.google.com/logging/quota-policy) 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 (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).To improve throughput and to avoid exceeding the quota limit (https://cloud.google.com/logging/quota-policy) 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[]; /** @@ -3530,7 +3530,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 (https://cloud.google.com/logging/docs/export). * @example * // Before running the sample: * // - Enable the API at: @@ -7943,7 +7943,7 @@ export namespace logging_v2 { /** * logging.organizations.getCmekSettings - * @desc Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information. + * @desc Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. * @example * // Before running the sample: * // - Enable the API at: @@ -8069,7 +8069,7 @@ export namespace logging_v2 { /** * logging.organizations.updateCmekSettings - * @desc Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router for more information. + * @desc Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. * @example * // Before running the sample: * // - Enable the API at: @@ -14700,7 +14700,7 @@ export namespace logging_v2 { /** * logging.getCmekSettings - * @desc Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information. + * @desc Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. * @example * // Before running the sample: * // - Enable the API at: @@ -14826,7 +14826,7 @@ export namespace logging_v2 { /** * logging.updateCmekSettings - * @desc Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router for more information. + * @desc Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/memcache/v1beta2.ts b/src/apis/memcache/v1beta2.ts index 71900eff2ef..0fdcad45fb7 100644 --- a/src/apis/memcache/v1beta2.ts +++ b/src/apis/memcache/v1beta2.ts @@ -157,7 +157,7 @@ export namespace memcache_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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -627,7 +627,7 @@ export namespace memcache_v1beta2 { response?: {[key: string]: any} | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -643,7 +643,7 @@ export namespace memcache_v1beta2 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -656,7 +656,7 @@ export namespace memcache_v1beta2 { */ 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"` */ updateMask?: string | null; } @@ -1575,6 +1575,10 @@ export namespace memcache_v1beta2 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -1600,7 +1604,7 @@ export namespace memcache_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -1958,7 +1962,7 @@ export namespace memcache_v1beta2 { /** * memcache.projects.locations.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -2084,7 +2088,7 @@ export namespace memcache_v1beta2 { /** * memcache.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. + * @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 the sample: * // - Enable the API at: @@ -2413,7 +2417,7 @@ export namespace memcache_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 965652fd945..fb6482a6f02 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -704,12 +704,20 @@ export namespace monitoring_v3 { * The authentication information. Optional when creating an HTTP check; defaults to empty. */ authInfo?: Schema$BasicAuthentication; + /** + * The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". + */ + body?: string | null; + /** + * The content type to use for the check. + */ + contentType?: string | null; /** * 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} | null; /** - * 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 specifying 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 | null; /** @@ -720,6 +728,10 @@ export namespace monitoring_v3 { * Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL. */ port?: number | null; + /** + * The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET. + */ + requestMethod?: string | null; /** * If true, use HTTPS instead of HTTP to run the check. */ @@ -1561,7 +1573,7 @@ export namespace monitoring_v3 { resourceName?: string | null; } /** - * A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time. For a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. For DELTA and CUMULATIVE metrics, the start time must be earlier than the end time. In all cases, the start time of the next interval must be at least a microsecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time. + * A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time. For a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. For DELTA and CUMULATIVE metrics, the start time must be earlier than the end time. In all cases, the start time of the next interval must be at least a millisecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time. */ export interface Schema$TimeInterval { /** @@ -1578,7 +1590,7 @@ export namespace monitoring_v3 { */ 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 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; /** @@ -1909,7 +1921,7 @@ export namespace monitoring_v3 { * const res = await monitoring.projects.alertPolicies.create({ * // Required. The project in which to create the alerting policy. The format is: * // projects/[PROJECT_ID_OR_NUMBER] - * // 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/[ALERT_POLICY_ID], identifying the policy in the container. + * // Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. 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/[ALERT_POLICY_ID], identifying the policy in the container. * name: 'projects/my-project', * * // Request body metadata @@ -1957,7 +1969,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The project in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] 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/[ALERT_POLICY_ID], identifying the policy in the container. + * @param {string} params.name Required. The project in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. 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/[ALERT_POLICY_ID], identifying the policy in the container. * @param {().AlertPolicy} params.requestBody 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. @@ -2266,7 +2278,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.alertPolicies.list - * @desc Lists the existing alerting policies for the project. + * @desc Lists the existing alerting policies for the workspace. * @example * // Before running the sample: * // - Enable the API at: @@ -2563,7 +2575,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] 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/[ALERT_POLICY_ID], identifying the policy in the container. + * Required. The project in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. 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/[ALERT_POLICY_ID], identifying the policy in the container. */ name?: string; diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index eb8253369c7..b286176a945 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -157,7 +157,7 @@ export namespace networkmanagement_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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -198,7 +198,7 @@ export namespace networkmanagement_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Required. Unique name of the resource using the form: `projects/{project_id}/tests/{test_id}` + * Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test}` */ name?: string | null; /** @@ -640,7 +640,7 @@ export namespace networkmanagement_v1beta1 { */ statusDetail?: string | null; /** - * Target of the operation - for example projects/project-1/connectivityTests/test-1 + * Target of the operation - for example projects/project-1/locations/global/connectivityTests/test-1 */ target?: string | null; /** @@ -649,7 +649,7 @@ export namespace networkmanagement_v1beta1 { verb?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -665,7 +665,7 @@ export namespace networkmanagement_v1beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -744,7 +744,7 @@ export namespace networkmanagement_v1beta1 { */ 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"` */ updateMask?: string | null; } @@ -1437,7 +1437,7 @@ export namespace networkmanagement_v1beta1 { * const res = await networkmanagement.projects.locations.global.connectivityTests.delete( * { * // Required. Connectivity Test resource name using the form: - * // `projects/{project_id}/connectivityTests/{test_id}` + * // `projects/{project_id}/locations/global/connectivityTests/{test_id}` * name: * 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', * } @@ -1463,7 +1463,7 @@ export namespace networkmanagement_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Connectivity Test resource name using the form: `projects/{project_id}/connectivityTests/{test_id}` + * @param {string} params.name Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_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 @@ -1690,6 +1690,10 @@ export namespace networkmanagement_v1beta1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -1717,7 +1721,7 @@ export namespace networkmanagement_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -1823,7 +1827,7 @@ export namespace networkmanagement_v1beta1 { * // * // Examples: * // - Filter by name: - * // name = "projects/proj-1/connectivityTests/test-1 + * // name = "projects/proj-1/locations/global/connectivityTests/test-1 * // * // - Filter by labels: * // - Resources that have a key called `foo` @@ -1861,7 +1865,7 @@ export namespace networkmanagement_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/connectivityTests/test-1 - Filter by labels: - Resources that have a key called `foo` labels.foo:* - Resources that have a key called `foo` whose value is `bar` labels.foo = bar + * @param {string=} params.filter Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1 - Filter by labels: - Resources that have a key called `foo` labels.foo:* - Resources that have a key called `foo` whose value is `bar` labels.foo = bar * @param {string=} params.orderBy Field to use to sort the list. * @param {integer=} params.pageSize Number of `ConnectivityTests` to return. * @param {string=} params.pageToken Page token from an earlier query, as returned in `next_page_token`. @@ -1971,7 +1975,7 @@ export namespace networkmanagement_v1beta1 { * const res = await networkmanagement.projects.locations.global.connectivityTests.patch( * { * // Required. Unique name of the resource using the form: - * // `projects/{project_id}/tests/{test_id}` + * // `projects/{project_id}/locations/global/connectivityTests/{test}` * name: * 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', * // Required. Mask of fields to update. At least one path must be supplied in @@ -2018,7 +2022,7 @@ export namespace networkmanagement_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Unique name of the resource using the form: `projects/{project_id}/tests/{test_id}` + * @param {string} params.name Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test}` * @param {string=} params.updateMask Required. Mask of fields to update. At least one path must be supplied in this field. * @param {().ConnectivityTest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2114,7 +2118,7 @@ export namespace networkmanagement_v1beta1 { * const res = await networkmanagement.projects.locations.global.connectivityTests.rerun( * { * // Required. Connectivity Test resource name using the form: - * // `projects/{project_id}/connectivityTests/{test_id}` + * // `projects/{project_id}/locations/global/connectivityTests/{test_id}` * name: * 'projects/my-project/locations/global/connectivityTests/my-connectivityTest', * @@ -2146,7 +2150,7 @@ export namespace networkmanagement_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Connectivity Test resource name using the form: `projects/{project_id}/connectivityTests/{test_id}` + * @param {string} params.name Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` * @param {().RerunConnectivityTestRequest} params.requestBody 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. @@ -2217,7 +2221,7 @@ export namespace networkmanagement_v1beta1 { /** * networkmanagement.projects.locations.global.connectivityTests.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -2347,7 +2351,7 @@ export namespace networkmanagement_v1beta1 { /** * networkmanagement.projects.locations.global.connectivityTests.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 the sample: * // - Enable the API at: @@ -2510,7 +2514,7 @@ export namespace networkmanagement_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Connectivity Test resource name using the form: `projects/{project_id}/connectivityTests/{test_id}` + * Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` */ name?: string; } @@ -2534,7 +2538,7 @@ export namespace networkmanagement_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -2550,7 +2554,7 @@ export namespace networkmanagement_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/connectivityTests/test-1 - Filter by labels: - Resources that have a key called `foo` labels.foo:* - Resources that have a key called `foo` whose value is `bar` labels.foo = bar + * Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1 - Filter by labels: - Resources that have a key called `foo` labels.foo:* - Resources that have a key called `foo` whose value is `bar` labels.foo = bar */ filter?: string; /** @@ -2578,7 +2582,7 @@ export namespace networkmanagement_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Unique name of the resource using the form: `projects/{project_id}/tests/{test_id}` + * Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test}` */ name?: string; /** @@ -2599,7 +2603,7 @@ export namespace networkmanagement_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Connectivity Test resource name using the form: `projects/{project_id}/connectivityTests/{test_id}` + * Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` */ name?: string; diff --git a/src/apis/osconfig/v1.ts b/src/apis/osconfig/v1.ts index a715e5850b7..c09f99c06e7 100644 --- a/src/apis/osconfig/v1.ts +++ b/src/apis/osconfig/v1.ts @@ -160,7 +160,7 @@ export namespace osconfig_v1 { */ allowedSuccessCodes?: number[] | null; /** - * A Google Cloud Storage object containing the executable. + * A Cloud Storage object containing the executable. */ gcsObject?: Schema$GcsObject; /** @@ -173,7 +173,7 @@ export namespace osconfig_v1 { localPath?: string | null; } /** - * A request message to initiate patching across Google Compute Engine instances. + * A request message to initiate patching across Compute Engine instances. */ export interface Schema$ExecutePatchJobRequest { /** @@ -202,19 +202,19 @@ export namespace osconfig_v1 { patchConfig?: Schema$PatchConfig; } /** - * Google Cloud Storage object representation. + * Cloud Storage object representation. */ export interface Schema$GcsObject { /** - * Required. Bucket of the Google Cloud Storage object. + * Required. Bucket of the Cloud Storage object. */ bucket?: string | null; /** - * Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. + * Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. */ generationNumber?: string | null; /** - * Required. Name of the Google Cloud Storage object. + * Required. Name of the Cloud Storage object. */ object?: string | null; } @@ -275,7 +275,7 @@ export namespace osconfig_v1 { weekDayOfMonth?: Schema$WeekDayOfMonth; } /** - * Sets the time for a one time patch deployment. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + * Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ export interface Schema$OneTimeSchedule { /** @@ -321,11 +321,11 @@ export namespace osconfig_v1 { zypper?: Schema$ZypperSettings; } /** - * Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](/compute/docs/os-patch-management/schedule-patch-jobs). + * Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). */ export interface Schema$PatchDeployment { /** - * Output only. Time the patch deployment was created. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + * Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ createTime?: string | null; /** @@ -341,7 +341,7 @@ export namespace osconfig_v1 { */ instanceFilter?: Schema$PatchInstanceFilter; /** - * Output only. The last time a patch job was started by this deployment. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + * Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ lastExecuteTime?: string | null; /** @@ -361,7 +361,7 @@ export namespace osconfig_v1 { */ recurringSchedule?: Schema$RecurringSchedule; /** - * Output only. Time the patch deployment was last updated. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + * Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339]("https://www.ietf.org/rfc/rfc3339.txt) text format. */ updateTime?: string | null; } @@ -374,7 +374,7 @@ export namespace osconfig_v1 { */ all?: boolean | null; /** - * Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". + * Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. */ groupLabels?: Schema$PatchInstanceFilterGroupLabel[]; /** @@ -391,16 +391,16 @@ export namespace osconfig_v1 { zones?: string[] | null; } /** - * Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". + * Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`. */ export interface Schema$PatchInstanceFilterGroupLabel { /** - * Google Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. + * Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. */ labels?: {[key: string]: string} | null; } /** - * A high level representation of a patch job that is either in progress or has completed. Instances details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](/compute/docs/os-patch-management/create-patch-job). + * A high level representation of a patch job that is either in progress or has completed. Instances details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). */ export interface Schema$PatchJob { /** @@ -461,7 +461,7 @@ export namespace osconfig_v1 { updateTime?: string | null; } /** - * Patch details for a VM instance. For more information about reviewing VM instance details, see [Listing all VM instance details for a specific patch job](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details). + * Patch details for a VM instance. For more information about reviewing VM instance details, see [Listing all VM instance details for a specific patch job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details). */ export interface Schema$PatchJobInstanceDetails { /** diff --git a/src/apis/osconfig/v1beta.ts b/src/apis/osconfig/v1beta.ts index aa3706c2119..d72c9775a2a 100644 --- a/src/apis/osconfig/v1beta.ts +++ b/src/apis/osconfig/v1beta.ts @@ -491,7 +491,7 @@ export namespace osconfig_v1beta { weekDayOfMonth?: Schema$WeekDayOfMonth; } /** - * Sets the time for a one time patch deployment. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + * Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ export interface Schema$OneTimeSchedule { /** @@ -575,11 +575,11 @@ export namespace osconfig_v1beta { zypper?: Schema$ZypperSettings; } /** - * Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](/compute/docs/os-patch-management/schedule-patch-jobs). + * Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). */ export interface Schema$PatchDeployment { /** - * Output only. Time the patch deployment was created. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + * Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ createTime?: string | null; /** @@ -595,7 +595,7 @@ export namespace osconfig_v1beta { */ instanceFilter?: Schema$PatchInstanceFilter; /** - * Output only. The last time a patch job was started by this deployment. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + * Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ lastExecuteTime?: string | null; /** @@ -615,7 +615,7 @@ export namespace osconfig_v1beta { */ recurringSchedule?: Schema$RecurringSchedule; /** - * Output only. Time the patch deployment was last updated. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + * Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339]("https://www.ietf.org/rfc/rfc3339.txt) text format. */ updateTime?: string | null; } @@ -654,7 +654,7 @@ export namespace osconfig_v1beta { labels?: {[key: string]: string} | null; } /** - * A high level representation of a patch job that is either in progress or has completed. Instances details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](/compute/docs/os-patch-management/create-patch-job). + * A high level representation of a patch job that is either in progress or has completed. Instances details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). */ export interface Schema$PatchJob { /** @@ -715,7 +715,7 @@ export namespace osconfig_v1beta { updateTime?: string | null; } /** - * Patch details for a VM instance. For more information about reviewing VM instance details, see [Listing all VM instance details for a specific patch job](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details). + * Patch details for a VM instance. For more information about reviewing VM instance details, see [Listing all VM instance details for a specific patch job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details). */ export interface Schema$PatchJobInstanceDetails { /** @@ -846,7 +846,7 @@ export namespace osconfig_v1beta { weekly?: Schema$WeeklySchedule; } /** - * A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `INSTALLED_KEEP_UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. + * A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. */ export interface Schema$SoftwareRecipe { /** @@ -854,7 +854,7 @@ export namespace osconfig_v1beta { */ artifacts?: Schema$SoftwareRecipeArtifact[]; /** - * Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. INSTALLED_KEEP_UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. + * Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. */ desiredState?: string | null; /** diff --git a/src/apis/pagespeedonline/index.ts b/src/apis/pagespeedonline/index.ts index 6d13f18e45b..809d82af9f6 100644 --- a/src/apis/pagespeedonline/index.ts +++ b/src/apis/pagespeedonline/index.ts @@ -14,24 +14,16 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {pagespeedonline_v1} from './v1'; import {pagespeedonline_v2} from './v2'; import {pagespeedonline_v4} from './v4'; import {pagespeedonline_v5} from './v5'; export const VERSIONS = { - v1: pagespeedonline_v1.Pagespeedonline, v2: pagespeedonline_v2.Pagespeedonline, v4: pagespeedonline_v4.Pagespeedonline, v5: pagespeedonline_v5.Pagespeedonline, }; -export function pagespeedonline( - version: 'v1' -): pagespeedonline_v1.Pagespeedonline; -export function pagespeedonline( - options: pagespeedonline_v1.Options -): pagespeedonline_v1.Pagespeedonline; export function pagespeedonline( version: 'v2' ): pagespeedonline_v2.Pagespeedonline; @@ -52,15 +44,12 @@ export function pagespeedonline( ): pagespeedonline_v5.Pagespeedonline; export function pagespeedonline< T = - | pagespeedonline_v1.Pagespeedonline | pagespeedonline_v2.Pagespeedonline | pagespeedonline_v4.Pagespeedonline | pagespeedonline_v5.Pagespeedonline >( this: GoogleConfigurable, versionOrOptions: - | 'v1' - | pagespeedonline_v1.Options | 'v2' | pagespeedonline_v2.Options | 'v4' diff --git a/src/apis/pagespeedonline/v1.ts b/src/apis/pagespeedonline/v1.ts deleted file mode 100644 index 58fa4c66a8b..00000000000 --- a/src/apis/pagespeedonline/v1.ts +++ /dev/null @@ -1,366 +0,0 @@ -// Copyright 2020 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. - -/* eslint-disable @typescript-eslint/no-explicit-any */ -/* eslint-disable @typescript-eslint/class-name-casing */ -/* eslint-disable @typescript-eslint/no-unused-vars */ -/* eslint-disable @typescript-eslint/no-empty-interface */ -/* eslint-disable @typescript-eslint/no-namespace */ -/* eslint-disable no-irregular-whitespace */ - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, - GaxiosPromise, - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; - -export namespace pagespeedonline_v1 { - export interface Options extends GlobalOptions { - version: 'v1'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: 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; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * PageSpeed Insights API - * - * Analyzes the performance of a web page and provides tailored suggestions to make that page faster. - * - * @example - * const {google} = require('googleapis'); - * const pagespeedonline = google.pagespeedonline('v1'); - * - * @namespace pagespeedonline - * @type {Function} - * @version v1 - * @variation v1 - * @param {object=} options Options for Pagespeedonline - */ - export class Pagespeedonline { - context: APIRequestContext; - pagespeedapi: Resource$Pagespeedapi; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.pagespeedapi = new Resource$Pagespeedapi(this.context); - } - } - - export interface Schema$Result { - /** - * The captcha verify result - */ - captchaResult?: string | null; - /** - * Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. - */ - formattedResults?: { - locale?: string; - ruleResults?: { - [key: string]: { - localizedRuleName?: string; - ruleImpact?: number; - urlBlocks?: Array<{ - header?: { - args?: Array<{type?: string; value?: string}>; - format?: string; - }; - urls?: Array<{ - details?: Array<{ - args?: Array<{type?: string; value?: string}>; - format?: string; - }>; - result?: { - args?: Array<{type?: string; value?: string}>; - format?: string; - }; - }>; - }>; - }; - }; - } | null; - /** - * Canonicalized and final URL for the document, after following page redirects (if any). - */ - id?: string | null; - /** - * List of rules that were specified in the request, but which the server did not know how to instantiate. - */ - invalidRules?: string[] | null; - /** - * Kind of result. - */ - kind?: string | null; - /** - * Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. - */ - pageStats?: { - cssResponseBytes?: string; - flashResponseBytes?: string; - htmlResponseBytes?: string; - imageResponseBytes?: string; - javascriptResponseBytes?: string; - numberCssResources?: number; - numberHosts?: number; - numberJsResources?: number; - numberResources?: number; - numberStaticResources?: number; - otherResponseBytes?: string; - textResponseBytes?: string; - totalRequestBytes?: string; - } | null; - /** - * Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. - */ - responseCode?: number | null; - /** - * 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 | null; - /** - * Base64-encoded screenshot of the page that was analyzed. - */ - screenshot?: { - data?: string; - height?: number; - mime_type?: string; - width?: number; - } | null; - /** - * Title of the page, as displayed in the browser's title bar. - */ - title?: string | null; - /** - * The version of PageSpeed used to generate these results. - */ - version?: {major?: number; minor?: number} | null; - } - - export class Resource$Pagespeedapi { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * 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. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/pagespeedonline.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const pagespeedonline = google.pagespeedonline('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await pagespeedonline.pagespeedapi.runpagespeed({ - * // Indicates if third party resources should be filtered out before PageSpeed analysis. - * filter_third_party_resources: 'placeholder-value', - * // The locale used to localize formatted results - * locale: '[a-zA-Z]+(_[a-zA-Z]+)?', - * // A PageSpeed rule to run; if none are given, all rules are run - * rule: '[a-zA-Z]+', - * // Indicates if binary data containing a screenshot should be included - * screenshot: 'placeholder-value', - * // The analysis strategy to use - * strategy: 'placeholder-value', - * // The URL to fetch and analyze - * url: '(?i)http(s)?://.*', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "captchaResult": "my_captchaResult", - * // "formattedResults": {}, - * // "id": "my_id", - * // "invalidRules": [], - * // "kind": "my_kind", - * // "pageStats": {}, - * // "responseCode": 0, - * // "score": 0, - * // "screenshot": {}, - * // "title": "my_title", - * // "version": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias pagespeedonline.pagespeedapi.runpagespeed - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.filter_third_party_resources Indicates if third party resources should be filtered out before PageSpeed analysis. - * @param {string=} params.locale The locale used to localize formatted results - * @param {string=} params.rule A PageSpeed rule to run; if none are given, all rules are run - * @param {boolean=} params.screenshot Indicates if binary data containing a screenshot should be included - * @param {string=} params.strategy The analysis strategy to use - * @param {string} params.url The URL to fetch and analyze - * @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 - */ - runpagespeed( - params?: Params$Resource$Pagespeedapi$Runpagespeed, - options?: MethodOptions - ): GaxiosPromise; - runpagespeed( - params: Params$Resource$Pagespeedapi$Runpagespeed, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - runpagespeed( - params: Params$Resource$Pagespeedapi$Runpagespeed, - callback: BodyResponseCallback - ): void; - runpagespeed(callback: BodyResponseCallback): void; - runpagespeed( - paramsOrCallback?: - | Params$Resource$Pagespeedapi$Runpagespeed - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Pagespeedapi$Runpagespeed; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pagespeedapi$Runpagespeed; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/pagespeedonline/v1/runPagespeed').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['url'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Pagespeedapi$Runpagespeed - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Indicates if third party resources should be filtered out before PageSpeed analysis. - */ - filter_third_party_resources?: boolean; - /** - * The locale used to localize formatted results - */ - locale?: string; - /** - * A PageSpeed rule to run; if none are given, all rules are run - */ - rule?: string[]; - /** - * Indicates if binary data containing a screenshot should be included - */ - screenshot?: boolean; - /** - * The analysis strategy to use - */ - strategy?: string; - /** - * The URL to fetch and analyze - */ - url?: string; - } -} diff --git a/src/apis/policytroubleshooter/v1.ts b/src/apis/policytroubleshooter/v1.ts index 5b0f9e411fa..0592f57322d 100644 --- a/src/apis/policytroubleshooter/v1.ts +++ b/src/apis/policytroubleshooter/v1.ts @@ -258,7 +258,7 @@ export namespace policytroubleshooter_v1 { */ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$GoogleTypeExpr; /** @@ -271,7 +271,7 @@ export namespace policytroubleshooter_v1 { role?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$GoogleIamV1Policy { /** @@ -287,7 +287,7 @@ export namespace policytroubleshooter_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/policytroubleshooter/v1beta.ts b/src/apis/policytroubleshooter/v1beta.ts index 050310936f5..40fe8fcb1e6 100644 --- a/src/apis/policytroubleshooter/v1beta.ts +++ b/src/apis/policytroubleshooter/v1beta.ts @@ -258,7 +258,7 @@ export namespace policytroubleshooter_v1beta { */ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$GoogleTypeExpr; /** @@ -271,7 +271,7 @@ export namespace policytroubleshooter_v1beta { role?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$GoogleIamV1Policy { /** @@ -287,7 +287,7 @@ export namespace policytroubleshooter_v1beta { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 9987f781aa5..a0a7de1a871 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -127,7 +127,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -306,7 +306,7 @@ export namespace pubsub_v1 { serviceAccountEmail?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -318,7 +318,7 @@ export namespace pubsub_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -396,7 +396,7 @@ export namespace pubsub_v1 { */ 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 | null; } @@ -473,13 +473,17 @@ export namespace pubsub_v1 { */ ackDeadlineSeconds?: number | null; /** - * A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha 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 dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. */ deadLetterPolicy?: Schema$DeadLetterPolicy; /** * 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; + /** + * An expression written in the Cloud Pub/Sub filter language. If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha 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. + */ + filter?: string | null; /** * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ @@ -998,6 +1002,10 @@ export namespace pubsub_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -1022,7 +1030,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -1344,7 +1352,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -1471,7 +1479,7 @@ 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 the sample: * // - Enable the API at: @@ -1653,7 +1661,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -1907,6 +1915,7 @@ export namespace pubsub_v1 { * // "ackDeadlineSeconds": 0, * // "deadLetterPolicy": {}, * // "expirationPolicy": {}, + * // "filter": "my_filter", * // "labels": {}, * // "messageRetentionDuration": "my_messageRetentionDuration", * // "name": "my_name", @@ -1923,6 +1932,7 @@ export namespace pubsub_v1 { * // "ackDeadlineSeconds": 0, * // "deadLetterPolicy": {}, * // "expirationPolicy": {}, + * // "filter": "my_filter", * // "labels": {}, * // "messageRetentionDuration": "my_messageRetentionDuration", * // "name": "my_name", @@ -2161,6 +2171,7 @@ export namespace pubsub_v1 { * // "ackDeadlineSeconds": 0, * // "deadLetterPolicy": {}, * // "expirationPolicy": {}, + * // "filter": "my_filter", * // "labels": {}, * // "messageRetentionDuration": "my_messageRetentionDuration", * // "name": "my_name", @@ -2284,6 +2295,10 @@ export namespace pubsub_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -2308,7 +2323,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -2809,6 +2824,7 @@ export namespace pubsub_v1 { * // "ackDeadlineSeconds": 0, * // "deadLetterPolicy": {}, * // "expirationPolicy": {}, + * // "filter": "my_filter", * // "labels": {}, * // "messageRetentionDuration": "my_messageRetentionDuration", * // "name": "my_name", @@ -3147,7 +3163,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -3274,7 +3290,7 @@ 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 the sample: * // - Enable the API at: @@ -3473,7 +3489,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -4030,6 +4046,10 @@ export namespace pubsub_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -4054,7 +4074,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -4506,7 +4526,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -4633,7 +4653,7 @@ 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 the sample: * // - Enable the API at: @@ -4815,7 +4835,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index 6b33f459dd9..3087ade235b 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -127,7 +127,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -243,7 +243,7 @@ export namespace pubsub_v1beta2 { serviceAccountEmail?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -255,7 +255,7 @@ export namespace pubsub_v1beta2 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -952,6 +952,10 @@ export namespace pubsub_v1beta2 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -976,7 +980,7 @@ export namespace pubsub_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -1548,7 +1552,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -1675,7 +1679,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. * @example * // Before running the sample: * // - Enable the API at: @@ -1874,7 +1878,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -2384,6 +2388,10 @@ export namespace pubsub_v1beta2 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -2408,7 +2416,7 @@ export namespace pubsub_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -2728,7 +2736,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.topics.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -2855,7 +2863,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. * @example * // Before running the sample: * // - Enable the API at: @@ -3037,7 +3045,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index d73d27cc7b3..8f405411d21 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -897,6 +897,10 @@ export namespace remotebuildexecution_v1 { * The autoscale policy to apply on a pool. */ autoscale?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale; + /** + * Channel specifies the release channel of the pool. + */ + channel?: string | null; /** * 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. */ diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index ee0ab1a4ab0..a0d985713d4 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -884,6 +884,10 @@ export namespace remotebuildexecution_v1alpha { * The autoscale policy to apply on a pool. */ autoscale?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale; + /** + * Channel specifies the release channel of the pool. + */ + channel?: string | null; /** * 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. */ @@ -2106,6 +2110,7 @@ export namespace remotebuildexecution_v1alpha { * // Example response * // { * // "autoscale": {}, + * // "channel": "my_channel", * // "name": "my_name", * // "state": "my_state", * // "workerConfig": {}, diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index 5d680f77718..3e93dcd6db8 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -1156,6 +1156,10 @@ export namespace remotebuildexecution_v2 { * The autoscale policy to apply on a pool. */ autoscale?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale; + /** + * Channel specifies the release channel of the pool. + */ + channel?: string | null; /** * 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. */ diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 14cfbf492ce..0512fd05c35 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -167,7 +167,7 @@ export namespace run_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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -579,23 +579,6 @@ export namespace run_v1 { */ value?: string | null; } - /** - * 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 { - /** - * The int value. - */ - intVal?: number | null; - /** - * The string value. - */ - strVal?: string | null; - /** - * The type of the value. - */ - type?: number | null; - } /** * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Maps a string key to a path within a volume. */ @@ -945,7 +928,7 @@ export namespace run_v1 { uid?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -961,7 +944,7 @@ export namespace run_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -1433,9 +1416,9 @@ export namespace run_v1 { */ host?: string | null; /** - * Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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. + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type. */ - port?: Schema$IntOrString; + port?: number | null; } /** * Request message for `TestIamPermissions` method. @@ -8205,6 +8188,10 @@ export namespace run_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -8230,7 +8217,7 @@ export namespace run_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -8891,7 +8878,7 @@ export namespace run_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index 7fb3db8715a..d3a78b4cb5b 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -169,7 +169,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -1551,7 +1551,7 @@ export namespace run_v1alpha1 { uid?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -1567,7 +1567,7 @@ export namespace run_v1alpha1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -13889,6 +13889,10 @@ export namespace run_v1alpha1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -13914,7 +13918,7 @@ export namespace run_v1alpha1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -14576,7 +14580,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index adc5a02fb1f..a3120f9e249 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -118,7 +118,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -242,7 +242,7 @@ export namespace runtimeconfig_v1beta1 { response?: {[key: string]: any} | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -254,7 +254,7 @@ export namespace runtimeconfig_v1beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -816,6 +816,10 @@ export namespace runtimeconfig_v1beta1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -840,7 +844,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @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. @@ -1481,7 +1485,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index ebf2e86ce1c..5a4f8293808 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -319,7 +319,7 @@ export namespace serviceconsumermanagement_v1 { selector?: string | null; } /** - * 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, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index 746505c6ae1..56d521db69c 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -276,7 +276,7 @@ export namespace serviceconsumermanagement_v1beta1 { selector?: string | null; } /** - * 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, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** diff --git a/src/apis/servicedirectory/v1beta1.ts b/src/apis/servicedirectory/v1beta1.ts index 3c0863ad425..6d353202f5a 100644 --- a/src/apis/servicedirectory/v1beta1.ts +++ b/src/apis/servicedirectory/v1beta1.ts @@ -118,7 +118,7 @@ export namespace servicedirectory_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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -190,7 +190,7 @@ export namespace servicedirectory_v1beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -285,7 +285,7 @@ export namespace servicedirectory_v1beta1 { name?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -297,7 +297,7 @@ export namespace servicedirectory_v1beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 6d159b31bee..e8591a23630 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -311,7 +311,7 @@ export namespace servicemanagement_v1 { selector?: string | null; } /** - * 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, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** @@ -337,7 +337,7 @@ 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. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -782,7 +782,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -791,7 +791,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ requestedPolicyVersion?: number | null; } @@ -1269,7 +1269,7 @@ export namespace servicemanagement_v1 { subpages?: Schema$Page[]; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -1285,7 +1285,7 @@ export namespace servicemanagement_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -1519,7 +1519,7 @@ export namespace servicemanagement_v1 { */ 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"` */ updateMask?: string | null; } @@ -3241,7 +3241,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -3371,7 +3371,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. * @example * // Before running the sample: * // - Enable the API at: @@ -4635,7 +4635,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.consumers.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -4765,7 +4765,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. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index d6f6883bc6f..788527be46c 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -343,7 +343,7 @@ export namespace servicenetworking_v1 { selector?: string | null; } /** - * 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, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index bc0542f79fa..2758fa8ccd9 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -326,7 +326,7 @@ export namespace servicenetworking_v1beta { selector?: string | null; } /** - * 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, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 0d1c78522a1..cc660f2efbe 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -325,7 +325,7 @@ 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, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** @@ -2268,7 +2268,7 @@ export namespace serviceusage_v1 { * // An example name would be: * // `projects/123/services/serviceusage.googleapis.com` where `123` is the * // project number. - * // A single request can get a maximum of 20 services at a time. + * // A single request can get a maximum of 30 services at a time. * names: 'placeholder-value', * // Parent to retrieve services from. * // If this is set, the parent of all of the services specified in `names` must @@ -2294,7 +2294,7 @@ export namespace serviceusage_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.names Names of the services to retrieve. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. A single request can get a maximum of 20 services at a time. + * @param {string=} params.names Names of the services to retrieve. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. A single request can get a maximum of 30 services at a time. * @param {string} params.parent Parent to retrieve services from. If this is set, the parent of all of the services specified in `names` must match this field. An example name would be: `projects/123` where `123` is the project number. The `BatchGetServices` method currently only supports projects. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2925,7 +2925,7 @@ export namespace serviceusage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Names of the services to retrieve. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. A single request can get a maximum of 20 services at a time. + * Names of the services to retrieve. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. A single request can get a maximum of 30 services at a time. */ names?: string[]; /** diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index e7c7478d378..10882773565 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -316,7 +316,7 @@ 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, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 2a45c50fa44..f325480cee8 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -497,7 +497,7 @@ export namespace spanner_v1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts index b737656b147..e418d2d3bdf 100644 --- a/src/apis/speech/v1p1beta1.ts +++ b/src/apis/speech/v1p1beta1.ts @@ -131,7 +131,7 @@ export namespace speech_v1p1beta1 { */ export interface Schema$CustomClass { /** - * If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. + * If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive. */ customClassId?: string | null; /** @@ -225,7 +225,7 @@ export namespace speech_v1p1beta1 { response?: {[key: string]: any} | null; } /** - * A phrases containing words and phrase "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-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built $MONTH class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with $ e.g. $MONTH. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in ${...} e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in ${} (e.g. ${my-months}). + * A phrases containing words and phrase "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-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). */ export interface Schema$Phrase { /** diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index bcdb3953769..d6f89ac0cc8 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -184,9 +184,11 @@ export namespace storage_v1 { createdBefore?: string; customTimeBefore?: string; daysSinceCustomTime?: number; + daysSinceNoncurrentTime?: number; isLive?: boolean; matchesPattern?: string; matchesStorageClass?: string[]; + noncurrentTimeBefore?: string; numNewerVersions?: number; }; }>; diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index ddcaad3945b..cc94b5dfc06 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -194,7 +194,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, but not to list the bucket contents. Instead, you can <a href="https://cloud.google.com/storage/docs/json_api/v1/objects/get"> get individual export files</a> by object name. */ bucketName?: string | null; /** diff --git a/src/index.ts b/src/index.ts index a93f4b98d53..1c7855bf607 100644 --- a/src/index.ts +++ b/src/index.ts @@ -97,7 +97,6 @@ export {cloudtasks_v2beta3} from './apis/cloudtasks/v2beta3'; export {cloudtrace_v1} from './apis/cloudtrace/v1'; export {cloudtrace_v2} from './apis/cloudtrace/v2'; export {cloudtrace_v2beta1} from './apis/cloudtrace/v2beta1'; -export {commentanalyzer_v1alpha1} from './apis/commentanalyzer/v1alpha1'; export {composer_v1} from './apis/composer/v1'; export {composer_v1beta1} from './apis/composer/v1beta1'; export {compute_alpha} from './apis/compute/alpha'; @@ -198,7 +197,6 @@ export {osconfig_v1beta} from './apis/osconfig/v1beta'; export {oslogin_v1} from './apis/oslogin/v1'; export {oslogin_v1alpha} from './apis/oslogin/v1alpha'; export {oslogin_v1beta} from './apis/oslogin/v1beta'; -export {pagespeedonline_v1} from './apis/pagespeedonline/v1'; export {pagespeedonline_v2} from './apis/pagespeedonline/v2'; export {pagespeedonline_v4} from './apis/pagespeedonline/v4'; export {pagespeedonline_v5} from './apis/pagespeedonline/v5';