From 939730cc605ef5a62fa5a5653801f2da12dfb363 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:45 +0000 Subject: [PATCH 01/78] feat(admin): update the API #### admin:directory_v1 The following keys were added: - schemas.BacklightInfo.description - schemas.BacklightInfo.id - schemas.BacklightInfo.properties.brightness.description - schemas.BacklightInfo.properties.brightness.format - schemas.BacklightInfo.properties.brightness.readOnly - schemas.BacklightInfo.properties.brightness.type - schemas.BacklightInfo.properties.maxBrightness.description - schemas.BacklightInfo.properties.maxBrightness.format - schemas.BacklightInfo.properties.maxBrightness.readOnly - schemas.BacklightInfo.properties.maxBrightness.type - schemas.BacklightInfo.properties.path.description - schemas.BacklightInfo.properties.path.readOnly - schemas.BacklightInfo.properties.path.type - schemas.BacklightInfo.type - schemas.ChromeOsDevice.properties.backlightInfo.description - schemas.ChromeOsDevice.properties.backlightInfo.items.$ref - schemas.ChromeOsDevice.properties.backlightInfo.readOnly - schemas.ChromeOsDevice.properties.backlightInfo.type --- discovery/admin-directory_v1.json | 34 ++++++++++++++++++++++++++++++- src/apis/admin/directory_v1.ts | 21 +++++++++++++++++++ 2 files changed, 54 insertions(+), 1 deletion(-) diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index ce58f0a95a8..e819a0925d7 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -4671,7 +4671,7 @@ } } }, - "revision": "20240227", + "revision": "20240304", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -4810,6 +4810,30 @@ }, "type": "object" }, + "BacklightInfo": { + "description": "Information about the device's backlights.", + "id": "BacklightInfo", + "properties": { + "brightness": { + "description": "Output only. Current brightness of the backlight, between 0 and max_brightness.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "maxBrightness": { + "description": "Output only. Maximum brightness for the backlight.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "path": { + "description": "Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "BatchChangeChromeOsDeviceStatusRequest": { "description": "A request for changing the status of a batch of ChromeOS devices.", "id": "BatchChangeChromeOsDeviceStatusRequest", @@ -5383,6 +5407,14 @@ "format": "int64", "type": "string" }, + "backlightInfo": { + "description": "Output only. Contains backlight information for the device.", + "items": { + "$ref": "BacklightInfo" + }, + "readOnly": true, + "type": "array" + }, "bootMode": { "description": "The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).", "type": "string" diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index dbbd9bbd096..eb0d1733e20 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -244,6 +244,23 @@ export namespace admin_directory_v1 { */ severity?: string | null; } + /** + * Information about the device's backlights. + */ + export interface Schema$BacklightInfo { + /** + * Output only. Current brightness of the backlight, between 0 and max_brightness. + */ + brightness?: number | null; + /** + * Output only. Maximum brightness for the backlight. + */ + maxBrightness?: number | null; + /** + * Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information. + */ + path?: string | null; + } /** * A request for changing the status of a batch of ChromeOS devices. */ @@ -632,6 +649,10 @@ export namespace admin_directory_v1 { * (Read-only) The timestamp after which the device will stop receiving Chrome updates or support */ autoUpdateExpiration?: string | null; + /** + * Output only. Contains backlight information for the device. + */ + backlightInfo?: Schema$BacklightInfo[]; /** * The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). */ From bee5953b9728ff802c37430e5dd03e0aab16e0fd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:46 +0000 Subject: [PATCH 02/78] feat(aiplatform): update the API #### aiplatform:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.id - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.path - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.id - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.path - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.id - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.permissions.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.permissions.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.permissions.repeated - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.permissions.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.path - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.permissions.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.permissions.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.permissions.repeated - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.permissions.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.id - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.path - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.id - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.path - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.id - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.path - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.id - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.path - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait.scopes - schemas.CloudAiNlLlmProtoServicePart.properties.documentMetadata.$ref - schemas.CloudAiNlLlmProtoServicePart.properties.documentMetadata.description - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.description - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.id - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.originalDocumentBlob.$ref - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.originalDocumentBlob.description - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.pageNumber.description - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.pageNumber.format - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.pageNumber.type - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.type - schemas.CloudAiNlLlmProtoServiceRaiSignal.properties.influentialTerms.description - schemas.CloudAiNlLlmProtoServiceRaiSignal.properties.influentialTerms.items.$ref - schemas.CloudAiNlLlmProtoServiceRaiSignal.properties.influentialTerms.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.id - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.beginOffset.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.beginOffset.format - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.beginOffset.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.confidence.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.confidence.format - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.confidence.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.source.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.source.enum - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.source.enumDescriptions - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.source.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.term.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.term.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.type - schemas.GoogleCloudAiplatformV1beta1DatasetVersion.properties.metadata.readOnly The following keys were changed: - resources.projects.resources.locations.resources.endpoints.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.models.methods.list.parameters.filter.description - schemas.CloudAiNlLlmProtoServiceCandidate.properties.finishReason.enum - schemas.CloudAiNlLlmProtoServiceCandidate.properties.finishReason.enumDescriptions - schemas.CloudAiNlLlmProtoServicePromptFeedback.properties.blockReason.enum - schemas.CloudAiNlLlmProtoServicePromptFeedback.properties.blockReason.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.finishReason.enum - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.finishReason.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1DatasetVersion.properties.metadata.description - schemas.GoogleCloudAiplatformV1beta1FeatureView.properties.serviceAgentType.description - schemas.GoogleCloudAiplatformV1beta1FindNeighborsRequest.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback.properties.blockReason.enum - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback.properties.blockReason.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1PersistentResource.properties.state.enum - schemas.GoogleCloudAiplatformV1beta1PersistentResource.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1PublisherModel.properties.launchStage.enum - schemas.GoogleCloudAiplatformV1beta1PublisherModel.properties.launchStage.enumDescriptions - schemas.LearningGenaiRootCodeyChatMetadata.properties.codeLanguage.enum - schemas.LearningGenaiRootCodeyChatMetadata.properties.codeLanguage.enumDescriptions #### aiplatform:v1 The following keys were added: - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.description - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.flatPath - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.httpMethod - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.id - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.parameterOrder - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.parameters.parent.description - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.parameters.parent.location - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.parameters.parent.pattern - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.parameters.parent.required - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.parameters.parent.type - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.path - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.request.$ref - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.response.$ref - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel.scopes - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.description - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.flatPath - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.httpMethod - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.id - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.parameterOrder - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.parameters.parent.description - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.parameters.parent.location - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.parameters.parent.pattern - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.parameters.parent.required - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.parameters.parent.type - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.path - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.request.$ref - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.response.$ref - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete.scopes - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.id - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.path - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.scopes - schemas.CloudAiNlLlmProtoServicePart.properties.documentMetadata.$ref - schemas.CloudAiNlLlmProtoServicePart.properties.documentMetadata.description - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.description - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.id - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.originalDocumentBlob.$ref - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.originalDocumentBlob.description - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.pageNumber.description - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.pageNumber.format - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.properties.pageNumber.type - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata.type - schemas.CloudAiNlLlmProtoServiceRaiSignal.properties.influentialTerms.description - schemas.CloudAiNlLlmProtoServiceRaiSignal.properties.influentialTerms.items.$ref - schemas.CloudAiNlLlmProtoServiceRaiSignal.properties.influentialTerms.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.id - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.beginOffset.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.beginOffset.format - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.beginOffset.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.confidence.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.confidence.format - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.confidence.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.source.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.source.enum - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.source.enumDescriptions - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.source.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.term.description - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.properties.term.type - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm.type - schemas.GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest.description - schemas.GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest.id - schemas.GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest.properties.names.description - schemas.GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest.properties.names.items.type - schemas.GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest.properties.names.type - schemas.GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest.type - schemas.GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest.description - schemas.GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest.id - schemas.GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest.properties.names.description - schemas.GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest.properties.names.items.type - schemas.GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest.properties.names.type - schemas.GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest.type - schemas.GoogleCloudAiplatformV1DatasetVersion.properties.metadata.readOnly - schemas.GoogleCloudAiplatformV1GenieSource.description - schemas.GoogleCloudAiplatformV1GenieSource.id - schemas.GoogleCloudAiplatformV1GenieSource.properties.baseModelUri.description - schemas.GoogleCloudAiplatformV1GenieSource.properties.baseModelUri.type - schemas.GoogleCloudAiplatformV1GenieSource.type - schemas.GoogleCloudAiplatformV1Model.properties.baseModelSource.$ref - schemas.GoogleCloudAiplatformV1Model.properties.baseModelSource.description - schemas.GoogleCloudAiplatformV1ModelBaseModelSource.description - schemas.GoogleCloudAiplatformV1ModelBaseModelSource.id - schemas.GoogleCloudAiplatformV1ModelBaseModelSource.properties.genieSource.$ref - schemas.GoogleCloudAiplatformV1ModelBaseModelSource.properties.genieSource.description - schemas.GoogleCloudAiplatformV1ModelBaseModelSource.properties.modelGardenSource.$ref - schemas.GoogleCloudAiplatformV1ModelBaseModelSource.properties.modelGardenSource.description - schemas.GoogleCloudAiplatformV1ModelBaseModelSource.type - schemas.GoogleCloudAiplatformV1ModelGardenSource.description - schemas.GoogleCloudAiplatformV1ModelGardenSource.id - schemas.GoogleCloudAiplatformV1ModelGardenSource.properties.publicModelName.description - schemas.GoogleCloudAiplatformV1ModelGardenSource.properties.publicModelName.type - schemas.GoogleCloudAiplatformV1ModelGardenSource.type The following keys were changed: - resources.projects.resources.locations.resources.endpoints.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.models.methods.list.parameters.filter.description - schemas.CloudAiNlLlmProtoServiceCandidate.properties.finishReason.enum - schemas.CloudAiNlLlmProtoServiceCandidate.properties.finishReason.enumDescriptions - schemas.CloudAiNlLlmProtoServicePromptFeedback.properties.blockReason.enum - schemas.CloudAiNlLlmProtoServicePromptFeedback.properties.blockReason.enumDescriptions - schemas.GoogleCloudAiplatformV1Candidate.properties.finishReason.enum - schemas.GoogleCloudAiplatformV1Candidate.properties.finishReason.enumDescriptions - schemas.GoogleCloudAiplatformV1DatasetVersion.properties.metadata.description - schemas.GoogleCloudAiplatformV1FindNeighborsRequest.description - schemas.GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback.properties.blockReason.enum - schemas.GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback.properties.blockReason.enumDescriptions - schemas.GoogleCloudAiplatformV1PublisherModel.properties.launchStage.enum - schemas.GoogleCloudAiplatformV1PublisherModel.properties.launchStage.enumDescriptions - schemas.LearningGenaiRootCodeyChatMetadata.properties.codeLanguage.enum - schemas.LearningGenaiRootCodeyChatMetadata.properties.codeLanguage.enumDescriptions --- discovery/aiplatform-v1.json | 408 +++++-- discovery/aiplatform-v1beta1.json | 707 ++++++++++-- src/apis/aiplatform/v1.ts | 534 ++++++++- src/apis/aiplatform/v1beta1.ts | 1761 ++++++++++++++++++++++++++++- 4 files changed, 3264 insertions(+), 146 deletions(-) diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index ef6f07ce7c0..07a20a825a0 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -20,24 +20,24 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "location": "asia-east1", - "description": "Locational Endpoint", - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "asia-east2" + "location": "asia-east2", + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", - "location": "asia-northeast1", - "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", + "location": "asia-northeast1" }, { "description": "Locational Endpoint", - "location": "asia-northeast2", - "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", + "location": "asia-northeast2" }, { "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", @@ -46,78 +46,78 @@ }, { "description": "Locational Endpoint", - "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", - "location": "asia-south1" + "location": "asia-south1", + "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", - "location": "asia-southeast1" + "location": "asia-southeast1", + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "asia-southeast2" }, { + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "australia-southeast1", - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/" + "location": "australia-southeast1" }, { - "description": "Locational Endpoint", "location": "australia-southeast2", - "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "location": "europe-central2", - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", + "location": "europe-central2" }, { - "location": "europe-north1", "description": "Locational Endpoint", - "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", + "location": "europe-north1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "location": "europe-southwest1", - "description": "Locational Endpoint" + "location": "europe-southwest1" }, { - "location": "europe-west1", "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", + "location": "europe-west1", "description": "Locational Endpoint" }, { "location": "europe-west2", - "description": "Locational Endpoint", - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "europe-west3" + "location": "europe-west3", + "description": "Locational Endpoint" }, { - "location": "europe-west4", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west4" }, { + "location": "europe-west6", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", - "location": "europe-west6" + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", "location": "europe-west8", - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", + "location": "europe-west9", "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "location": "europe-west9" + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", @@ -125,49 +125,49 @@ "location": "me-west1" }, { + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", "location": "northamerica-northeast1", - "description": "Locational Endpoint", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "location": "northamerica-northeast2", "description": "Locational Endpoint", + "location": "northamerica-northeast2", "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" }, { "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "southamerica-east1" + "location": "southamerica-east1", + "description": "Locational Endpoint" }, { - "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", "location": "southamerica-west1" }, { + "location": "us-central1", "description": "Locational Endpoint", - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", - "location": "us-central1" + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", - "location": "us-central2", - "description": "Locational Endpoint" + "location": "us-central2" }, { - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "us-east1", - "description": "Locational Endpoint" + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/" }, { - "location": "us-east4", "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", + "location": "us-east4", "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "location": "us-south1" + "location": "us-south1", + "description": "Locational Endpoint" }, { "location": "us-west1", @@ -176,17 +176,17 @@ }, { "location": "us-west2", - "description": "Locational Endpoint", - "endpointUrl": "https://us-west2-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "location": "us-west3", "description": "Locational Endpoint", - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", + "location": "us-west3" }, { - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", "location": "us-west4", + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", "description": "Locational Endpoint" } ], @@ -3217,7 +3217,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query", "type": "string" }, @@ -10036,7 +10036,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query", "type": "string" }, @@ -11620,6 +11620,62 @@ }, "pipelineJobs": { "methods": { + "batchCancel": { + "description": "Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.batchCancel", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/pipelineJobs:batchCancel", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "batchDelete": { + "description": "Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/pipelineJobs:batchDelete", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "cancel": { "description": "Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel", @@ -15501,6 +15557,64 @@ } } } + }, + "tuningJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } } @@ -15562,7 +15676,7 @@ } } }, - "revision": "20240224", + "revision": "20240312", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -15957,7 +16071,10 @@ "FINISH_REASON_MAX_TOKENS", "FINISH_REASON_SAFETY", "FINISH_REASON_RECITATION", - "FINISH_REASON_OTHER" + "FINISH_REASON_OTHER", + "FINISH_REASON_BLOCKLIST", + "FINISH_REASON_PROHIBITED_CONTENT", + "FINISH_REASON_SPII" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -15965,7 +16082,10 @@ "The maximum number of tokens as specified in the request was reached.", "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", "The token generation was stopped as the response was flagged for unauthorized citations.", - "All other reasons that stopped the token generation." + "All other reasons that stopped the token generation.", + "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", + "The token generation was stopped as the response was flagged for the prohibited contents.", + "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." ], "type": "string" }, @@ -16175,6 +16295,10 @@ "description": "A single part of a message.", "id": "CloudAiNlLlmProtoServicePart", "properties": { + "documentMetadata": { + "$ref": "CloudAiNlLlmProtoServicePartDocumentMetadata", + "description": "Document metadata. The metadata should only be used by the Cloud LLM when supporting document mime types. It will only be populated when this image input part is converted from a document input part." + }, "fileData": { "$ref": "CloudAiNlLlmProtoServicePartFileData", "description": "URI-based data." @@ -16222,6 +16346,22 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServicePartDocumentMetadata": { + "description": "Metadata describes the original input document content.", + "id": "CloudAiNlLlmProtoServicePartDocumentMetadata", + "properties": { + "originalDocumentBlob": { + "$ref": "CloudAiNlLlmProtoServicePartBlob", + "description": "The original document blob." + }, + "pageNumber": { + "description": "The (1-indexed) page number of the image in the original document. The first page carries the original document content and mime type.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServicePartFileData": { "description": "Represents file data.", "id": "CloudAiNlLlmProtoServicePartFileData", @@ -16263,12 +16403,16 @@ "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", - "OTHER" + "OTHER", + "BLOCKLIST", + "PROHIBITED_CONTENT" ], "enumDescriptions": [ "Unspecified blocked reason.", "Candidates blocked due to safety.", - "Candidates blocked due to other reason." + "Candidates blocked due to other reason.", + "Candidates blocked due to the terms which are included from the terminology blocklist.", + "Candidates blocked due to prohibited content." ], "type": "string" }, @@ -16363,6 +16507,13 @@ "description": "Whether the category is flagged as being present. Currently, this is set to true if score >= 0.5.", "type": "boolean" }, + "influentialTerms": { + "description": "The influential terms that could potentially block the response.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm" + }, + "type": "array" + }, "raiCategory": { "description": "The RAI category.", "enum": [ @@ -16451,6 +16602,41 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm": { + "description": "The influential term that could potentially block the response.", + "id": "CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm", + "properties": { + "beginOffset": { + "description": "The beginning offset of the influential term.", + "format": "int32", + "type": "integer" + }, + "confidence": { + "description": "The confidence score of the influential term.", + "format": "float", + "type": "number" + }, + "source": { + "description": "The source of the influential term, prompt or response.", + "enum": [ + "SOURCE_UNSPECIFIED", + "PROMPT", + "RESPONSE" + ], + "enumDescriptions": [ + "Unspecified source.", + "The influential term comes from the prompt.", + "The influential term comes from the response." + ], + "type": "string" + }, + "term": { + "description": "The influential term.", + "type": "string" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServiceSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "CloudAiNlLlmProtoServiceSafetyRating", @@ -17003,6 +17189,20 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest": { + "description": "Request message for PipelineService.BatchCancelPipelineJobs.", + "id": "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest", + "properties": { + "names": { + "description": "Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata": { "description": "Details of operations that perform batch create Features.", "id": "GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata", @@ -17119,6 +17319,20 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest": { + "description": "Request message for PipelineService.BatchDeletePipelineJobs.", + "id": "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest", + "properties": { + "names": { + "description": "Required. The names of the PipelineJobs to delete. A maximum of 32 PipelineJobs can be deleted in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest": { "description": "Request message for ModelService.BatchImportEvaluatedAnnotations", "id": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest", @@ -17733,7 +17947,10 @@ "MAX_TOKENS", "SAFETY", "RECITATION", - "OTHER" + "OTHER", + "BLOCKLIST", + "PROHIBITED_CONTENT", + "SPII" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -17741,7 +17958,10 @@ "The maximum number of tokens as specified in the request was reached.", "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", "The token generation was stopped as the response was flagged for unauthorized citations.", - "All other reasons that stopped the token generation" + "All other reasons that stopped the token generation", + "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", + "The token generation was stopped as the response was flagged for the prohibited contents.", + "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." ], "readOnly": true, "type": "string" @@ -18916,7 +19136,8 @@ "type": "string" }, "metadata": { - "description": "Required. Additional information about the DatasetVersion.", + "description": "Required. Output only. Additional information about the DatasetVersion.", + "readOnly": true, "type": "any" }, "name": { @@ -21703,7 +21924,7 @@ "type": "object" }, "GoogleCloudAiplatformV1FindNeighborsRequest": { - "description": "The request message for MatchService.FindNeighbors.", + "description": "LINT.IfChange The request message for MatchService.FindNeighbors.", "id": "GoogleCloudAiplatformV1FindNeighborsRequest", "properties": { "deployedIndexId": { @@ -21972,12 +22193,16 @@ "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", - "OTHER" + "OTHER", + "BLOCKLIST", + "PROHIBITED_CONTENT" ], "enumDescriptions": [ "Unspecified blocked reason.", "Candidates blocked due to safety.", - "Candidates blocked due to other reason." + "Candidates blocked due to other reason.", + "Candidates blocked due to the terms which are included from the terminology blocklist.", + "Candidates blocked due to prohibited content." ], "readOnly": true, "type": "string" @@ -22085,6 +22310,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GenieSource": { + "description": "Contains information about the source of the models generated from Generative AI Studio.", + "id": "GoogleCloudAiplatformV1GenieSource", + "properties": { + "baseModelUri": { + "description": "Required. The public base model URI.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GroundingAttribution": { "description": "Grounding attribution.", "id": "GoogleCloudAiplatformV1GroundingAttribution", @@ -24236,6 +24472,10 @@ "description": "Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.", "type": "string" }, + "baseModelSource": { + "$ref": "GoogleCloudAiplatformV1ModelBaseModelSource", + "description": "Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models." + }, "containerSpec": { "$ref": "GoogleCloudAiplatformV1ModelContainerSpec", "description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." @@ -24406,6 +24646,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ModelBaseModelSource": { + "description": "User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.", + "id": "GoogleCloudAiplatformV1ModelBaseModelSource", + "properties": { + "genieSource": { + "$ref": "GoogleCloudAiplatformV1GenieSource", + "description": "Information about the base model of Genie models." + }, + "modelGardenSource": { + "$ref": "GoogleCloudAiplatformV1ModelGardenSource", + "description": "Source information of Model Garden models." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ModelContainerSpec": { "description": "Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).", "id": "GoogleCloudAiplatformV1ModelContainerSpec", @@ -25013,6 +25268,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ModelGardenSource": { + "description": "Contains information about the source of the models generated from Model Garden.", + "id": "GoogleCloudAiplatformV1ModelGardenSource", + "properties": { + "publicModelName": { + "description": "Required. The model garden source model resource name.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ModelMonitoringAlertConfig": { "description": "The alert config for model monitoring.", "id": "GoogleCloudAiplatformV1ModelMonitoringAlertConfig", @@ -27104,7 +27370,6 @@ "description": "Optional. Indicates the launch stage of the model.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", - "DOGFOOD", "EXPERIMENTAL", "PRIVATE_PREVIEW", "PUBLIC_PREVIEW", @@ -27112,7 +27377,6 @@ ], "enumDescriptions": [ "The model launch stage is unspecified.", - "Used to indicate the PublisherModel is at Google internal testing launch stage.", "Used to indicate the PublisherModel is at Experimental launch stage, available to a small set of customers.", "Used to indicate the PublisherModel is at Private Preview launch stage, only available to a small set of customers, although a larger set of customers than an Experimental launch. Previews are the first launch stage used to get feedback from customers.", "Used to indicate the PublisherModel is at Public Preview launch stage, available to all customers, although not supported for production workloads.", @@ -37977,6 +38241,7 @@ "C", "DART", "GRADLE", + "GROOVY", "JAVADOC", "JSON", "MAKEFILE", @@ -38004,6 +38269,7 @@ "C code.", "Dart code.", "Gradle code.", + "Groovy code.", "API documentation.", "JSON code.", "Makefile code.", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index e2b930822ac..7279b385ea2 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -20,44 +20,44 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "location": "asia-east1", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-east1" }, { + "description": "Locational Endpoint", "location": "asia-east2", - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" }, { "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", - "location": "asia-northeast1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-northeast1" }, { - "description": "Locational Endpoint", + "location": "asia-northeast2", "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "location": "asia-northeast2" + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", - "location": "asia-northeast3" + "location": "asia-northeast3", + "description": "Locational Endpoint" }, { - "location": "asia-south1", "description": "Locational Endpoint", + "location": "asia-south1", "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/" }, { + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", "location": "asia-southeast1", - "description": "Locational Endpoint", - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", - "location": "asia-southeast2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-southeast2" }, { "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", @@ -70,28 +70,28 @@ "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" }, { - "location": "europe-central2", "description": "Locational Endpoint", + "location": "europe-central2", "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "europe-north1", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" }, { - "location": "europe-southwest1", "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-southwest1" }, { + "location": "europe-west1", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", - "location": "europe-west1" + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/" }, { - "location": "europe-west2", "description": "Locational Endpoint", + "location": "europe-west2", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" }, { @@ -105,24 +105,24 @@ "description": "Locational Endpoint" }, { - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "europe-west6" + "location": "europe-west6", + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { - "location": "europe-west8", "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-west8" }, { "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "location": "europe-west9", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-west9" }, { + "location": "me-west1", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "me-west1" + "description": "Locational Endpoint" }, { "location": "northamerica-northeast1", @@ -131,8 +131,8 @@ }, { "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "northamerica-northeast2" }, { "location": "southamerica-east1", @@ -145,49 +145,49 @@ "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", "location": "us-central1", + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", - "location": "us-central2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-central2" }, { "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "location": "us-east1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-east1" }, { "description": "Locational Endpoint", - "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", - "location": "us-east4" + "location": "us-east4", + "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" }, { - "location": "us-south1", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", + "location": "us-south1", "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "location": "us-west1", - "endpointUrl": "https://us-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", + "location": "us-west1" }, { - "location": "us-west2", "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-west2" }, { - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", "location": "us-west3" }, { "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "us-west4" + "location": "us-west4", + "description": "Locational Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -3403,7 +3403,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query", "type": "string" }, @@ -5303,6 +5303,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists FeatureOnlineStores in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", @@ -5382,6 +5413,65 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -5503,6 +5593,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists FeatureViews in a given FeatureOnlineStore.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", @@ -5611,6 +5732,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "sync": { "description": "Triggers on-demand sync for the FeatureView.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", @@ -5638,6 +5787,37 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -11147,7 +11327,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query", "type": "string" }, @@ -13761,6 +13941,316 @@ } } }, + "ragCorpora": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "ragFiles": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "reasoningEngines": { "resources": { "operations": { @@ -17465,7 +17955,7 @@ } } }, - "revision": "20240224", + "revision": "20240312", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -17860,7 +18350,10 @@ "FINISH_REASON_MAX_TOKENS", "FINISH_REASON_SAFETY", "FINISH_REASON_RECITATION", - "FINISH_REASON_OTHER" + "FINISH_REASON_OTHER", + "FINISH_REASON_BLOCKLIST", + "FINISH_REASON_PROHIBITED_CONTENT", + "FINISH_REASON_SPII" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -17868,7 +18361,10 @@ "The maximum number of tokens as specified in the request was reached.", "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", "The token generation was stopped as the response was flagged for unauthorized citations.", - "All other reasons that stopped the token generation." + "All other reasons that stopped the token generation.", + "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", + "The token generation was stopped as the response was flagged for the prohibited contents.", + "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." ], "type": "string" }, @@ -18078,6 +18574,10 @@ "description": "A single part of a message.", "id": "CloudAiNlLlmProtoServicePart", "properties": { + "documentMetadata": { + "$ref": "CloudAiNlLlmProtoServicePartDocumentMetadata", + "description": "Document metadata. The metadata should only be used by the Cloud LLM when supporting document mime types. It will only be populated when this image input part is converted from a document input part." + }, "fileData": { "$ref": "CloudAiNlLlmProtoServicePartFileData", "description": "URI-based data." @@ -18125,6 +18625,22 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServicePartDocumentMetadata": { + "description": "Metadata describes the original input document content.", + "id": "CloudAiNlLlmProtoServicePartDocumentMetadata", + "properties": { + "originalDocumentBlob": { + "$ref": "CloudAiNlLlmProtoServicePartBlob", + "description": "The original document blob." + }, + "pageNumber": { + "description": "The (1-indexed) page number of the image in the original document. The first page carries the original document content and mime type.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServicePartFileData": { "description": "Represents file data.", "id": "CloudAiNlLlmProtoServicePartFileData", @@ -18166,12 +18682,16 @@ "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", - "OTHER" + "OTHER", + "BLOCKLIST", + "PROHIBITED_CONTENT" ], "enumDescriptions": [ "Unspecified blocked reason.", "Candidates blocked due to safety.", - "Candidates blocked due to other reason." + "Candidates blocked due to other reason.", + "Candidates blocked due to the terms which are included from the terminology blocklist.", + "Candidates blocked due to prohibited content." ], "type": "string" }, @@ -18266,6 +18786,13 @@ "description": "Whether the category is flagged as being present. Currently, this is set to true if score >= 0.5.", "type": "boolean" }, + "influentialTerms": { + "description": "The influential terms that could potentially block the response.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm" + }, + "type": "array" + }, "raiCategory": { "description": "The RAI category.", "enum": [ @@ -18354,6 +18881,41 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm": { + "description": "The influential term that could potentially block the response.", + "id": "CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm", + "properties": { + "beginOffset": { + "description": "The beginning offset of the influential term.", + "format": "int32", + "type": "integer" + }, + "confidence": { + "description": "The confidence score of the influential term.", + "format": "float", + "type": "number" + }, + "source": { + "description": "The source of the influential term, prompt or response.", + "enum": [ + "SOURCE_UNSPECIFIED", + "PROMPT", + "RESPONSE" + ], + "enumDescriptions": [ + "Unspecified source.", + "The influential term comes from the prompt.", + "The influential term comes from the response." + ], + "type": "string" + }, + "term": { + "description": "The influential term.", + "type": "string" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServiceSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "CloudAiNlLlmProtoServiceSafetyRating", @@ -19708,7 +20270,10 @@ "MAX_TOKENS", "SAFETY", "RECITATION", - "OTHER" + "OTHER", + "BLOCKLIST", + "PROHIBITED_CONTENT", + "SPII" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -19716,7 +20281,10 @@ "The maximum number of tokens as specified in the request was reached.", "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", "The token generation was stopped as the response was flagged for unauthorized citations.", - "All other reasons that stopped the token generation" + "All other reasons that stopped the token generation", + "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", + "The token generation was stopped as the response was flagged for the prohibited contents.", + "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." ], "readOnly": true, "type": "string" @@ -20932,7 +21500,8 @@ "type": "string" }, "metadata": { - "description": "Required. Additional information about the DatasetVersion.", + "description": "Required. Output only. Additional information about the DatasetVersion.", + "readOnly": true, "type": "any" }, "name": { @@ -23326,7 +23895,7 @@ "type": "string" }, "serviceAgentType": { - "description": "Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project (https://cloud.google.com/vertex-ai/docs/featurestore/latest/resource-policy) a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table.", + "description": "Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table.", "enum": [ "SERVICE_AGENT_TYPE_UNSPECIFIED", "SERVICE_AGENT_TYPE_PROJECT", @@ -23900,7 +24469,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FindNeighborsRequest": { - "description": "The request message for MatchService.FindNeighbors.", + "description": "LINT.IfChange The request message for MatchService.FindNeighbors.", "id": "GoogleCloudAiplatformV1beta1FindNeighborsRequest", "properties": { "deployedIndexId": { @@ -24204,12 +24773,16 @@ "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", - "OTHER" + "OTHER", + "BLOCKLIST", + "PROHIBITED_CONTENT" ], "enumDescriptions": [ "Unspecified blocked reason.", "Candidates blocked due to safety.", - "Candidates blocked due to other reason." + "Candidates blocked due to other reason.", + "Candidates blocked due to the terms which are included from the terminology blocklist.", + "Candidates blocked due to prohibited content." ], "readOnly": true, "type": "string" @@ -28822,14 +29395,16 @@ "PROVISIONING", "RUNNING", "STOPPING", - "ERROR" + "ERROR", + "UPDATING" ], "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the persistent resources is being created.", "The RUNNING state indicates the persistent resource is healthy and fully usable.", "The STOPPING state indicates the persistent resource is being deleted.", - "The ERROR state indicates the persistent resource may be unusable. Details can be found in the `error` field." + "The ERROR state indicates the persistent resource may be unusable. Details can be found in the `error` field.", + "The UPDATING state indicates the persistent resource is being updated." ], "readOnly": true, "type": "string" @@ -29579,7 +30154,6 @@ "description": "Optional. Indicates the launch stage of the model.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", - "DOGFOOD", "EXPERIMENTAL", "PRIVATE_PREVIEW", "PUBLIC_PREVIEW", @@ -29587,7 +30161,6 @@ ], "enumDescriptions": [ "The model launch stage is unspecified.", - "Used to indicate the PublisherModel is at Google internal testing launch stage.", "Used to indicate the PublisherModel is at Experimental launch stage, available to a small set of customers.", "Used to indicate the PublisherModel is at Private Preview launch stage, only available to a small set of customers, although a larger set of customers than an Experimental launch. Previews are the first launch stage used to get feedback from customers.", "Used to indicate the PublisherModel is at Public Preview launch stage, available to all customers, although not supported for production workloads.", @@ -40727,6 +41300,7 @@ "C", "DART", "GRADLE", + "GROOVY", "JAVADOC", "JSON", "MAKEFILE", @@ -40754,6 +41328,7 @@ "C code.", "Dart code.", "Gradle code.", + "Groovy code.", "API documentation.", "JSON code.", "Makefile code.", diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 22bbecb9cd6..03b6527ce7f 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -490,6 +490,10 @@ export namespace aiplatform_v1 { * A single part of a message. */ export interface Schema$CloudAiNlLlmProtoServicePart { + /** + * Document metadata. The metadata should only be used by the Cloud LLM when supporting document mime types. It will only be populated when this image input part is converted from a document input part. + */ + documentMetadata?: Schema$CloudAiNlLlmProtoServicePartDocumentMetadata; /** * URI-based data. */ @@ -532,6 +536,19 @@ export namespace aiplatform_v1 { */ originalFileData?: Schema$CloudAiNlLlmProtoServicePartFileData; } + /** + * Metadata describes the original input document content. + */ + export interface Schema$CloudAiNlLlmProtoServicePartDocumentMetadata { + /** + * The original document blob. + */ + originalDocumentBlob?: Schema$CloudAiNlLlmProtoServicePartBlob; + /** + * The (1-indexed) page number of the image in the original document. The first page carries the original document content and mime type. + */ + pageNumber?: number | null; + } /** * Represents file data. */ @@ -628,6 +645,10 @@ export namespace aiplatform_v1 { * Whether the category is flagged as being present. Currently, this is set to true if score \>= 0.5. */ flagged?: boolean | null; + /** + * The influential terms that could potentially block the response. + */ + influentialTerms?: Schema$CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm[]; /** * The RAI category. */ @@ -637,6 +658,27 @@ export namespace aiplatform_v1 { */ score?: number | null; } + /** + * The influential term that could potentially block the response. + */ + export interface Schema$CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm { + /** + * The beginning offset of the influential term. + */ + beginOffset?: number | null; + /** + * The confidence score of the influential term. + */ + confidence?: number | null; + /** + * The source of the influential term, prompt or response. + */ + source?: string | null; + /** + * The influential term. + */ + term?: string | null; + } /** * Safety rating corresponding to the generated content. */ @@ -1008,6 +1050,15 @@ export namespace aiplatform_v1 { */ gcsSource?: Schema$GoogleCloudAiplatformV1GcsSource; } + /** + * Request message for PipelineService.BatchCancelPipelineJobs. + */ + export interface Schema$GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest { + /** + * Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipelineJob\}` + */ + names?: string[] | null; + } /** * Details of operations that perform batch create Features. */ @@ -1088,6 +1139,15 @@ export namespace aiplatform_v1 { */ startingReplicaCount?: number | null; } + /** + * Request message for PipelineService.BatchDeletePipelineJobs. + */ + export interface Schema$GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest { + /** + * Required. The names of the PipelineJobs to delete. A maximum of 32 PipelineJobs can be deleted in a batch. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipelineJob\}` + */ + names?: string[] | null; + } /** * Request message for ModelService.BatchImportEvaluatedAnnotations */ @@ -2404,7 +2464,7 @@ export namespace aiplatform_v1 { */ etag?: string | null; /** - * Required. Additional information about the DatasetVersion. + * Required. Output only. Additional information about the DatasetVersion. */ metadata?: any | null; /** @@ -4428,7 +4488,7 @@ export namespace aiplatform_v1 { validationFilter?: string | null; } /** - * The request message for MatchService.FindNeighbors. + * LINT.IfChange The request message for MatchService.FindNeighbors. */ export interface Schema$GoogleCloudAiplatformV1FindNeighborsRequest { /** @@ -4697,6 +4757,15 @@ export namespace aiplatform_v1 { */ updateTime?: string | null; } + /** + * Contains information about the source of the models generated from Generative AI Studio. + */ + export interface Schema$GoogleCloudAiplatformV1GenieSource { + /** + * Required. The public base model URI. + */ + baseModelUri?: string | null; + } /** * Grounding attribution. */ @@ -6245,6 +6314,10 @@ export namespace aiplatform_v1 { * Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models. */ artifactUri?: string | null; + /** + * Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. + */ + baseModelSource?: Schema$GoogleCloudAiplatformV1ModelBaseModelSource; /** * Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. */ @@ -6362,6 +6435,19 @@ export namespace aiplatform_v1 { */ versionUpdateTime?: string | null; } + /** + * User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. + */ + export interface Schema$GoogleCloudAiplatformV1ModelBaseModelSource { + /** + * Information about the base model of Genie models. + */ + genieSource?: Schema$GoogleCloudAiplatformV1GenieSource; + /** + * Source information of Model Garden models. + */ + modelGardenSource?: Schema$GoogleCloudAiplatformV1ModelGardenSource; + } /** * Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). */ @@ -6784,6 +6870,15 @@ export namespace aiplatform_v1 { */ id?: string | null; } + /** + * Contains information about the source of the models generated from Model Garden. + */ + export interface Schema$GoogleCloudAiplatformV1ModelGardenSource { + /** + * Required. The model garden source model resource name. + */ + publicModelName?: string | null; + } /** * The alert config for model monitoring. */ @@ -14473,6 +14568,7 @@ export namespace aiplatform_v1 { studies: Resource$Projects$Locations$Studies; tensorboards: Resource$Projects$Locations$Tensorboards; trainingPipelines: Resource$Projects$Locations$Trainingpipelines; + tuningJobs: Resource$Projects$Locations$Tuningjobs; constructor(context: APIRequestContext) { this.context = context; this.batchPredictionJobs = @@ -14536,6 +14632,9 @@ export namespace aiplatform_v1 { ); this.trainingPipelines = new Resource$Projects$Locations$Trainingpipelines(this.context); + this.tuningJobs = new Resource$Projects$Locations$Tuningjobs( + this.context + ); } /** @@ -25079,7 +25178,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */ filter?: string; /** @@ -48084,7 +48183,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Models$List extends StandardParameters { /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */ filter?: string; /** @@ -52612,6 +52711,196 @@ export namespace aiplatform_v1 { ); } + /** + * Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + options: StreamMethodOptions + ): GaxiosPromise; + batchCancel( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + options?: MethodOptions + ): GaxiosPromise; + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + callback: BodyResponseCallback + ): void; + batchCancel( + callback: BodyResponseCallback + ): void; + batchCancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchCancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + options: StreamMethodOptions + ): GaxiosPromise; + batchDelete( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + options?: MethodOptions + ): GaxiosPromise; + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + callback: BodyResponseCallback + ): void; + batchDelete( + callback: BodyResponseCallback + ): void; + batchDelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchDelete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. * @@ -53076,6 +53365,30 @@ export namespace aiplatform_v1 { } } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel + extends StandardParameters { + /** + * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete + extends StandardParameters { + /** + * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest; + } export interface Params$Resource$Projects$Locations$Pipelinejobs$Cancel extends StandardParameters { /** @@ -65935,6 +66248,219 @@ export namespace aiplatform_v1 { timeout?: string; } + export class Resource$Projects$Locations$Tuningjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Tuningjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Tuningjobs$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Tuningjobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export class Resource$Publishers { context: APIRequestContext; models: Resource$Publishers$Models; diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index d69f0e00378..f153022dd8e 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -490,6 +490,10 @@ export namespace aiplatform_v1beta1 { * A single part of a message. */ export interface Schema$CloudAiNlLlmProtoServicePart { + /** + * Document metadata. The metadata should only be used by the Cloud LLM when supporting document mime types. It will only be populated when this image input part is converted from a document input part. + */ + documentMetadata?: Schema$CloudAiNlLlmProtoServicePartDocumentMetadata; /** * URI-based data. */ @@ -532,6 +536,19 @@ export namespace aiplatform_v1beta1 { */ originalFileData?: Schema$CloudAiNlLlmProtoServicePartFileData; } + /** + * Metadata describes the original input document content. + */ + export interface Schema$CloudAiNlLlmProtoServicePartDocumentMetadata { + /** + * The original document blob. + */ + originalDocumentBlob?: Schema$CloudAiNlLlmProtoServicePartBlob; + /** + * The (1-indexed) page number of the image in the original document. The first page carries the original document content and mime type. + */ + pageNumber?: number | null; + } /** * Represents file data. */ @@ -628,6 +645,10 @@ export namespace aiplatform_v1beta1 { * Whether the category is flagged as being present. Currently, this is set to true if score \>= 0.5. */ flagged?: boolean | null; + /** + * The influential terms that could potentially block the response. + */ + influentialTerms?: Schema$CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm[]; /** * The RAI category. */ @@ -637,6 +658,27 @@ export namespace aiplatform_v1beta1 { */ score?: number | null; } + /** + * The influential term that could potentially block the response. + */ + export interface Schema$CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm { + /** + * The beginning offset of the influential term. + */ + beginOffset?: number | null; + /** + * The confidence score of the influential term. + */ + confidence?: number | null; + /** + * The source of the influential term, prompt or response. + */ + source?: string | null; + /** + * The influential term. + */ + term?: string | null; + } /** * Safety rating corresponding to the generated content. */ @@ -2487,7 +2529,7 @@ export namespace aiplatform_v1beta1 { */ etag?: string | null; /** - * Required. Additional information about the DatasetVersion. + * Required. Output only. Additional information about the DatasetVersion. */ metadata?: any | null; /** @@ -4380,7 +4422,7 @@ export namespace aiplatform_v1beta1 { */ serviceAccountEmail?: string | null; /** - * Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project (https://cloud.google.com/vertex-ai/docs/featurestore/latest/resource-policy) a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. + * Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. */ serviceAgentType?: string | null; /** @@ -4628,7 +4670,7 @@ export namespace aiplatform_v1beta1 { validationFilter?: string | null; } /** - * The request message for MatchService.FindNeighbors. + * LINT.IfChange The request message for MatchService.FindNeighbors. */ export interface Schema$GoogleCloudAiplatformV1beta1FindNeighborsRequest { /** @@ -15075,6 +15117,7 @@ export namespace aiplatform_v1beta1 { persistentResources: Resource$Projects$Locations$Persistentresources; pipelineJobs: Resource$Projects$Locations$Pipelinejobs; publishers: Resource$Projects$Locations$Publishers; + ragCorpora: Resource$Projects$Locations$Ragcorpora; reasoningEngines: Resource$Projects$Locations$Reasoningengines; schedules: Resource$Projects$Locations$Schedules; solvers: Resource$Projects$Locations$Solvers; @@ -15156,6 +15199,9 @@ export namespace aiplatform_v1beta1 { this.publishers = new Resource$Projects$Locations$Publishers( this.context ); + this.ragCorpora = new Resource$Projects$Locations$Ragcorpora( + this.context + ); this.reasoningEngines = new Resource$Projects$Locations$Reasoningengines( this.context ); @@ -26507,7 +26553,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */ filter?: string; /** @@ -31992,6 +32038,99 @@ export namespace aiplatform_v1beta1 { } } + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists FeatureOnlineStores in a given project and location. * @@ -32180,6 +32319,196 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Featureonlinestores$Create @@ -32216,6 +32545,17 @@ export namespace aiplatform_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } export interface Params$Resource$Projects$Locations$Featureonlinestores$List extends StandardParameters { /** @@ -32255,6 +32595,29 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore; } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions + extends StandardParameters { + /** + * 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[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } export class Resource$Projects$Locations$Featureonlinestores$Featureviews { context: APIRequestContext; @@ -32649,6 +33012,99 @@ export namespace aiplatform_v1beta1 { } } + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists FeatureViews in a given FeatureOnlineStore. * @@ -32934,6 +33390,99 @@ export namespace aiplatform_v1beta1 { } } + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Triggers on-demand sync for the FeatureView. * @@ -33030,6 +33579,103 @@ export namespace aiplatform_v1beta1 { ); } } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create @@ -33078,6 +33724,17 @@ export namespace aiplatform_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List extends StandardParameters { /** @@ -33129,6 +33786,18 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest; } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync extends StandardParameters { /** @@ -33141,6 +33810,17 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleCloudAiplatformV1beta1SyncFeatureViewRequest; } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + extends StandardParameters { + /** + * 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[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { context: APIRequestContext; @@ -52727,7 +53407,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Models$List extends StandardParameters { /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */ filter?: string; /** @@ -60930,6 +61610,1077 @@ export namespace aiplatform_v1beta1 { requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateContentRequest; } + export class Resource$Projects$Locations$Ragcorpora { + context: APIRequestContext; + operations: Resource$Projects$Locations$Ragcorpora$Operations; + ragFiles: Resource$Projects$Locations$Ragcorpora$Ragfiles; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Ragcorpora$Operations( + this.context + ); + this.ragFiles = new Resource$Projects$Locations$Ragcorpora$Ragfiles( + this.context + ); + } + } + + export class Resource$Projects$Locations$Ragcorpora$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Ragcorpora$Ragfiles { + context: APIRequestContext; + operations: Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + export class Resource$Projects$Locations$Reasoningengines { context: APIRequestContext; operations: Resource$Projects$Locations$Reasoningengines$Operations; From 811596da7a26579904df0d865d0c79e8bf789fdb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:46 +0000 Subject: [PATCH 03/78] feat(alloydb): update the API #### alloydb:v1alpha The following keys were added: - schemas.PscInstanceConfig.properties.pscDnsName.description - schemas.PscInstanceConfig.properties.pscDnsName.readOnly - schemas.PscInstanceConfig.properties.pscDnsName.type - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.enum - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.type The following keys were changed: - schemas.Cluster.properties.network.description - schemas.NetworkConfig.properties.network.description - schemas.PscInstanceConfig.properties.serviceAttachmentLink.description - schemas.PscInterfaceConfig.properties.networkAttachment.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.primaryResourceId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.additionalMetadata.description #### alloydb:v1beta The following keys were added: - schemas.Cluster.properties.pscConfig.$ref - schemas.Cluster.properties.pscConfig.description - schemas.PscConfig.description - schemas.PscConfig.id - schemas.PscConfig.properties.pscEnabled.description - schemas.PscConfig.properties.pscEnabled.type - schemas.PscConfig.type - schemas.PscInstanceConfig.properties.pscDnsName.description - schemas.PscInstanceConfig.properties.pscDnsName.readOnly - schemas.PscInstanceConfig.properties.pscDnsName.type - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.enum - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.type The following keys were changed: - schemas.Cluster.properties.network.description - schemas.NetworkConfig.properties.network.description - schemas.PscInstanceConfig.properties.serviceAttachmentLink.description - schemas.PscInterfaceConfig.properties.networkAttachment.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.primaryResourceId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.additionalMetadata.description #### alloydb:v1 The following keys were added: - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.enum - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainOperationError.properties.errorType.type The following keys were changed: - schemas.Cluster.properties.network.description - schemas.NetworkConfig.properties.network.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.primaryResourceId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.additionalMetadata.description --- discovery/alloydb-v1.json | 31 +++++++++++++++---- discovery/alloydb-v1alpha.json | 40 ++++++++++++++++++++----- discovery/alloydb-v1beta.json | 55 +++++++++++++++++++++++++++++----- src/apis/alloydb/v1.ts | 9 +++--- src/apis/alloydb/v1alpha.ts | 17 +++++++---- src/apis/alloydb/v1beta.ts | 30 +++++++++++++++---- 6 files changed, 147 insertions(+), 35 deletions(-) diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index cbbb337dc1c..71810aa41a6 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -1489,7 +1489,7 @@ } } }, - "revision": "20240216", + "revision": "20240228", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AutomatedBackupPolicy": { @@ -1885,7 +1885,7 @@ }, "network": { "deprecated": true, - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. Deprecated, use network_config.network instead.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.", "type": "string" }, "networkConfig": { @@ -2651,7 +2651,7 @@ "type": "string" }, "network": { - "description": "Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster.", + "description": "Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.", "type": "string" } }, @@ -3638,7 +3638,7 @@ }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", - "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested" + "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", @@ -3676,7 +3676,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Any other additional metadata specific to recommendation", + "description": "Optional. Any other additional metadata specific to recommendation", "type": "object" }, "lastRefreshTime": { @@ -3957,6 +3957,27 @@ "description": "Identifies the specific error that occurred. REQUIRED", "type": "string" }, + "errorType": { + "enum": [ + "OPERATION_ERROR_TYPE_UNSPECIFIED", + "KMS_KEY_ERROR", + "DATABASE_ERROR", + "STOCKOUT_ERROR", + "CANCELLATION_ERROR", + "SQLSERVER_ERROR", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "UNSPECIFIED means product type is not known or available.", + "key destroyed, expired, not found, unreachable or permission denied.", + "Database is not accessible", + "The zone or region does not have sufficient resources to handle the request at the moment", + "User initiated cancellation", + "SQL server specific error", + "Any other internal error." + ], + "type": "string" + }, "message": { "description": "Additional information about the error encountered. REQUIRED", "type": "string" diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index a933609ec29..4924b92aa2b 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -1489,7 +1489,7 @@ } } }, - "revision": "20240216", + "revision": "20240228", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1901,7 +1901,7 @@ }, "network": { "deprecated": true, - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. Deprecated, use network_config.network instead.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.", "type": "string" }, "networkConfig": { @@ -2746,7 +2746,7 @@ "type": "string" }, "network": { - "description": "Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster.", + "description": "Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.", "type": "string" } }, @@ -2924,6 +2924,11 @@ }, "type": "array" }, + "pscDnsName": { + "description": "Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog", + "readOnly": true, + "type": "string" + }, "pscEnabled": { "description": "Optional. Whether PSC connectivity is enabled for this instance. This is populated by referencing the value from the parent cluster.", "type": "boolean" @@ -2936,7 +2941,7 @@ "type": "array" }, "serviceAttachmentLink": { - "description": "Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of projects//regions//serviceAttachments/", + "description": "Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`", "readOnly": true, "type": "string" } @@ -2955,7 +2960,7 @@ "type": "array" }, "networkAttachment": { - "description": "The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: \"projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}\". NetworkAttachment has to be provided when the PSC interface is created.", + "description": "The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: `projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}`. NetworkAttachment has to be provided when the PSC interface is created.", "type": "string" } }, @@ -3806,7 +3811,7 @@ }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", - "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested" + "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", @@ -3844,7 +3849,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Any other additional metadata specific to recommendation", + "description": "Optional. Any other additional metadata specific to recommendation", "type": "object" }, "lastRefreshTime": { @@ -4125,6 +4130,27 @@ "description": "Identifies the specific error that occurred. REQUIRED", "type": "string" }, + "errorType": { + "enum": [ + "OPERATION_ERROR_TYPE_UNSPECIFIED", + "KMS_KEY_ERROR", + "DATABASE_ERROR", + "STOCKOUT_ERROR", + "CANCELLATION_ERROR", + "SQLSERVER_ERROR", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "UNSPECIFIED means product type is not known or available.", + "key destroyed, expired, not found, unreachable or permission denied.", + "Database is not accessible", + "The zone or region does not have sufficient resources to handle the request at the moment", + "User initiated cancellation", + "SQL server specific error", + "Any other internal error." + ], + "type": "string" + }, "message": { "description": "Additional information about the error encountered. REQUIRED", "type": "string" diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 747928f97ab..898c66a60bf 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20240216", + "revision": "20240228", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1887,7 +1887,7 @@ }, "network": { "deprecated": true, - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. Deprecated, use network_config.network instead.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.", "type": "string" }, "networkConfig": { @@ -1898,6 +1898,10 @@ "description": "Output only. Cross Region replication config specific to PRIMARY cluster.", "readOnly": true }, + "pscConfig": { + "$ref": "PscConfig", + "description": "Optional. The configuration for Private Service Connect (PSC) for the cluster." + }, "reconciling": { "description": "Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.", "readOnly": true, @@ -2718,7 +2722,7 @@ "type": "string" }, "network": { - "description": "Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster.", + "description": "Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.", "type": "string" } }, @@ -2860,6 +2864,17 @@ }, "type": "object" }, + "PscConfig": { + "description": "PscConfig contains PSC related configuration at a cluster level.", + "id": "PscConfig", + "properties": { + "pscEnabled": { + "description": "Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.", + "type": "boolean" + } + }, + "type": "object" + }, "PscInstanceConfig": { "description": "PscInstanceConfig contains PSC related configuration at an instance level.", "id": "PscInstanceConfig", @@ -2885,6 +2900,11 @@ }, "type": "array" }, + "pscDnsName": { + "description": "Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog", + "readOnly": true, + "type": "string" + }, "pscEnabled": { "description": "Optional. Whether PSC connectivity is enabled for this instance. This is populated by referencing the value from the parent cluster.", "type": "boolean" @@ -2897,7 +2917,7 @@ "type": "array" }, "serviceAttachmentLink": { - "description": "Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of projects//regions//serviceAttachments/", + "description": "Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`", "readOnly": true, "type": "string" } @@ -2916,7 +2936,7 @@ "type": "array" }, "networkAttachment": { - "description": "The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: \"projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}\". NetworkAttachment has to be provided when the PSC interface is created.", + "description": "The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: `projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}`. NetworkAttachment has to be provided when the PSC interface is created.", "type": "string" } }, @@ -3767,7 +3787,7 @@ }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", - "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested" + "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", @@ -3805,7 +3825,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. Any other additional metadata specific to recommendation", + "description": "Optional. Any other additional metadata specific to recommendation", "type": "object" }, "lastRefreshTime": { @@ -4086,6 +4106,27 @@ "description": "Identifies the specific error that occurred. REQUIRED", "type": "string" }, + "errorType": { + "enum": [ + "OPERATION_ERROR_TYPE_UNSPECIFIED", + "KMS_KEY_ERROR", + "DATABASE_ERROR", + "STOCKOUT_ERROR", + "CANCELLATION_ERROR", + "SQLSERVER_ERROR", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "UNSPECIFIED means product type is not known or available.", + "key destroyed, expired, not found, unreachable or permission denied.", + "Database is not accessible", + "The zone or region does not have sufficient resources to handle the request at the moment", + "User initiated cancellation", + "SQL server specific error", + "Any other internal error." + ], + "type": "string" + }, "message": { "description": "Additional information about the error encountered. REQUIRED", "type": "string" diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index c7825d6979e..01d9523bb93 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -370,7 +370,7 @@ export namespace alloydb_v1 { */ name?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. Deprecated, use network_config.network instead. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project\}/global/networks/{network_id\}`. This is required to create a cluster. Deprecated, use network_config.network instead. */ network?: string | null; networkConfig?: Schema$NetworkConfig; @@ -863,7 +863,7 @@ export namespace alloydb_v1 { */ allocatedIpRange?: string | null; /** - * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. + * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number\}/global/networks/{network_id\}`. This is required to create a cluster. */ network?: string | null; } @@ -1336,7 +1336,7 @@ export namespace alloydb_v1 { */ location?: string | null; /** - * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested + * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1365,7 +1365,7 @@ export namespace alloydb_v1 { */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData { /** - * Required. Any other additional metadata specific to recommendation + * Optional. Any other additional metadata specific to recommendation */ additionalMetadata?: {[key: string]: any} | null; /** @@ -1418,6 +1418,7 @@ export namespace alloydb_v1 { * Identifies the specific error that occurred. REQUIRED */ code?: string | null; + errorType?: string | null; /** * Additional information about the error encountered. REQUIRED */ diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 277222ab761..fe4773bba45 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -383,7 +383,7 @@ export namespace alloydb_v1alpha { */ name?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. Deprecated, use network_config.network instead. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project\}/global/networks/{network_id\}`. This is required to create a cluster. Deprecated, use network_config.network instead. */ network?: string | null; networkConfig?: Schema$NetworkConfig; @@ -937,7 +937,7 @@ export namespace alloydb_v1alpha { */ allocatedIpRange?: string | null; /** - * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. + * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number\}/global/networks/{network_id\}`. This is required to create a cluster. */ network?: string | null; } @@ -1071,6 +1071,10 @@ export namespace alloydb_v1alpha { * Optional. List of service attachments that this instance has created endpoints to connect with. Currently, only a single outgoing service attachment is supported per instance. */ outgoingServiceAttachmentLinks?: string[] | null; + /** + * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog + */ + pscDnsName?: string | null; /** * Optional. Whether PSC connectivity is enabled for this instance. This is populated by referencing the value from the parent cluster. */ @@ -1080,7 +1084,7 @@ export namespace alloydb_v1alpha { */ pscInterfaceConfigs?: Schema$PscInterfaceConfig[]; /** - * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of projects//regions//serviceAttachments/ + * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` */ serviceAttachmentLink?: string | null; } @@ -1093,7 +1097,7 @@ export namespace alloydb_v1alpha { */ consumerEndpointIps?: string[] | null; /** - * The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: "projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}". NetworkAttachment has to be provided when the PSC interface is created. + * The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: `projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}`. NetworkAttachment has to be provided when the PSC interface is created. */ networkAttachment?: string | null; } @@ -1461,7 +1465,7 @@ export namespace alloydb_v1alpha { */ location?: string | null; /** - * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested + * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1490,7 +1494,7 @@ export namespace alloydb_v1alpha { */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData { /** - * Required. Any other additional metadata specific to recommendation + * Optional. Any other additional metadata specific to recommendation */ additionalMetadata?: {[key: string]: any} | null; /** @@ -1543,6 +1547,7 @@ export namespace alloydb_v1alpha { * Identifies the specific error that occurred. REQUIRED */ code?: string | null; + errorType?: string | null; /** * Additional information about the error encountered. REQUIRED */ diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 63c8eaf4acc..349b5e5defa 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -375,7 +375,7 @@ export namespace alloydb_v1beta { */ name?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. Deprecated, use network_config.network instead. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project\}/global/networks/{network_id\}`. This is required to create a cluster. Deprecated, use network_config.network instead. */ network?: string | null; networkConfig?: Schema$NetworkConfig; @@ -383,6 +383,10 @@ export namespace alloydb_v1beta { * Output only. Cross Region replication config specific to PRIMARY cluster. */ primaryConfig?: Schema$PrimaryConfig; + /** + * Optional. The configuration for Private Service Connect (PSC) for the cluster. + */ + pscConfig?: Schema$PscConfig; /** * Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. */ @@ -917,7 +921,7 @@ export namespace alloydb_v1beta { */ allocatedIpRange?: string | null; /** - * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. + * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number\}/global/networks/{network_id\}`. This is required to create a cluster. */ network?: string | null; } @@ -1026,6 +1030,15 @@ export namespace alloydb_v1beta { */ validateOnly?: boolean | null; } + /** + * PscConfig contains PSC related configuration at a cluster level. + */ + export interface Schema$PscConfig { + /** + * Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance. + */ + pscEnabled?: boolean | null; + } /** * PscInstanceConfig contains PSC related configuration at an instance level. */ @@ -1042,6 +1055,10 @@ export namespace alloydb_v1beta { * Optional. List of service attachments that this instance has created endpoints to connect with. Currently, only a single outgoing service attachment is supported per instance. */ outgoingServiceAttachmentLinks?: string[] | null; + /** + * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog + */ + pscDnsName?: string | null; /** * Optional. Whether PSC connectivity is enabled for this instance. This is populated by referencing the value from the parent cluster. */ @@ -1051,7 +1068,7 @@ export namespace alloydb_v1beta { */ pscInterfaceConfigs?: Schema$PscInterfaceConfig[]; /** - * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of projects//regions//serviceAttachments/ + * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` */ serviceAttachmentLink?: string | null; } @@ -1064,7 +1081,7 @@ export namespace alloydb_v1beta { */ consumerEndpointIps?: string[] | null; /** - * The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: "projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}". NetworkAttachment has to be provided when the PSC interface is created. + * The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: `projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}`. NetworkAttachment has to be provided when the PSC interface is created. */ networkAttachment?: string | null; } @@ -1432,7 +1449,7 @@ export namespace alloydb_v1beta { */ location?: string | null; /** - * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested + * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1461,7 +1478,7 @@ export namespace alloydb_v1beta { */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData { /** - * Required. Any other additional metadata specific to recommendation + * Optional. Any other additional metadata specific to recommendation */ additionalMetadata?: {[key: string]: any} | null; /** @@ -1514,6 +1531,7 @@ export namespace alloydb_v1beta { * Identifies the specific error that occurred. REQUIRED */ code?: string | null; + errorType?: string | null; /** * Additional information about the error encountered. REQUIRED */ From 6a129176d37b5c5089e367099482041b9b138852 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:46 +0000 Subject: [PATCH 04/78] feat(analyticsadmin): update the API #### analyticsadmin:v1alpha The following keys were added: - schemas.GoogleAnalyticsAdminV1alphaChannelGroup.properties.primary.description - schemas.GoogleAnalyticsAdminV1alphaChannelGroup.properties.primary.type --- discovery/analyticsadmin-v1alpha.json | 6 +++++- src/apis/analyticsadmin/v1alpha.ts | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/discovery/analyticsadmin-v1alpha.json b/discovery/analyticsadmin-v1alpha.json index 8450320c3e2..52e4477ef15 100644 --- a/discovery/analyticsadmin-v1alpha.json +++ b/discovery/analyticsadmin-v1alpha.json @@ -4457,7 +4457,7 @@ } } }, - "revision": "20240131", + "revision": "20240312", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -5904,6 +5904,10 @@ "readOnly": true, "type": "string" }, + "primary": { + "description": "Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default.", + "type": "boolean" + }, "systemDefined": { "description": "Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.", "readOnly": true, diff --git a/src/apis/analyticsadmin/v1alpha.ts b/src/apis/analyticsadmin/v1alpha.ts index 188385cc34c..14f113d0dc5 100644 --- a/src/apis/analyticsadmin/v1alpha.ts +++ b/src/apis/analyticsadmin/v1alpha.ts @@ -1117,6 +1117,10 @@ export namespace analyticsadmin_v1alpha { * Output only. The resource name for this Channel Group resource. Format: properties/{property\}/channelGroups/{channel_group\} */ name?: string | null; + /** + * Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default. + */ + primary?: boolean | null; /** * Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group. */ From 620e88110ecfcb9a0fce0f3304e9367939db80c4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:46 +0000 Subject: [PATCH 05/78] feat(analyticshub): update the API #### analyticshub:v1 The following keys were added: - schemas.BigQueryDatasetSource.properties.selectedResources.description - schemas.BigQueryDatasetSource.properties.selectedResources.items.$ref - schemas.BigQueryDatasetSource.properties.selectedResources.type - schemas.SelectedResource.description - schemas.SelectedResource.id - schemas.SelectedResource.properties.table.description - schemas.SelectedResource.properties.table.type - schemas.SelectedResource.type --- discovery/analyticshub-v1.json | 20 +++++++++++++++++++- src/apis/analyticshub/v1.ts | 13 +++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 8b5bd94c753..3fa39004eeb 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -1022,7 +1022,7 @@ } } }, - "revision": "20240219", + "revision": "20240307", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1080,6 +1080,13 @@ "dataset": { "description": "Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", "type": "string" + }, + "selectedResources": { + "description": "Optional. Resources in this dataset that are selectively shared. If this field is empty, then the entire dataset (all resources) are shared. This field is only valid for data clean room exchanges.", + "items": { + "$ref": "SelectedResource" + }, + "type": "array" } }, "type": "object" @@ -1677,6 +1684,17 @@ "properties": {}, "type": "object" }, + "SelectedResource": { + "description": "Resource in this dataset that are selectively shared.", + "id": "SelectedResource", + "properties": { + "table": { + "description": "Optional. Format: For table: `projects/{projectId}/datasets/{datasetId}/tables/{tableId}` Example:\"projects/test_project/datasets/test_dataset/tables/test_table\"", + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index 3d229759177..70642d87107 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -160,6 +160,10 @@ export namespace analyticshub_v1 { * Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` */ dataset?: string | null; + /** + * Optional. Resources in this dataset that are selectively shared. If this field is empty, then the entire dataset (all resources) are shared. This field is only valid for data clean room exchanges. + */ + selectedResources?: Schema$SelectedResource[]; } /** * Associates `members`, or principals, with a `role`. @@ -587,6 +591,15 @@ export namespace analyticshub_v1 { * Message for response when you revoke a subscription. */ export interface Schema$RevokeSubscriptionResponse {} + /** + * Resource in this dataset that are selectively shared. + */ + export interface Schema$SelectedResource { + /** + * Optional. Format: For table: `projects/{projectId\}/datasets/{datasetId\}/tables/{tableId\}` Example:"projects/test_project/datasets/test_dataset/tables/test_table" + */ + table?: string | null; + } /** * Request message for `SetIamPolicy` method. */ From 363be514b969f2a7854d7c439a6c53ab86fa8f08 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:46 +0000 Subject: [PATCH 06/78] feat(appengine): update the API #### appengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.flatPath - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.httpMethod - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.id - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameterOrder - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.path - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.response.$ref - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.scopes - schemas.Reasons.properties.serviceActivation.description - schemas.Reasons.properties.serviceActivation.enum - schemas.Reasons.properties.serviceActivation.enumDescriptions - schemas.Reasons.properties.serviceActivation.type The following keys were changed: - schemas.Reasons.description #### appengine:v1beta The following keys were added: - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.flatPath - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.httpMethod - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.id - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameterOrder - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.path - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.response.$ref - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.scopes - schemas.Reasons.properties.serviceActivation.description - schemas.Reasons.properties.serviceActivation.enum - schemas.Reasons.properties.serviceActivation.enumDescriptions - schemas.Reasons.properties.serviceActivation.type The following keys were changed: - schemas.Reasons.description #### appengine:v1 The following keys were added: - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.flatPath - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.httpMethod - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.id - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameterOrder - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.applicationsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.locationsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.description - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.location - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.required - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.parameters.projectsId.type - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.path - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.response.$ref - resources.projects.resources.locations.resources.applications.resources.authorizedDomains.methods.list.scopes - schemas.Reasons.properties.serviceActivation.description - schemas.Reasons.properties.serviceActivation.enum - schemas.Reasons.properties.serviceActivation.enumDescriptions - schemas.Reasons.properties.serviceActivation.type The following keys were changed: - schemas.Reasons.description --- discovery/appengine-v1.json | 89 +++++++++++++++- discovery/appengine-v1alpha.json | 81 ++++++++++++++- discovery/appengine-v1beta.json | 81 ++++++++++++++- src/apis/appengine/v1.ts | 168 ++++++++++++++++++++++++++++++- src/apis/appengine/v1alpha.ts | 150 ++++++++++++++++++++++++++- src/apis/appengine/v1beta.ts | 150 ++++++++++++++++++++++++++- 6 files changed, 710 insertions(+), 9 deletions(-) diff --git a/discovery/appengine-v1.json b/discovery/appengine-v1.json index a9ca5310c99..56a0f186b8a 100644 --- a/discovery/appengine-v1.json +++ b/discovery/appengine-v1.json @@ -1649,9 +1649,76 @@ } } } + }, + "projects": { + "resources": { + "locations": { + "resources": { + "applications": { + "resources": { + "authorizedDomains": { + "methods": { + "list": { + "description": "Lists all domains the user is authorized to administer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains", + "httpMethod": "GET", + "id": "appengine.projects.locations.applications.authorizedDomains.list", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `parent`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `parent`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "location": "query", + "type": "string" + }, + "projectsId": { + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains", + "response": { + "$ref": "ListAuthorizedDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + } + } + } + } } }, - "revision": "20240218", + "revision": "20240226", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3341,7 +3408,7 @@ "type": "object" }, "Reasons": { - "description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)", + "description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller)", "id": "Reasons", "properties": { "abuse": { @@ -3393,6 +3460,24 @@ ], "type": "string" }, + "serviceActivation": { + "description": "Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive > 30 days.", + "enum": [ + "SERVICE_ACTIVATION_STATUS_UNSPECIFIED", + "SERVICE_ACTIVATION_ENABLED", + "SERVICE_ACTIVATION_DISABLED", + "SERVICE_ACTIVATION_DISABLED_FULL", + "SERVICE_ACTIVATION_UNKNOWN_REASON" + ], + "enumDescriptions": [ + "Default Unspecified status", + "Service is active in the project.", + "Service is disabled in the project recently i.e., within last 24 hours.", + "Service has been disabled for configured grace_period (default 30 days).", + "Happens when PSM cannot determine the status of service in a project Could happen due to variety of reasons like PERMISSION_DENIED or Project got deleted etc." + ], + "type": "string" + }, "serviceManagement": { "enum": [ "SERVICE_MANAGEMENT_UNKNOWN_REASON", diff --git a/discovery/appengine-v1alpha.json b/discovery/appengine-v1alpha.json index b83f6254d29..60f490252e7 100644 --- a/discovery/appengine-v1alpha.json +++ b/discovery/appengine-v1alpha.json @@ -789,6 +789,65 @@ } }, "resources": { + "applications": { + "resources": { + "authorizedDomains": { + "methods": { + "list": { + "description": "Lists all domains the user is authorized to administer.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains", + "httpMethod": "GET", + "id": "appengine.projects.locations.applications.authorizedDomains.list", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `parent`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `parent`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "location": "query", + "type": "string" + }, + "projectsId": { + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains", + "response": { + "$ref": "ListAuthorizedDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -887,7 +946,7 @@ } } }, - "revision": "20240218", + "revision": "20240226", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { @@ -1517,7 +1576,7 @@ "type": "object" }, "Reasons": { - "description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)", + "description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller)", "id": "Reasons", "properties": { "abuse": { @@ -1569,6 +1628,24 @@ ], "type": "string" }, + "serviceActivation": { + "description": "Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive > 30 days.", + "enum": [ + "SERVICE_ACTIVATION_STATUS_UNSPECIFIED", + "SERVICE_ACTIVATION_ENABLED", + "SERVICE_ACTIVATION_DISABLED", + "SERVICE_ACTIVATION_DISABLED_FULL", + "SERVICE_ACTIVATION_UNKNOWN_REASON" + ], + "enumDescriptions": [ + "Default Unspecified status", + "Service is active in the project.", + "Service is disabled in the project recently i.e., within last 24 hours.", + "Service has been disabled for configured grace_period (default 30 days).", + "Happens when PSM cannot determine the status of service in a project Could happen due to variety of reasons like PERMISSION_DENIED or Project got deleted etc." + ], + "type": "string" + }, "serviceManagement": { "enum": [ "SERVICE_MANAGEMENT_UNKNOWN_REASON", diff --git a/discovery/appengine-v1beta.json b/discovery/appengine-v1beta.json index 9dcffe253a1..9c1e1f69240 100644 --- a/discovery/appengine-v1beta.json +++ b/discovery/appengine-v1beta.json @@ -1761,6 +1761,65 @@ } }, "resources": { + "applications": { + "resources": { + "authorizedDomains": { + "methods": { + "list": { + "description": "Lists all domains the user is authorized to administer.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains", + "httpMethod": "GET", + "id": "appengine.projects.locations.applications.authorizedDomains.list", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `parent`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `parent`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "location": "query", + "type": "string" + }, + "projectsId": { + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains", + "response": { + "$ref": "ListAuthorizedDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -1859,7 +1918,7 @@ } } }, - "revision": "20240218", + "revision": "20240226", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3600,7 +3659,7 @@ "type": "object" }, "Reasons": { - "description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)", + "description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller)", "id": "Reasons", "properties": { "abuse": { @@ -3652,6 +3711,24 @@ ], "type": "string" }, + "serviceActivation": { + "description": "Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive > 30 days.", + "enum": [ + "SERVICE_ACTIVATION_STATUS_UNSPECIFIED", + "SERVICE_ACTIVATION_ENABLED", + "SERVICE_ACTIVATION_DISABLED", + "SERVICE_ACTIVATION_DISABLED_FULL", + "SERVICE_ACTIVATION_UNKNOWN_REASON" + ], + "enumDescriptions": [ + "Default Unspecified status", + "Service is active in the project.", + "Service is disabled in the project recently i.e., within last 24 hours.", + "Service has been disabled for configured grace_period (default 30 days).", + "Happens when PSM cannot determine the status of service in a project Could happen due to variety of reasons like PERMISSION_DENIED or Project got deleted etc." + ], + "type": "string" + }, "serviceManagement": { "enum": [ "SERVICE_MANAGEMENT_UNKNOWN_REASON", diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 076c9c564b8..183d4eabd28 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -113,6 +113,7 @@ export namespace appengine_v1 { export class Appengine { context: APIRequestContext; apps: Resource$Apps; + projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -121,6 +122,7 @@ export namespace appengine_v1 { }; this.apps = new Resource$Apps(this.context); + this.projects = new Resource$Projects(this.context); } } @@ -1318,12 +1320,16 @@ export namespace appengine_v1 { timeout?: string | null; } /** - * Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) + * Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller) */ export interface Schema$Reasons { abuse?: string | null; billing?: string | null; dataGovernance?: string | null; + /** + * Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive \> 30 days. + */ + serviceActivation?: string | null; serviceManagement?: string | null; } /** @@ -6012,4 +6018,164 @@ export namespace appengine_v1 { */ versionsId?: string; } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + applications: Resource$Projects$Locations$Applications; + constructor(context: APIRequestContext) { + this.context = context; + this.applications = new Resource$Projects$Locations$Applications( + this.context + ); + } + } + + export class Resource$Projects$Locations$Applications { + context: APIRequestContext; + authorizedDomains: Resource$Projects$Locations$Applications$Authorizeddomains; + constructor(context: APIRequestContext) { + this.context = context; + this.authorizedDomains = + new Resource$Projects$Locations$Applications$Authorizeddomains( + this.context + ); + } + } + + export class Resource$Projects$Locations$Applications$Authorizeddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all domains the user is authorized to administer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Authorizeddomains$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Authorizeddomains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Authorizeddomains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectsId', 'locationsId', 'applicationsId'], + pathParams: ['applicationsId', 'locationsId', 'projectsId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Applications$Authorizeddomains$List + extends StandardParameters { + /** + * Part of `parent`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `parent`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Maximum results to return per page. + */ + pageSize?: number; + /** + * Continuation token for fetching the next page of results. + */ + pageToken?: string; + /** + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + */ + projectsId?: string; + } } diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index 7a4ebbb6fb0..ce5faa791c2 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -579,12 +579,16 @@ export namespace appengine_v1alpha { tenantProjectNumber?: string | null; } /** - * Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) + * Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller) */ export interface Schema$Reasons { abuse?: string | null; billing?: string | null; dataGovernance?: string | null; + /** + * Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive \> 30 days. + */ + serviceActivation?: string | null; serviceManagement?: string | null; } /** @@ -2291,9 +2295,13 @@ export namespace appengine_v1alpha { export class Resource$Projects$Locations { context: APIRequestContext; + applications: Resource$Projects$Locations$Applications; operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; + this.applications = new Resource$Projects$Locations$Applications( + this.context + ); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -2509,6 +2517,146 @@ export namespace appengine_v1alpha { projectsId?: string; } + export class Resource$Projects$Locations$Applications { + context: APIRequestContext; + authorizedDomains: Resource$Projects$Locations$Applications$Authorizeddomains; + constructor(context: APIRequestContext) { + this.context = context; + this.authorizedDomains = + new Resource$Projects$Locations$Applications$Authorizeddomains( + this.context + ); + } + } + + export class Resource$Projects$Locations$Applications$Authorizeddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all domains the user is authorized to administer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Authorizeddomains$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Authorizeddomains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Authorizeddomains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectsId', 'locationsId', 'applicationsId'], + pathParams: ['applicationsId', 'locationsId', 'projectsId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Applications$Authorizeddomains$List + extends StandardParameters { + /** + * Part of `parent`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `parent`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Maximum results to return per page. + */ + pageSize?: number; + /** + * Continuation token for fetching the next page of results. + */ + pageToken?: string; + /** + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + */ + projectsId?: string; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index a7cab525a44..4bdad5cebf8 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -1362,12 +1362,16 @@ export namespace appengine_v1beta { timeout?: string | null; } /** - * Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) + * Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller) */ export interface Schema$Reasons { abuse?: string | null; billing?: string | null; dataGovernance?: string | null; + /** + * Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive \> 30 days. + */ + serviceActivation?: string | null; serviceManagement?: string | null; } /** @@ -6079,9 +6083,13 @@ export namespace appengine_v1beta { export class Resource$Projects$Locations { context: APIRequestContext; + applications: Resource$Projects$Locations$Applications; operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; + this.applications = new Resource$Projects$Locations$Applications( + this.context + ); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -6297,6 +6305,146 @@ export namespace appengine_v1beta { projectsId?: string; } + export class Resource$Projects$Locations$Applications { + context: APIRequestContext; + authorizedDomains: Resource$Projects$Locations$Applications$Authorizeddomains; + constructor(context: APIRequestContext) { + this.context = context; + this.authorizedDomains = + new Resource$Projects$Locations$Applications$Authorizeddomains( + this.context + ); + } + } + + export class Resource$Projects$Locations$Applications$Authorizeddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all domains the user is authorized to administer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Applications$Authorizeddomains$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Authorizeddomains$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Authorizeddomains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Authorizeddomains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectsId', 'locationsId', 'applicationsId'], + pathParams: ['applicationsId', 'locationsId', 'projectsId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Applications$Authorizeddomains$List + extends StandardParameters { + /** + * Part of `parent`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `parent`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Maximum results to return per page. + */ + pageSize?: number; + /** + * Continuation token for fetching the next page of results. + */ + pageToken?: string; + /** + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + */ + projectsId?: string; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { From 6acbca76ad629d22ca632792e942da35cc687e6a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:46 +0000 Subject: [PATCH 07/78] feat(apphub): update the API #### apphub:v1alpha The following keys were added: - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.description - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.flatPath - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.httpMethod - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.id - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameterOrder - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.description - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.location - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.pattern - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.required - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.type - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.uri.description - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.uri.location - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.uri.type - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.path - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.response.$ref - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.scopes - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.flatPath - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.httpMethod - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.id - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameterOrder - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.location - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.pattern - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.required - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.type - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.uri.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.uri.location - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.uri.type - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.path - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.response.$ref - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.scopes - schemas.LookupDiscoveredServiceResponse.description - schemas.LookupDiscoveredServiceResponse.id - schemas.LookupDiscoveredServiceResponse.properties.discoveredService.$ref - schemas.LookupDiscoveredServiceResponse.properties.discoveredService.description - schemas.LookupDiscoveredServiceResponse.type - schemas.LookupDiscoveredWorkloadResponse.description - schemas.LookupDiscoveredWorkloadResponse.id - schemas.LookupDiscoveredWorkloadResponse.properties.discoveredWorkload.$ref - schemas.LookupDiscoveredWorkloadResponse.properties.discoveredWorkload.description - schemas.LookupDiscoveredWorkloadResponse.type The following keys were changed: - resources.projects.resources.locations.methods.detachServiceProjectAttachment.description - resources.projects.resources.locations.methods.detachServiceProjectAttachment.parameters.name.description - resources.projects.resources.locations.methods.lookupServiceProjectAttachment.description - resources.projects.resources.locations.methods.lookupServiceProjectAttachment.parameters.name.description - resources.projects.resources.locations.resources.applications.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.applications.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.applications.methods.get.parameters.name.description - resources.projects.resources.locations.resources.applications.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.applications.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.applications.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.applications.resources.services.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.applications.resources.services.methods.delete.description - resources.projects.resources.locations.resources.applications.resources.services.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.applications.resources.services.methods.get.parameters.name.description - resources.projects.resources.locations.resources.applications.resources.services.methods.list.description - resources.projects.resources.locations.resources.applications.resources.services.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.delete.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.get.parameters.name.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.discoveredServices.methods.findUnregistered.parameters.filter.description - resources.projects.resources.locations.resources.discoveredServices.methods.findUnregistered.parameters.orderBy.description - resources.projects.resources.locations.resources.discoveredServices.methods.findUnregistered.parameters.parent.description - resources.projects.resources.locations.resources.discoveredServices.methods.get.description - resources.projects.resources.locations.resources.discoveredServices.methods.get.parameters.name.description - resources.projects.resources.locations.resources.discoveredServices.methods.list.description - resources.projects.resources.locations.resources.discoveredServices.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.discoveredServices.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.discoveredServices.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.findUnregistered.parameters.filter.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.findUnregistered.parameters.orderBy.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.findUnregistered.parameters.parent.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.get.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.get.parameters.name.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.list.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.create.parameters.serviceProjectAttachmentId.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.delete.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.get.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.get.parameters.name.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.list.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.list.parameters.parent.description - schemas.FindUnregisteredServicesResponse.properties.discoveredServices.description - schemas.FindUnregisteredWorkloadsResponse.properties.discoveredWorkloads.description - schemas.ListDiscoveredServicesResponse.properties.discoveredServices.description - schemas.ListDiscoveredWorkloadsResponse.properties.discoveredWorkloads.description #### apphub:v1 The following keys were added: - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.description - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.flatPath - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.httpMethod - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.id - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameterOrder - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.description - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.location - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.pattern - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.required - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.parent.type - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.uri.description - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.uri.location - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.parameters.uri.type - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.path - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.response.$ref - resources.projects.resources.locations.resources.discoveredServices.methods.lookup.scopes - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.flatPath - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.httpMethod - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.id - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameterOrder - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.location - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.pattern - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.required - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.parent.type - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.uri.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.uri.location - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.parameters.uri.type - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.path - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.response.$ref - resources.projects.resources.locations.resources.discoveredWorkloads.methods.lookup.scopes - schemas.LookupDiscoveredServiceResponse.description - schemas.LookupDiscoveredServiceResponse.id - schemas.LookupDiscoveredServiceResponse.properties.discoveredService.$ref - schemas.LookupDiscoveredServiceResponse.properties.discoveredService.description - schemas.LookupDiscoveredServiceResponse.type - schemas.LookupDiscoveredWorkloadResponse.description - schemas.LookupDiscoveredWorkloadResponse.id - schemas.LookupDiscoveredWorkloadResponse.properties.discoveredWorkload.$ref - schemas.LookupDiscoveredWorkloadResponse.properties.discoveredWorkload.description - schemas.LookupDiscoveredWorkloadResponse.type The following keys were changed: - resources.projects.resources.locations.methods.detachServiceProjectAttachment.description - resources.projects.resources.locations.methods.detachServiceProjectAttachment.parameters.name.description - resources.projects.resources.locations.methods.lookupServiceProjectAttachment.description - resources.projects.resources.locations.methods.lookupServiceProjectAttachment.parameters.name.description - resources.projects.resources.locations.resources.applications.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.applications.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.applications.methods.get.parameters.name.description - resources.projects.resources.locations.resources.applications.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.applications.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.applications.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.applications.resources.services.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.applications.resources.services.methods.delete.description - resources.projects.resources.locations.resources.applications.resources.services.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.applications.resources.services.methods.get.parameters.name.description - resources.projects.resources.locations.resources.applications.resources.services.methods.list.description - resources.projects.resources.locations.resources.applications.resources.services.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.delete.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.get.parameters.name.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.applications.resources.workloads.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.discoveredServices.methods.get.description - resources.projects.resources.locations.resources.discoveredServices.methods.get.parameters.name.description - resources.projects.resources.locations.resources.discoveredServices.methods.list.description - resources.projects.resources.locations.resources.discoveredServices.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.discoveredServices.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.discoveredServices.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.get.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.get.parameters.name.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.list.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.discoveredWorkloads.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.create.parameters.serviceProjectAttachmentId.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.delete.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.get.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.get.parameters.name.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.list.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.serviceProjectAttachments.methods.list.parameters.parent.description - schemas.ListDiscoveredServicesResponse.properties.discoveredServices.description - schemas.ListDiscoveredWorkloadsResponse.properties.discoveredWorkloads.description --- discovery/apphub-v1.json | 178 +++++++++++++----- discovery/apphub-v1alpha.json | 194 +++++++++++++------ src/apis/apphub/v1.ts | 328 +++++++++++++++++++++++++++----- src/apis/apphub/v1alpha.ts | 342 ++++++++++++++++++++++++++++------ 4 files changed, 836 insertions(+), 206 deletions(-) diff --git a/discovery/apphub-v1.json b/discovery/apphub-v1.json index d33e34e2935..564164e3e4a 100644 --- a/discovery/apphub-v1.json +++ b/discovery/apphub-v1.json @@ -110,7 +110,7 @@ "locations": { "methods": { "detachServiceProjectAttachment": { - "description": "Detaches a service project from a host project. You can call this API from either a host or service project.", + "description": "Detaches a service project from a host project. You can call this API from any service project without needing access to the host project that it is attached to.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:detachServiceProjectAttachment", "httpMethod": "POST", "id": "apphub.projects.locations.detachServiceProjectAttachment", @@ -119,7 +119,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Service project id and location to detach from a host project. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -204,7 +204,7 @@ ] }, "lookupServiceProjectAttachment": { - "description": "Looks up a service project attachment. You can call this API from either a host or service project.", + "description": "Lists a service project attachment for a given service project. You can call this API from any project to find if it is attached to a host project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupServiceProjectAttachment", "httpMethod": "GET", "id": "apphub.projects.locations.lookupServiceProjectAttachment", @@ -213,7 +213,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Service project ID and location to lookup service project attachment for. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -247,7 +247,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to create Application in. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -280,7 +280,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Application to delete. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -310,7 +310,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Application to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -366,12 +366,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -387,7 +387,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to list Applications on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -511,7 +511,7 @@ ], "parameters": { "parent": { - "description": "Required. Value for parent.", + "description": "Required. Fully qualified name of the parent Application to create the Service in. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -540,7 +540,7 @@ ] }, "delete": { - "description": "Deletes a Service in an Application.", + "description": "Deletes a Service from an Application.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", "httpMethod": "DELETE", "id": "apphub.projects.locations.applications.services.delete", @@ -549,7 +549,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Service to delete from an Application. Expected format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/services/[^/]+$", "required": true, @@ -579,7 +579,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Service to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/services/[^/]+$", "required": true, @@ -595,7 +595,7 @@ ] }, "list": { - "description": "List Services in an Application.", + "description": "Lists Services in an Application.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services", "httpMethod": "GET", "id": "apphub.projects.locations.applications.services.list", @@ -625,7 +625,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Fully qualified name of the parent Application to list Services for. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -693,7 +693,7 @@ ], "parameters": { "parent": { - "description": "Required. Value for parent.", + "description": "Required. Fully qualified name of the Application to create Workload in. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -722,7 +722,7 @@ ] }, "delete": { - "description": "Deletes a Workload in an Application.", + "description": "Deletes a Workload from an Application.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads/{workloadsId}", "httpMethod": "DELETE", "id": "apphub.projects.locations.applications.workloads.delete", @@ -731,7 +731,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Workload to delete from an Application. Expected format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/workloads/[^/]+$", "required": true, @@ -761,7 +761,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Workload to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/workloads/[^/]+$", "required": true, @@ -786,12 +786,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -807,7 +807,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Fully qualified name of the parent Application to list Workloads for. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -868,7 +868,7 @@ "discoveredServices": { "methods": { "get": { - "description": "Gets a discovered service in a host project and location.", + "description": "Gets a Discovered Service in a host project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredServices/{discoveredServicesId}", "httpMethod": "GET", "id": "apphub.projects.locations.discoveredServices.get", @@ -877,7 +877,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Discovered Service to fetch. Expected format: `projects/{project}/locations/{location}/discoveredServices/{discoveredService}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredServices/[^/]+$", "required": true, @@ -893,7 +893,7 @@ ] }, "list": { - "description": "Lists discovered services that can be added to an application in a host project and location.", + "description": "Lists Discovered Services that can be added to an Application in a host project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredServices", "httpMethod": "GET", "id": "apphub.projects.locations.discoveredServices.list", @@ -902,12 +902,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -923,7 +923,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to list Discovered Services on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -937,13 +937,43 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "lookup": { + "description": "Lists a Discovered Service in a host project and location, with a given resource URI.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredServices:lookup", + "httpMethod": "GET", + "id": "apphub.projects.locations.discoveredServices.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Host project ID and location to lookup Discovered Service in. Expected format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "uri": { + "description": "Required. Resource URI to find DiscoveredService for. Accepts both project number and project ID and does translation when needed.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/discoveredServices:lookup", + "response": { + "$ref": "LookupDiscoveredServiceResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, "discoveredWorkloads": { "methods": { "get": { - "description": "Gets a discovered workload in a host project and location.", + "description": "Gets a Discovered Workload in a host project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads/{discoveredWorkloadsId}", "httpMethod": "GET", "id": "apphub.projects.locations.discoveredWorkloads.get", @@ -952,7 +982,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Discovered Workload to fetch. Expected format: `projects/{project}/locations/{location}/discoveredWorkloads/{discoveredWorkload}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredWorkloads/[^/]+$", "required": true, @@ -968,7 +998,7 @@ ] }, "list": { - "description": "Lists discovered workloads that can be added to an application in a host project and location.", + "description": "Lists Discovered Workloads that can be added to an Application in a host project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads", "httpMethod": "GET", "id": "apphub.projects.locations.discoveredWorkloads.list", @@ -977,12 +1007,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -998,7 +1028,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to list Discovered Workloads on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1012,6 +1042,36 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "lookup": { + "description": "Lists a Discovered Workload in a host project and location, with a given resource URI.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads:lookup", + "httpMethod": "GET", + "id": "apphub.projects.locations.discoveredWorkloads.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Host project ID and location to lookup Discovered Workload in. Expected format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "uri": { + "description": "Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/discoveredWorkloads:lookup", + "response": { + "$ref": "LookupDiscoveredWorkloadResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1150,7 +1210,7 @@ ], "parameters": { "parent": { - "description": "Required. Value for parent.", + "description": "Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1162,7 +1222,7 @@ "type": "string" }, "serviceProjectAttachmentId": { - "description": "Required. The service project attachment identifier must contain the project_id of the service project specified in the service_project_attachment.service_project field. Hint: \"projects/{project_id}\"", + "description": "Required. The service project attachment identifier must contain the project id of the service project specified in the service_project_attachment.service_project field.", "location": "query", "type": "string" } @@ -1179,7 +1239,7 @@ ] }, "delete": { - "description": "Deletes a service project attached to the host project.", + "description": "Deletes a service project attachment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments/{serviceProjectAttachmentsId}", "httpMethod": "DELETE", "id": "apphub.projects.locations.serviceProjectAttachments.delete", @@ -1188,7 +1248,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the service project attachment to delete. Expected format: `projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceProjectAttachments/[^/]+$", "required": true, @@ -1209,7 +1269,7 @@ ] }, "get": { - "description": "Gets a service project attached to the host project.", + "description": "Gets a service project attachment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments/{serviceProjectAttachmentsId}", "httpMethod": "GET", "id": "apphub.projects.locations.serviceProjectAttachments.get", @@ -1218,7 +1278,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the service project attachment to retrieve. Expected format: `projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceProjectAttachments/[^/]+$", "required": true, @@ -1234,7 +1294,7 @@ ] }, "list": { - "description": "List service projects attached to the host project.", + "description": "Lists service projects attached to the host project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments", "httpMethod": "GET", "id": "apphub.projects.locations.serviceProjectAttachments.list", @@ -1243,12 +1303,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -1264,7 +1324,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1286,7 +1346,7 @@ } } }, - "revision": "20240217", + "revision": "20240311", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { @@ -1640,7 +1700,7 @@ "id": "ListDiscoveredServicesResponse", "properties": { "discoveredServices": { - "description": "List of discovered services.", + "description": "List of Discovered Services.", "items": { "$ref": "DiscoveredService" }, @@ -1665,7 +1725,7 @@ "id": "ListDiscoveredWorkloadsResponse", "properties": { "discoveredWorkloads": { - "description": "List of discovered workloads.", + "description": "List of Discovered Workloads.", "items": { "$ref": "DiscoveredWorkload" }, @@ -1830,6 +1890,28 @@ }, "type": "object" }, + "LookupDiscoveredServiceResponse": { + "description": "Response for LookupDiscoveredService.", + "id": "LookupDiscoveredServiceResponse", + "properties": { + "discoveredService": { + "$ref": "DiscoveredService", + "description": "Discovered Service if exists, empty otherwise." + } + }, + "type": "object" + }, + "LookupDiscoveredWorkloadResponse": { + "description": "Response for LookupDiscoveredWorkload.", + "id": "LookupDiscoveredWorkloadResponse", + "properties": { + "discoveredWorkload": { + "$ref": "DiscoveredWorkload", + "description": "Discovered Workload if exists, empty otherwise." + } + }, + "type": "object" + }, "LookupServiceProjectAttachmentResponse": { "description": "Response for LookupServiceProjectAttachment.", "id": "LookupServiceProjectAttachmentResponse", diff --git a/discovery/apphub-v1alpha.json b/discovery/apphub-v1alpha.json index 579c6d8934e..478aa07813f 100644 --- a/discovery/apphub-v1alpha.json +++ b/discovery/apphub-v1alpha.json @@ -110,7 +110,7 @@ "locations": { "methods": { "detachServiceProjectAttachment": { - "description": "Detaches a service project from a host project. You can call this API from either a host or service project.", + "description": "Detaches a service project from a host project. You can call this API from any service project without needing access to the host project that it is attached to.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:detachServiceProjectAttachment", "httpMethod": "POST", "id": "apphub.projects.locations.detachServiceProjectAttachment", @@ -119,7 +119,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Service project id and location to detach from a host project. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -204,7 +204,7 @@ ] }, "lookupServiceProjectAttachment": { - "description": "Looks up a service project attachment. You can call this API from either a host or service project.", + "description": "Lists a service project attachment for a given service project. You can call this API from any project to find if it is attached to a host project.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:lookupServiceProjectAttachment", "httpMethod": "GET", "id": "apphub.projects.locations.lookupServiceProjectAttachment", @@ -213,7 +213,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Service project ID and location to lookup service project attachment for. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -247,7 +247,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to create Application in. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -280,7 +280,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Application to delete. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -310,7 +310,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Application to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -366,12 +366,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -387,7 +387,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to list Applications on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -511,7 +511,7 @@ ], "parameters": { "parent": { - "description": "Required. Value for parent.", + "description": "Required. Fully qualified name of the parent Application to create the Service in. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -540,7 +540,7 @@ ] }, "delete": { - "description": "Deletes a Service in an Application.", + "description": "Deletes a Service from an Application.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", "httpMethod": "DELETE", "id": "apphub.projects.locations.applications.services.delete", @@ -549,7 +549,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Service to delete from an Application. Expected format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/services/[^/]+$", "required": true, @@ -579,7 +579,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Service to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/services/[^/]+$", "required": true, @@ -595,7 +595,7 @@ ] }, "list": { - "description": "List Services in an Application.", + "description": "Lists Services in an Application.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services", "httpMethod": "GET", "id": "apphub.projects.locations.applications.services.list", @@ -625,7 +625,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Fully qualified name of the parent Application to list Services for. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -693,7 +693,7 @@ ], "parameters": { "parent": { - "description": "Required. Value for parent.", + "description": "Required. Fully qualified name of the Application to create Workload in. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -722,7 +722,7 @@ ] }, "delete": { - "description": "Deletes a Workload in an Application.", + "description": "Deletes a Workload from an Application.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads/{workloadsId}", "httpMethod": "DELETE", "id": "apphub.projects.locations.applications.workloads.delete", @@ -731,7 +731,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Workload to delete from an Application. Expected format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/workloads/[^/]+$", "required": true, @@ -761,7 +761,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Workload to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/workloads/[^/]+$", "required": true, @@ -786,12 +786,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -807,7 +807,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Fully qualified name of the parent Application to list Workloads for. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, @@ -877,12 +877,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -898,7 +898,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to find unregistered Discovered Services on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -914,7 +914,7 @@ ] }, "get": { - "description": "Gets a discovered service in a host project and location.", + "description": "Gets a Discovered Service in a host project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredServices/{discoveredServicesId}", "httpMethod": "GET", "id": "apphub.projects.locations.discoveredServices.get", @@ -923,7 +923,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Discovered Service to fetch. Expected format: `projects/{project}/locations/{location}/discoveredServices/{discoveredService}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredServices/[^/]+$", "required": true, @@ -939,7 +939,7 @@ ] }, "list": { - "description": "Lists discovered services that can be added to an application in a host project and location.", + "description": "Lists Discovered Services that can be added to an Application in a host project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredServices", "httpMethod": "GET", "id": "apphub.projects.locations.discoveredServices.list", @@ -948,12 +948,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -969,7 +969,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to list Discovered Services on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -983,6 +983,36 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "lookup": { + "description": "Lists a Discovered Service in a host project and location, with a given resource URI.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredServices:lookup", + "httpMethod": "GET", + "id": "apphub.projects.locations.discoveredServices.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Host project ID and location to lookup Discovered Service in. Expected format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "uri": { + "description": "Required. Resource URI to find DiscoveredService for. Accepts both project number and project ID and does translation when needed.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/discoveredServices:lookup", + "response": { + "$ref": "LookupDiscoveredServiceResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -998,12 +1028,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -1019,7 +1049,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to find unregistered Discovered Workloads on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1035,7 +1065,7 @@ ] }, "get": { - "description": "Gets a discovered workload in a host project and location.", + "description": "Gets a Discovered Workload in a host project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads/{discoveredWorkloadsId}", "httpMethod": "GET", "id": "apphub.projects.locations.discoveredWorkloads.get", @@ -1044,7 +1074,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the Discovered Workload to fetch. Expected format: `projects/{project}/locations/{location}/discoveredWorkloads/{discoveredWorkload}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredWorkloads/[^/]+$", "required": true, @@ -1060,7 +1090,7 @@ ] }, "list": { - "description": "Lists discovered workloads that can be added to an application in a host project and location.", + "description": "Lists Discovered Workloads that can be added to an Application in a host project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads", "httpMethod": "GET", "id": "apphub.projects.locations.discoveredWorkloads.list", @@ -1069,12 +1099,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -1090,7 +1120,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Project and location to list Discovered Workloads on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1104,6 +1134,36 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "lookup": { + "description": "Lists a Discovered Workload in a host project and location, with a given resource URI.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads:lookup", + "httpMethod": "GET", + "id": "apphub.projects.locations.discoveredWorkloads.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Host project ID and location to lookup Discovered Workload in. Expected format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "uri": { + "description": "Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/discoveredWorkloads:lookup", + "response": { + "$ref": "LookupDiscoveredWorkloadResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1242,7 +1302,7 @@ ], "parameters": { "parent": { - "description": "Required. Value for parent.", + "description": "Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1254,7 +1314,7 @@ "type": "string" }, "serviceProjectAttachmentId": { - "description": "Required. The service project attachment identifier must contain the project_id of the service project specified in the service_project_attachment.service_project field. Hint: \"projects/{project_id}\"", + "description": "Required. The service project attachment identifier must contain the project id of the service project specified in the service_project_attachment.service_project field.", "location": "query", "type": "string" } @@ -1271,7 +1331,7 @@ ] }, "delete": { - "description": "Deletes a service project attached to the host project.", + "description": "Deletes a service project attachment.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments/{serviceProjectAttachmentsId}", "httpMethod": "DELETE", "id": "apphub.projects.locations.serviceProjectAttachments.delete", @@ -1280,7 +1340,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the service project attachment to delete. Expected format: `projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceProjectAttachments/[^/]+$", "required": true, @@ -1301,7 +1361,7 @@ ] }, "get": { - "description": "Gets a service project attached to the host project.", + "description": "Gets a service project attachment.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments/{serviceProjectAttachmentsId}", "httpMethod": "GET", "id": "apphub.projects.locations.serviceProjectAttachments.get", @@ -1310,7 +1370,7 @@ ], "parameters": { "name": { - "description": "Required. Value for name.", + "description": "Required. Fully qualified name of the service project attachment to retrieve. Expected format: `projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceProjectAttachments/[^/]+$", "required": true, @@ -1326,7 +1386,7 @@ ] }, "list": { - "description": "List service projects attached to the host project.", + "description": "Lists service projects attached to the host project.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments", "httpMethod": "GET", "id": "apphub.projects.locations.serviceProjectAttachments.list", @@ -1335,12 +1395,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, @@ -1356,7 +1416,7 @@ "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1378,7 +1438,7 @@ } } }, - "revision": "20240217", + "revision": "20240311", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { @@ -1734,7 +1794,7 @@ "id": "FindUnregisteredServicesResponse", "properties": { "discoveredServices": { - "description": "List of discovered services.", + "description": "List of Discovered Services.", "items": { "$ref": "DiscoveredService" }, @@ -1759,7 +1819,7 @@ "id": "FindUnregisteredWorkloadsResponse", "properties": { "discoveredWorkloads": { - "description": "List of discovered workloads.", + "description": "List of Discovered Workloads.", "items": { "$ref": "DiscoveredWorkload" }, @@ -1809,7 +1869,7 @@ "id": "ListDiscoveredServicesResponse", "properties": { "discoveredServices": { - "description": "List of discovered services.", + "description": "List of Discovered Services.", "items": { "$ref": "DiscoveredService" }, @@ -1834,7 +1894,7 @@ "id": "ListDiscoveredWorkloadsResponse", "properties": { "discoveredWorkloads": { - "description": "List of discovered workloads.", + "description": "List of Discovered Workloads.", "items": { "$ref": "DiscoveredWorkload" }, @@ -1999,6 +2059,28 @@ }, "type": "object" }, + "LookupDiscoveredServiceResponse": { + "description": "Response for LookupDiscoveredService.", + "id": "LookupDiscoveredServiceResponse", + "properties": { + "discoveredService": { + "$ref": "DiscoveredService", + "description": "Discovered Service if exists, empty otherwise." + } + }, + "type": "object" + }, + "LookupDiscoveredWorkloadResponse": { + "description": "Response for LookupDiscoveredWorkload.", + "id": "LookupDiscoveredWorkloadResponse", + "properties": { + "discoveredWorkload": { + "$ref": "DiscoveredWorkload", + "description": "Discovered Workload if exists, empty otherwise." + } + }, + "type": "object" + }, "LookupServiceProjectAttachmentResponse": { "description": "Response for LookupServiceProjectAttachment.", "id": "LookupServiceProjectAttachmentResponse", diff --git a/src/apis/apphub/v1.ts b/src/apis/apphub/v1.ts index 6413ca78018..f7f2bd2a3f8 100644 --- a/src/apis/apphub/v1.ts +++ b/src/apis/apphub/v1.ts @@ -357,7 +357,7 @@ export namespace apphub_v1 { */ export interface Schema$ListDiscoveredServicesResponse { /** - * List of discovered services. + * List of Discovered Services. */ discoveredServices?: Schema$DiscoveredService[]; /** @@ -374,7 +374,7 @@ export namespace apphub_v1 { */ export interface Schema$ListDiscoveredWorkloadsResponse { /** - * List of discovered workloads. + * List of Discovered Workloads. */ discoveredWorkloads?: Schema$DiscoveredWorkload[]; /** @@ -488,6 +488,24 @@ export namespace apphub_v1 { */ name?: string | null; } + /** + * Response for LookupDiscoveredService. + */ + export interface Schema$LookupDiscoveredServiceResponse { + /** + * Discovered Service if exists, empty otherwise. + */ + discoveredService?: Schema$DiscoveredService; + } + /** + * Response for LookupDiscoveredWorkload. + */ + export interface Schema$LookupDiscoveredWorkloadResponse { + /** + * Discovered Workload if exists, empty otherwise. + */ + discoveredWorkload?: Schema$DiscoveredWorkload; + } /** * Response for LookupServiceProjectAttachment. */ @@ -855,7 +873,7 @@ export namespace apphub_v1 { } /** - * Detaches a service project from a host project. You can call this API from either a host or service project. + * Detaches a service project from a host project. You can call this API from any service project without needing access to the host project that it is attached to. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1127,7 +1145,7 @@ export namespace apphub_v1 { } /** - * Looks up a service project attachment. You can call this API from either a host or service project. + * Lists a service project attachment for a given service project. You can call this API from any project to find if it is attached to a host project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1226,7 +1244,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Detachserviceprojectattachment extends StandardParameters { /** - * Required. Value for name. + * Required. Service project id and location to detach from a host project. Only global location is supported. Expected format: `projects/{project\}/locations/{location\}`. */ name?: string; @@ -1264,7 +1282,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Lookupserviceprojectattachment extends StandardParameters { /** - * Required. Value for name. + * Required. Service project ID and location to lookup service project attachment for. Only global location is supported. Expected format: `projects/{project\}/locations/{location\}`. */ name?: string; } @@ -1993,7 +2011,7 @@ export namespace apphub_v1 { */ applicationId?: string; /** - * Required. Value for parent. + * Required. Project and location to create Application in. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; /** @@ -2009,7 +2027,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$Delete extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Application to delete. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ name?: string; /** @@ -2020,7 +2038,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Application to fetch. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ name?: string; } @@ -2038,11 +2056,11 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -2054,7 +2072,7 @@ export namespace apphub_v1 { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Project and location to list Applications on. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; } @@ -2198,7 +2216,7 @@ export namespace apphub_v1 { } /** - * Deletes a Service in an Application. + * Deletes a Service from an Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2368,7 +2386,7 @@ export namespace apphub_v1 { } /** - * List Services in an Application. + * Lists Services in an Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2549,7 +2567,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$Services$Create extends StandardParameters { /** - * Required. Value for parent. + * Required. Fully qualified name of the parent Application to create the Service in. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ parent?: string; /** @@ -2569,7 +2587,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$Services$Delete extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Service to delete from an Application. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}/services/{service\}`. */ name?: string; /** @@ -2580,7 +2598,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$Services$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Service to fetch. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}/services/{service\}`. */ name?: string; } @@ -2603,7 +2621,7 @@ export namespace apphub_v1 { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Fully qualified name of the parent Application to list Services for. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ parent?: string; } @@ -2723,7 +2741,7 @@ export namespace apphub_v1 { } /** - * Deletes a Workload in an Application. + * Deletes a Workload from an Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3074,7 +3092,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$Workloads$Create extends StandardParameters { /** - * Required. Value for parent. + * Required. Fully qualified name of the Application to create Workload in. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ parent?: string; /** @@ -3094,7 +3112,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$Workloads$Delete extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Workload to delete from an Application. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}/workloads/{workload\}`. */ name?: string; /** @@ -3105,18 +3123,18 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Applications$Workloads$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Workload to fetch. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}/workloads/{workload\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Applications$Workloads$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -3128,7 +3146,7 @@ export namespace apphub_v1 { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Fully qualified name of the parent Application to list Workloads for. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ parent?: string; } @@ -3160,7 +3178,7 @@ export namespace apphub_v1 { } /** - * Gets a discovered service in a host project and location. + * Gets a Discovered Service in a host project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3248,7 +3266,7 @@ export namespace apphub_v1 { } /** - * Lists discovered services that can be added to an application in a host project and location. + * Lists Discovered Services that can be added to an Application in a host project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3343,23 +3361,120 @@ export namespace apphub_v1 { ); } } + + /** + * Lists a Discovered Service in a host project and location, with a given resource URI. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookup( + params: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + options: StreamMethodOptions + ): GaxiosPromise; + lookup( + params?: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + options?: MethodOptions + ): GaxiosPromise; + lookup( + params: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + callback: BodyResponseCallback + ): void; + lookup( + callback: BodyResponseCallback + ): void; + lookup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredservices$Lookup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredservices$Lookup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredservices$Lookup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apphub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/discoveredServices:lookup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Discoveredservices$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Discovered Service to fetch. Expected format: `projects/{project\}/locations/{location\}/discoveredServices/{discoveredService\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Discoveredservices$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -3371,9 +3486,20 @@ export namespace apphub_v1 { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Project and location to list Discovered Services on. Expected format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredservices$Lookup + extends StandardParameters { + /** + * Required. Host project ID and location to lookup Discovered Service in. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Required. Resource URI to find DiscoveredService for. Accepts both project number and project ID and does translation when needed. + */ + uri?: string; } export class Resource$Projects$Locations$Discoveredworkloads { @@ -3383,7 +3509,7 @@ export namespace apphub_v1 { } /** - * Gets a discovered workload in a host project and location. + * Gets a Discovered Workload in a host project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3471,7 +3597,7 @@ export namespace apphub_v1 { } /** - * Lists discovered workloads that can be added to an application in a host project and location. + * Lists Discovered Workloads that can be added to an Application in a host project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3566,23 +3692,120 @@ export namespace apphub_v1 { ); } } + + /** + * Lists a Discovered Workload in a host project and location, with a given resource URI. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookup( + params: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + options: StreamMethodOptions + ): GaxiosPromise; + lookup( + params?: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + options?: MethodOptions + ): GaxiosPromise; + lookup( + params: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + callback: BodyResponseCallback + ): void; + lookup( + callback: BodyResponseCallback + ): void; + lookup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredworkloads$Lookup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredworkloads$Lookup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredworkloads$Lookup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apphub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/discoveredWorkloads:lookup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Discoveredworkloads$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Discovered Workload to fetch. Expected format: `projects/{project\}/locations/{location\}/discoveredWorkloads/{discoveredWorkload\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Discoveredworkloads$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -3594,9 +3817,20 @@ export namespace apphub_v1 { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Project and location to list Discovered Workloads on. Expected format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredworkloads$Lookup + extends StandardParameters { + /** + * Required. Host project ID and location to lookup Discovered Workload in. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed. + */ + uri?: string; } export class Resource$Projects$Locations$Operations { @@ -4091,7 +4325,7 @@ export namespace apphub_v1 { } /** - * Deletes a service project attached to the host project. + * Deletes a service project attachment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4176,7 +4410,7 @@ export namespace apphub_v1 { } /** - * Gets a service project attached to the host project. + * Gets a service project attachment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4266,7 +4500,7 @@ export namespace apphub_v1 { } /** - * List service projects attached to the host project. + * Lists service projects attached to the host project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4366,7 +4600,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Serviceprojectattachments$Create extends StandardParameters { /** - * Required. Value for parent. + * Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; /** @@ -4374,7 +4608,7 @@ export namespace apphub_v1 { */ requestId?: string; /** - * Required. The service project attachment identifier must contain the project_id of the service project specified in the service_project_attachment.service_project field. Hint: "projects/{project_id\}" + * Required. The service project attachment identifier must contain the project id of the service project specified in the service_project_attachment.service_project field. */ serviceProjectAttachmentId?: string; @@ -4386,7 +4620,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Serviceprojectattachments$Delete extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the service project attachment to delete. Expected format: `projects/{project\}/locations/{location\}/serviceProjectAttachments/{serviceProjectAttachment\}`. */ name?: string; /** @@ -4397,18 +4631,18 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$Serviceprojectattachments$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the service project attachment to retrieve. Expected format: `projects/{project\}/locations/{location\}/serviceProjectAttachments/{serviceProjectAttachment\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Serviceprojectattachments$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -4420,7 +4654,7 @@ export namespace apphub_v1 { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; } diff --git a/src/apis/apphub/v1alpha.ts b/src/apis/apphub/v1alpha.ts index c1927369859..8c00ab92562 100644 --- a/src/apis/apphub/v1alpha.ts +++ b/src/apis/apphub/v1alpha.ts @@ -365,7 +365,7 @@ export namespace apphub_v1alpha { */ export interface Schema$FindUnregisteredServicesResponse { /** - * List of discovered services. + * List of Discovered Services. */ discoveredServices?: Schema$DiscoveredService[]; /** @@ -382,7 +382,7 @@ export namespace apphub_v1alpha { */ export interface Schema$FindUnregisteredWorkloadsResponse { /** - * List of discovered workloads. + * List of Discovered Workloads. */ discoveredWorkloads?: Schema$DiscoveredWorkload[]; /** @@ -416,7 +416,7 @@ export namespace apphub_v1alpha { */ export interface Schema$ListDiscoveredServicesResponse { /** - * List of discovered services. + * List of Discovered Services. */ discoveredServices?: Schema$DiscoveredService[]; /** @@ -433,7 +433,7 @@ export namespace apphub_v1alpha { */ export interface Schema$ListDiscoveredWorkloadsResponse { /** - * List of discovered workloads. + * List of Discovered Workloads. */ discoveredWorkloads?: Schema$DiscoveredWorkload[]; /** @@ -547,6 +547,24 @@ export namespace apphub_v1alpha { */ name?: string | null; } + /** + * Response for LookupDiscoveredService. + */ + export interface Schema$LookupDiscoveredServiceResponse { + /** + * Discovered Service if exists, empty otherwise. + */ + discoveredService?: Schema$DiscoveredService; + } + /** + * Response for LookupDiscoveredWorkload. + */ + export interface Schema$LookupDiscoveredWorkloadResponse { + /** + * Discovered Workload if exists, empty otherwise. + */ + discoveredWorkload?: Schema$DiscoveredWorkload; + } /** * Response for LookupServiceProjectAttachment. */ @@ -905,7 +923,7 @@ export namespace apphub_v1alpha { } /** - * Detaches a service project from a host project. You can call this API from either a host or service project. + * Detaches a service project from a host project. You can call this API from any service project without needing access to the host project that it is attached to. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1177,7 +1195,7 @@ export namespace apphub_v1alpha { } /** - * Looks up a service project attachment. You can call this API from either a host or service project. + * Lists a service project attachment for a given service project. You can call this API from any project to find if it is attached to a host project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1276,7 +1294,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Detachserviceprojectattachment extends StandardParameters { /** - * Required. Value for name. + * Required. Service project id and location to detach from a host project. Only global location is supported. Expected format: `projects/{project\}/locations/{location\}`. */ name?: string; @@ -1314,7 +1332,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Lookupserviceprojectattachment extends StandardParameters { /** - * Required. Value for name. + * Required. Service project ID and location to lookup service project attachment for. Only global location is supported. Expected format: `projects/{project\}/locations/{location\}`. */ name?: string; } @@ -2043,7 +2061,7 @@ export namespace apphub_v1alpha { */ applicationId?: string; /** - * Required. Value for parent. + * Required. Project and location to create Application in. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; /** @@ -2059,7 +2077,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$Delete extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Application to delete. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ name?: string; /** @@ -2070,7 +2088,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Application to fetch. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ name?: string; } @@ -2088,11 +2106,11 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -2104,7 +2122,7 @@ export namespace apphub_v1alpha { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Project and location to list Applications on. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; } @@ -2248,7 +2266,7 @@ export namespace apphub_v1alpha { } /** - * Deletes a Service in an Application. + * Deletes a Service from an Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2418,7 +2436,7 @@ export namespace apphub_v1alpha { } /** - * List Services in an Application. + * Lists Services in an Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2599,7 +2617,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$Services$Create extends StandardParameters { /** - * Required. Value for parent. + * Required. Fully qualified name of the parent Application to create the Service in. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ parent?: string; /** @@ -2619,7 +2637,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$Services$Delete extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Service to delete from an Application. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}/services/{service\}`. */ name?: string; /** @@ -2630,7 +2648,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$Services$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Service to fetch. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}/services/{service\}`. */ name?: string; } @@ -2653,7 +2671,7 @@ export namespace apphub_v1alpha { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Fully qualified name of the parent Application to list Services for. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ parent?: string; } @@ -2773,7 +2791,7 @@ export namespace apphub_v1alpha { } /** - * Deletes a Workload in an Application. + * Deletes a Workload from an Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3124,7 +3142,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$Workloads$Create extends StandardParameters { /** - * Required. Value for parent. + * Required. Fully qualified name of the Application to create Workload in. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ parent?: string; /** @@ -3144,7 +3162,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$Workloads$Delete extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Workload to delete from an Application. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}/workloads/{workload\}`. */ name?: string; /** @@ -3155,18 +3173,18 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Applications$Workloads$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Workload to fetch. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}/workloads/{workload\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Applications$Workloads$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -3178,7 +3196,7 @@ export namespace apphub_v1alpha { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Fully qualified name of the parent Application to list Workloads for. Expected format: `projects/{project\}/locations/{location\}/applications/{application\}`. */ parent?: string; } @@ -3306,7 +3324,7 @@ export namespace apphub_v1alpha { } /** - * Gets a discovered service in a host project and location. + * Gets a Discovered Service in a host project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3394,7 +3412,7 @@ export namespace apphub_v1alpha { } /** - * Lists discovered services that can be added to an application in a host project and location. + * Lists Discovered Services that can be added to an Application in a host project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3489,16 +3507,112 @@ export namespace apphub_v1alpha { ); } } + + /** + * Lists a Discovered Service in a host project and location, with a given resource URI. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookup( + params: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + options: StreamMethodOptions + ): GaxiosPromise; + lookup( + params?: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + options?: MethodOptions + ): GaxiosPromise; + lookup( + params: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Discoveredservices$Lookup, + callback: BodyResponseCallback + ): void; + lookup( + callback: BodyResponseCallback + ): void; + lookup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredservices$Lookup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredservices$Lookup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredservices$Lookup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apphub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/discoveredServices:lookup' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Discoveredservices$Findunregistered extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -3510,25 +3624,25 @@ export namespace apphub_v1alpha { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Project and location to find unregistered Discovered Services on. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Discoveredservices$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Discovered Service to fetch. Expected format: `projects/{project\}/locations/{location\}/discoveredServices/{discoveredService\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Discoveredservices$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -3540,9 +3654,20 @@ export namespace apphub_v1alpha { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Project and location to list Discovered Services on. Expected format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredservices$Lookup + extends StandardParameters { + /** + * Required. Host project ID and location to lookup Discovered Service in. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Required. Resource URI to find DiscoveredService for. Accepts both project number and project ID and does translation when needed. + */ + uri?: string; } export class Resource$Projects$Locations$Discoveredworkloads { @@ -3649,7 +3774,7 @@ export namespace apphub_v1alpha { } /** - * Gets a discovered workload in a host project and location. + * Gets a Discovered Workload in a host project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3737,7 +3862,7 @@ export namespace apphub_v1alpha { } /** - * Lists discovered workloads that can be added to an application in a host project and location. + * Lists Discovered Workloads that can be added to an Application in a host project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3832,16 +3957,112 @@ export namespace apphub_v1alpha { ); } } + + /** + * Lists a Discovered Workload in a host project and location, with a given resource URI. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookup( + params: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + options: StreamMethodOptions + ): GaxiosPromise; + lookup( + params?: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + options?: MethodOptions + ): GaxiosPromise; + lookup( + params: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Discoveredworkloads$Lookup, + callback: BodyResponseCallback + ): void; + lookup( + callback: BodyResponseCallback + ): void; + lookup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredworkloads$Lookup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredworkloads$Lookup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredworkloads$Lookup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apphub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/discoveredWorkloads:lookup' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Discoveredworkloads$Findunregistered extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -3853,25 +4074,25 @@ export namespace apphub_v1alpha { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Project and location to find unregistered Discovered Workloads on. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Discoveredworkloads$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the Discovered Workload to fetch. Expected format: `projects/{project\}/locations/{location\}/discoveredWorkloads/{discoveredWorkload\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Discoveredworkloads$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -3883,9 +4104,20 @@ export namespace apphub_v1alpha { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Project and location to list Discovered Workloads on. Expected format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredworkloads$Lookup + extends StandardParameters { + /** + * Required. Host project ID and location to lookup Discovered Workload in. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed. + */ + uri?: string; } export class Resource$Projects$Locations$Operations { @@ -4382,7 +4614,7 @@ export namespace apphub_v1alpha { } /** - * Deletes a service project attached to the host project. + * Deletes a service project attachment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4467,7 +4699,7 @@ export namespace apphub_v1alpha { } /** - * Gets a service project attached to the host project. + * Gets a service project attachment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4557,7 +4789,7 @@ export namespace apphub_v1alpha { } /** - * List service projects attached to the host project. + * Lists service projects attached to the host project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4656,7 +4888,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Serviceprojectattachments$Create extends StandardParameters { /** - * Required. Value for parent. + * Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; /** @@ -4664,7 +4896,7 @@ export namespace apphub_v1alpha { */ requestId?: string; /** - * Required. The service project attachment identifier must contain the project_id of the service project specified in the service_project_attachment.service_project field. Hint: "projects/{project_id\}" + * Required. The service project attachment identifier must contain the project id of the service project specified in the service_project_attachment.service_project field. */ serviceProjectAttachmentId?: string; @@ -4676,7 +4908,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Serviceprojectattachments$Delete extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the service project attachment to delete. Expected format: `projects/{project\}/locations/{location\}/serviceProjectAttachments/{serviceProjectAttachment\}`. */ name?: string; /** @@ -4687,18 +4919,18 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$Serviceprojectattachments$Get extends StandardParameters { /** - * Required. Value for name. + * Required. Fully qualified name of the service project attachment to retrieve. Expected format: `projects/{project\}/locations/{location\}/serviceProjectAttachments/{serviceProjectAttachment\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Serviceprojectattachments$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filtering results. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Hint for how to order the results. */ orderBy?: string; /** @@ -4710,7 +4942,7 @@ export namespace apphub_v1alpha { */ pageToken?: string; /** - * Required. Value for parent. + * Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: `projects/{project\}/locations/{location\}`. */ parent?: string; } From f660310c8a488a4fc3cb105285b227251d26cf32 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:46 +0000 Subject: [PATCH 08/78] feat(artifactregistry): update the API #### artifactregistry:v1beta2 The following keys were added: - resources.media.methods.download.description - resources.media.methods.download.flatPath - resources.media.methods.download.httpMethod - resources.media.methods.download.id - resources.media.methods.download.parameterOrder - resources.media.methods.download.parameters.name.description - resources.media.methods.download.parameters.name.location - resources.media.methods.download.parameters.name.pattern - resources.media.methods.download.parameters.name.required - resources.media.methods.download.parameters.name.type - resources.media.methods.download.path - resources.media.methods.download.response.$ref - resources.media.methods.download.scopes - resources.media.methods.download.supportsMediaDownload - resources.media.methods.download.useMediaDownloadService - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.description - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.flatPath - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.httpMethod - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.id - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameterOrder - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.path - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.request.$ref - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.response.$ref - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.scopes - schemas.DownloadFileResponse.description - schemas.DownloadFileResponse.id - schemas.DownloadFileResponse.type - schemas.Package.properties.annotations.additionalProperties.type - schemas.Package.properties.annotations.description - schemas.Package.properties.annotations.type The following keys were changed: - schemas.ProjectSettings.properties.legacyRedirectionState.enum - schemas.ProjectSettings.properties.legacyRedirectionState.enumDeprecated - schemas.ProjectSettings.properties.legacyRedirectionState.enumDescriptions #### artifactregistry:v1 The following keys were added: - resources.media.methods.download.description - resources.media.methods.download.flatPath - resources.media.methods.download.httpMethod - resources.media.methods.download.id - resources.media.methods.download.parameterOrder - resources.media.methods.download.parameters.name.description - resources.media.methods.download.parameters.name.location - resources.media.methods.download.parameters.name.pattern - resources.media.methods.download.parameters.name.required - resources.media.methods.download.parameters.name.type - resources.media.methods.download.path - resources.media.methods.download.response.$ref - resources.media.methods.download.scopes - resources.media.methods.download.supportsMediaDownload - resources.media.methods.download.useMediaDownloadService - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.description - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.flatPath - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.httpMethod - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.id - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameterOrder - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.path - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.request.$ref - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.response.$ref - resources.projects.resources.locations.resources.repositories.resources.packages.methods.patch.scopes - schemas.AptRepository.properties.customRepository.$ref - schemas.AptRepository.properties.customRepository.description - schemas.DockerRepository.properties.customRepository.$ref - schemas.DockerRepository.properties.customRepository.description - schemas.DownloadFileResponse.description - schemas.DownloadFileResponse.id - schemas.DownloadFileResponse.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository.id - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository.properties.uri.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository.properties.uri.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository.id - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository.properties.uri.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository.properties.uri.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository.id - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository.properties.uri.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository.properties.uri.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository.id - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository.properties.uri.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository.properties.uri.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository.id - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository.properties.uri.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository.properties.uri.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository.id - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository.properties.uri.description - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository.properties.uri.type - schemas.GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository.type - schemas.MavenRepository.properties.customRepository.$ref - schemas.MavenRepository.properties.customRepository.description - schemas.NpmRepository.properties.customRepository.$ref - schemas.NpmRepository.properties.customRepository.description - schemas.Package.properties.annotations.additionalProperties.type - schemas.Package.properties.annotations.description - schemas.Package.properties.annotations.type - schemas.PythonRepository.properties.customRepository.$ref - schemas.PythonRepository.properties.customRepository.description - schemas.RemoteRepositoryConfig.properties.disableUpstreamValidation.description - schemas.RemoteRepositoryConfig.properties.disableUpstreamValidation.type - schemas.YumRepository.properties.customRepository.$ref - schemas.YumRepository.properties.customRepository.description The following keys were changed: - schemas.ProjectSettings.properties.legacyRedirectionState.enum - schemas.ProjectSettings.properties.legacyRedirectionState.enumDeprecated - schemas.ProjectSettings.properties.legacyRedirectionState.enumDescriptions --- discovery/artifactregistry-v1.json | 184 ++++++++++++++- discovery/artifactregistry-v1beta2.json | 90 ++++++- src/apis/artifactregistry/v1.ts | 300 ++++++++++++++++++++++++ 3 files changed, 566 insertions(+), 8 deletions(-) diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index d048c7babd4..0ef4d6c0500 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -115,6 +115,38 @@ }, "protocol": "rest", "resources": { + "media": { + "methods": { + "download": { + "description": "Download a file.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/files/{filesId}:download", + "httpMethod": "GET", + "id": "artifactregistry.media.download", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the file to download.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/files/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:download", + "response": { + "$ref": "DownloadFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "supportsMediaDownload": true, + "useMediaDownloadService": true + } + } + }, "projects": { "methods": { "getProjectSettings": { @@ -1193,6 +1225,40 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] + }, + "patch": { + "description": "Updates a package.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}", + "httpMethod": "PATCH", + "id": "artifactregistry.projects.locations.repositories.packages.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the package, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. If the package ID part contains slashes, the slashes are escaped.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Package" + }, + "response": { + "$ref": "Package" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1668,7 +1734,7 @@ } } }, - "revision": "20240213", + "revision": "20240308", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -1723,6 +1789,10 @@ "description": "Configuration for an Apt remote repository.", "id": "AptRepository", "properties": { + "customRepository": { + "$ref": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository", + "description": "Customer-specified remote repository." + }, "publicRepository": { "$ref": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryPublicRepository", "description": "One of the publicly available Apt repositories supported by Artifact Registry." @@ -1941,6 +2011,10 @@ "description": "Configuration for a Docker remote repository.", "id": "DockerRepository", "properties": { + "customRepository": { + "$ref": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository", + "description": "Customer-specified remote repository." + }, "publicRepository": { "description": "One of the publicly available Docker repositories supported by Artifact Registry.", "enum": [ @@ -1967,6 +2041,12 @@ }, "type": "object" }, + "DownloadFileResponse": { + "description": "The response to download a file.", + "id": "DownloadFileResponse", + "properties": {}, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -2090,6 +2170,17 @@ }, "type": "object" }, + "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository": { + "description": "Customer-specified publicly available remote repository.", + "id": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository", + "properties": { + "uri": { + "description": "An http/https uri reference to the upstream remote repository, for ex: \"https://my.apt.registry/\".", + "type": "string" + } + }, + "type": "object" + }, "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryPublicRepository": { "description": "Publicly available Apt repositories constructed from a common repository base and a custom repository path.", "id": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryPublicRepository", @@ -2117,6 +2208,61 @@ }, "type": "object" }, + "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository": { + "description": "Customer-specified publicly available remote repository.", + "id": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository", + "properties": { + "uri": { + "description": "An http/https uri reference to the custom remote repository, for ex: \"https://registry-1.docker.io\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository": { + "description": "Customer-specified publicly available remote repository.", + "id": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository", + "properties": { + "uri": { + "description": "An http/https uri reference to the upstream remote repository, for ex: \"https://my.maven.registry/\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository": { + "description": "Customer-specified publicly available remote repository.", + "id": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository", + "properties": { + "uri": { + "description": "An http/https uri reference to the upstream remote repository, for ex: \"https://my.npm.registry/\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository": { + "description": "Customer-specified publicly available remote repository.", + "id": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository", + "properties": { + "uri": { + "description": "An http/https uri reference to the upstream remote repository, for ex: \"https://my.python.registry/\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository": { + "description": "Customer-specified publicly available remote repository.", + "id": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository", + "properties": { + "uri": { + "description": "An http/https uri reference to the upstream remote repository, for ex: \"https://my.yum.registry/\".", + "type": "string" + } + }, + "type": "object" + }, "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryPublicRepository": { "description": "Publicly available Yum repositories constructed from a common repository base and a custom repository path.", "id": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryPublicRepository", @@ -2662,6 +2808,10 @@ "description": "Configuration for a Maven remote repository.", "id": "MavenRepository", "properties": { + "customRepository": { + "$ref": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository", + "description": "Customer-specified remote repository." + }, "publicRepository": { "description": "One of the publicly available Maven repositories supported by Artifact Registry.", "enum": [ @@ -2744,6 +2894,10 @@ "description": "Configuration for a Npm remote repository.", "id": "NpmRepository", "properties": { + "customRepository": { + "$ref": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository", + "description": "Customer-specified remote repository." + }, "publicRepository": { "description": "One of the publicly available Npm repositories supported by Artifact Registry.", "enum": [ @@ -2804,6 +2958,13 @@ "description": "Packages are named collections of versions.", "id": "Package", "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Client specified annotations.", + "type": "object" + }, "createTime": { "description": "The time when the package was created.", "format": "google-datetime", @@ -2859,19 +3020,22 @@ "REDIRECTION_STATE_UNSPECIFIED", "REDIRECTION_FROM_GCR_IO_DISABLED", "REDIRECTION_FROM_GCR_IO_ENABLED", - "REDIRECTION_FROM_GCR_IO_FINALIZED" + "REDIRECTION_FROM_GCR_IO_FINALIZED", + "REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING" ], "enumDeprecated": [ false, false, false, - true + true, + false ], "enumDescriptions": [ "No redirection status has been set.", "Redirection is disabled.", "Redirection is enabled.", - "Redirection is enabled, and has been finalized so cannot be reverted." + "Redirection is enabled, and has been finalized so cannot be reverted.", + "Redirection is enabled and missing images are copied from GCR" ], "type": "string" }, @@ -2921,6 +3085,10 @@ "description": "Configuration for a Python remote repository.", "id": "PythonRepository", "properties": { + "customRepository": { + "$ref": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository", + "description": "Customer-specified remote repository." + }, "publicRepository": { "description": "One of the publicly available Python repositories supported by Artifact Registry.", "enum": [ @@ -2948,6 +3116,10 @@ "description": "The description of the remote source.", "type": "string" }, + "disableUpstreamValidation": { + "description": "Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials.", + "type": "boolean" + }, "dockerRepository": { "$ref": "DockerRepository", "description": "Specific settings for a Docker remote repository." @@ -3516,6 +3688,10 @@ "description": "Configuration for a Yum remote repository.", "id": "YumRepository", "properties": { + "customRepository": { + "$ref": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository", + "description": "Customer-specified remote repository." + }, "publicRepository": { "$ref": "GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryPublicRepository", "description": "One of the publicly available Yum repositories supported by Artifact Registry." diff --git a/discovery/artifactregistry-v1beta2.json b/discovery/artifactregistry-v1beta2.json index bb955731c0f..98f6471f2a7 100644 --- a/discovery/artifactregistry-v1beta2.json +++ b/discovery/artifactregistry-v1beta2.json @@ -115,6 +115,38 @@ }, "protocol": "rest", "resources": { + "media": { + "methods": { + "download": { + "description": "Download a file.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/files/{filesId}:download", + "httpMethod": "GET", + "id": "artifactregistry.media.download", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the file to download.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/files/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:download", + "response": { + "$ref": "DownloadFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "supportsMediaDownload": true, + "useMediaDownloadService": true + } + } + }, "projects": { "methods": { "getProjectSettings": { @@ -762,6 +794,40 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] + }, + "patch": { + "description": "Updates a package.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}", + "httpMethod": "PATCH", + "id": "artifactregistry.projects.locations.repositories.packages.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the package, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. If the package ID part contains slashes, the slashes are escaped.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "request": { + "$ref": "Package" + }, + "response": { + "$ref": "Package" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1142,7 +1208,7 @@ } } }, - "revision": "20240213", + "revision": "20240308", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -1215,6 +1281,12 @@ }, "type": "object" }, + "DownloadFileResponse": { + "description": "The response to download a file.", + "id": "DownloadFileResponse", + "properties": {}, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1663,6 +1735,13 @@ "description": "Packages are named collections of versions.", "id": "Package", "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Client specified annotations.", + "type": "object" + }, "createTime": { "description": "The time when the package was created.", "format": "google-datetime", @@ -1718,19 +1797,22 @@ "REDIRECTION_STATE_UNSPECIFIED", "REDIRECTION_FROM_GCR_IO_DISABLED", "REDIRECTION_FROM_GCR_IO_ENABLED", - "REDIRECTION_FROM_GCR_IO_FINALIZED" + "REDIRECTION_FROM_GCR_IO_FINALIZED", + "REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING" ], "enumDeprecated": [ false, false, false, - true + true, + false ], "enumDescriptions": [ "No redirection status has been set.", "Redirection is disabled.", "Redirection is enabled.", - "Redirection is enabled, and has been finalized so cannot be reverted." + "Redirection is enabled, and has been finalized so cannot be reverted.", + "Redirection is enabled and missing images are copied from GCR" ], "type": "string" }, diff --git a/src/apis/artifactregistry/v1.ts b/src/apis/artifactregistry/v1.ts index ec4c38383ff..01f65af2037 100644 --- a/src/apis/artifactregistry/v1.ts +++ b/src/apis/artifactregistry/v1.ts @@ -112,6 +112,7 @@ export namespace artifactregistry_v1 { */ export class Artifactregistry { context: APIRequestContext; + media: Resource$Media; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace artifactregistry_v1 { google, }; + this.media = new Resource$Media(this.context); this.projects = new Resource$Projects(this.context); } } @@ -157,6 +159,10 @@ export namespace artifactregistry_v1 { * Configuration for an Apt remote repository. */ export interface Schema$AptRepository { + /** + * Customer-specified remote repository. + */ + customRepository?: Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository; /** * One of the publicly available Apt repositories supported by Artifact Registry. */ @@ -305,6 +311,10 @@ export namespace artifactregistry_v1 { * Configuration for a Docker remote repository. */ export interface Schema$DockerRepository { + /** + * Customer-specified remote repository. + */ + customRepository?: Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository; /** * One of the publicly available Docker repositories supported by Artifact Registry. */ @@ -319,6 +329,10 @@ export namespace artifactregistry_v1 { */ immutableTags?: boolean | null; } + /** + * The response to download a file. + */ + export interface Schema$DownloadFileResponse {} /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -415,6 +429,15 @@ export namespace artifactregistry_v1 { */ updateTime?: string | null; } + /** + * Customer-specified publicly available remote repository. + */ + export interface Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryCustomRepository { + /** + * An http/https uri reference to the upstream remote repository, for ex: "https://my.apt.registry/". + */ + uri?: string | null; + } /** * Publicly available Apt repositories constructed from a common repository base and a custom repository path. */ @@ -428,6 +451,51 @@ export namespace artifactregistry_v1 { */ repositoryPath?: string | null; } + /** + * Customer-specified publicly available remote repository. + */ + export interface Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigDockerRepositoryCustomRepository { + /** + * An http/https uri reference to the custom remote repository, for ex: "https://registry-1.docker.io". + */ + uri?: string | null; + } + /** + * Customer-specified publicly available remote repository. + */ + export interface Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository { + /** + * An http/https uri reference to the upstream remote repository, for ex: "https://my.maven.registry/". + */ + uri?: string | null; + } + /** + * Customer-specified publicly available remote repository. + */ + export interface Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository { + /** + * An http/https uri reference to the upstream remote repository, for ex: "https://my.npm.registry/". + */ + uri?: string | null; + } + /** + * Customer-specified publicly available remote repository. + */ + export interface Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository { + /** + * An http/https uri reference to the upstream remote repository, for ex: "https://my.python.registry/". + */ + uri?: string | null; + } + /** + * Customer-specified publicly available remote repository. + */ + export interface Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository { + /** + * An http/https uri reference to the upstream remote repository, for ex: "https://my.yum.registry/". + */ + uri?: string | null; + } /** * Publicly available Yum repositories constructed from a common repository base and a custom repository path. */ @@ -815,6 +883,10 @@ export namespace artifactregistry_v1 { * Configuration for a Maven remote repository. */ export interface Schema$MavenRepository { + /** + * Customer-specified remote repository. + */ + customRepository?: Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigMavenRepositoryCustomRepository; /** * One of the publicly available Maven repositories supported by Artifact Registry. */ @@ -866,6 +938,10 @@ export namespace artifactregistry_v1 { * Configuration for a Npm remote repository. */ export interface Schema$NpmRepository { + /** + * Customer-specified remote repository. + */ + customRepository?: Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigNpmRepositoryCustomRepository; /** * One of the publicly available Npm repositories supported by Artifact Registry. */ @@ -904,6 +980,10 @@ export namespace artifactregistry_v1 { * Packages are named collections of versions. */ export interface Schema$Package { + /** + * Optional. Client specified annotations. + */ + annotations?: {[key: string]: string} | null; /** * The time when the package was created. */ @@ -984,6 +1064,10 @@ export namespace artifactregistry_v1 { * Configuration for a Python remote repository. */ export interface Schema$PythonRepository { + /** + * Customer-specified remote repository. + */ + customRepository?: Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigPythonRepositoryCustomRepository; /** * One of the publicly available Python repositories supported by Artifact Registry. */ @@ -1001,6 +1085,10 @@ export namespace artifactregistry_v1 { * The description of the remote source. */ description?: string | null; + /** + * Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials. + */ + disableUpstreamValidation?: boolean | null; /** * Specific settings for a Docker remote repository. */ @@ -1392,12 +1480,122 @@ export namespace artifactregistry_v1 { * Configuration for a Yum remote repository. */ export interface Schema$YumRepository { + /** + * Customer-specified remote repository. + */ + customRepository?: Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryCustomRepository; /** * One of the publicly available Yum repositories supported by Artifact Registry. */ publicRepository?: Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigYumRepositoryPublicRepository; } + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Download a file. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + download( + params: Params$Resource$Media$Download, + options: StreamMethodOptions + ): GaxiosPromise; + download( + params?: Params$Resource$Media$Download, + options?: MethodOptions + ): GaxiosPromise; + download( + params: Params$Resource$Media$Download, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + callback: BodyResponseCallback + ): void; + download(callback: BodyResponseCallback): void; + download( + paramsOrCallback?: + | Params$Resource$Media$Download + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Download; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:download').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Media$Download extends StandardParameters { + /** + * Required. The name of the file to download. + */ + name?: string; + } + export class Resource$Projects { context: APIRequestContext; locations: Resource$Projects$Locations; @@ -4860,6 +5058,92 @@ export namespace artifactregistry_v1 { return createAPIRequest(parameters); } } + + /** + * Updates a package. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Packages$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Packages$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Repositories$Packages$Delete @@ -4891,6 +5175,22 @@ export namespace artifactregistry_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Patch + extends StandardParameters { + /** + * The name of the package, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. If the package ID part contains slashes, the slashes are escaped. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Package; + } export class Resource$Projects$Locations$Repositories$Packages$Tags { context: APIRequestContext; From ce3b9d9cd6943d210729caea8e10f0b3d9ae5871 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 09/78] feat(authorizedbuyersmarketplace): update the API #### authorizedbuyersmarketplace:v1 The following keys were added: - schemas.Deal.properties.eligibleSeatIds.description - schemas.Deal.properties.eligibleSeatIds.items.type - schemas.Deal.properties.eligibleSeatIds.readOnly - schemas.Deal.properties.eligibleSeatIds.type - schemas.Deal.properties.mediaPlanner.$ref - schemas.Deal.properties.mediaPlanner.description - schemas.Deal.properties.mediaPlanner.readOnly - schemas.MediaPlanner.description - schemas.MediaPlanner.id - schemas.MediaPlanner.properties.accountId.description - schemas.MediaPlanner.properties.accountId.readOnly - schemas.MediaPlanner.properties.accountId.type - schemas.MediaPlanner.type The following keys were changed: - resources.bidders.resources.finalizedDeals.methods.list.parameters.filter.description - resources.buyers.resources.finalizedDeals.methods.list.parameters.filter.description - schemas.Deal.properties.billedBuyer.description - schemas.Deal.properties.buyer.description --- discovery/authorizedbuyersmarketplace-v1.json | 35 ++++++++++++++++--- src/apis/authorizedbuyersmarketplace/v1.ts | 25 ++++++++++--- 2 files changed, 51 insertions(+), 9 deletions(-) diff --git a/discovery/authorizedbuyersmarketplace-v1.json b/discovery/authorizedbuyersmarketplace-v1.json index bee58975d6b..10563323afa 100644 --- a/discovery/authorizedbuyersmarketplace-v1.json +++ b/discovery/authorizedbuyersmarketplace-v1.json @@ -119,7 +119,7 @@ ], "parameters": { "filter": { - "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus", + "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", "location": "query", "type": "string" }, @@ -767,7 +767,7 @@ ], "parameters": { "filter": { - "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus", + "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", "location": "query", "type": "string" }, @@ -1307,7 +1307,7 @@ } } }, - "revision": "20231213", + "revision": "20240312", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -1774,12 +1774,12 @@ "id": "Deal", "properties": { "billedBuyer": { - "description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`", + "description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`", "readOnly": true, "type": "string" }, "buyer": { - "description": "Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`", + "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`", "readOnly": true, "type": "string" }, @@ -1831,6 +1831,14 @@ "readOnly": true, "type": "string" }, + "eligibleSeatIds": { + "description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "estimatedGrossSpend": { "$ref": "Money", "description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly." @@ -1845,6 +1853,11 @@ "format": "google-datetime", "type": "string" }, + "mediaPlanner": { + "$ref": "MediaPlanner", + "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).", + "readOnly": true + }, "name": { "description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", "type": "string" @@ -2340,6 +2353,18 @@ }, "type": "object" }, + "MediaPlanner": { + "description": "Describes a single Media Planner account.", + "id": "MediaPlanner", + "properties": { + "accountId": { + "description": "Output only. Account ID of the media planner.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "MobileApplicationTargeting": { "description": "Mobile application targeting settings.", "id": "MobileApplicationTargeting", diff --git a/src/apis/authorizedbuyersmarketplace/v1.ts b/src/apis/authorizedbuyersmarketplace/v1.ts index d2622a5696d..2c89f45c5b6 100644 --- a/src/apis/authorizedbuyersmarketplace/v1.ts +++ b/src/apis/authorizedbuyersmarketplace/v1.ts @@ -377,11 +377,11 @@ export namespace authorizedbuyersmarketplace_v1 { */ export interface Schema$Deal { /** - * Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId\}` + * Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId\}` */ billedBuyer?: string | null; /** - * Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId\}` + * Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId\}` */ buyer?: string | null; /** @@ -412,6 +412,10 @@ export namespace authorizedbuyersmarketplace_v1 { * Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal. */ displayName?: string | null; + /** + * Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace. + */ + eligibleSeatIds?: string[] | null; /** * Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly. */ @@ -424,6 +428,10 @@ export namespace authorizedbuyersmarketplace_v1 { * Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. */ flightStartTime?: string | null; + /** + * Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser). + */ + mediaPlanner?: Schema$MediaPlanner; /** * Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId\}/proposals/{proposalId\}/deals/{dealId\} */ @@ -716,6 +724,15 @@ export namespace authorizedbuyersmarketplace_v1 { */ videoTargeting?: Schema$VideoTargeting; } + /** + * Describes a single Media Planner account. + */ + export interface Schema$MediaPlanner { + /** + * Output only. Account ID of the media planner. + */ + accountId?: string | null; + } /** * Mobile application targeting settings. */ @@ -1352,7 +1369,7 @@ export namespace authorizedbuyersmarketplace_v1 { export interface Params$Resource$Bidders$Finalizeddeals$List extends StandardParameters { /** - * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus + * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus */ filter?: string; /** @@ -3799,7 +3816,7 @@ export namespace authorizedbuyersmarketplace_v1 { export interface Params$Resource$Buyers$Finalizeddeals$List extends StandardParameters { /** - * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus + * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus */ filter?: string; /** From 7912c1c60768b5895b142d403202fe440f5d8388 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 10/78] feat(beyondcorp): update the API #### beyondcorp:v1alpha The following keys were added: - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.flatPath - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.httpMethod - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.id - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameterOrder - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.securityGatewayId.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.securityGatewayId.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.parameters.securityGatewayId.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.path - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.request.$ref - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.response.$ref - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.create.scopes - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.flatPath - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.httpMethod - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.id - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameterOrder - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.validateOnly.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.validateOnly.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.parameters.validateOnly.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.path - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.response.$ref - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.delete.scopes - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.flatPath - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.httpMethod - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.id - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.parameterOrder - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.parameters.name.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.parameters.name.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.parameters.name.required - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.parameters.name.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.path - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.response.$ref - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.get.scopes - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.flatPath - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.httpMethod - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.id - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameterOrder - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.path - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.response.$ref - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.list.scopes - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.flatPath - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.httpMethod - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.id - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameterOrder - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.path - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.request.$ref - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.response.$ref - resources.projects.resources.locations.resources.global.resources.securityGateways.methods.patch.scopes - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.id - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.properties.nextPageToken.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.properties.nextPageToken.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.properties.securityGateways.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.properties.securityGateways.items.$ref - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.properties.securityGateways.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.properties.unreachable.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.properties.unreachable.items.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.properties.unreachable.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.id - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.properties.egressIpAddresses.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.properties.egressIpAddresses.items.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.properties.egressIpAddresses.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.properties.egressIpAddresses.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.properties.region.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.properties.region.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.id - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.createTime.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.createTime.format - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.createTime.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.createTime.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.displayName.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.displayName.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.name.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.name.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.regionConfigs.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.regionConfigs.items.$ref - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.regionConfigs.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.state.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.state.enum - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.state.enumDescriptions - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.state.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.state.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.updateTime.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.updateTime.format - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.updateTime.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.updateTime.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.id - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.apiVersion.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.apiVersion.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.apiVersion.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.createTime.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.createTime.format - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.createTime.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.createTime.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.endTime.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.endTime.format - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.endTime.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.endTime.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.requestedCancellation.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.requestedCancellation.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.requestedCancellation.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.statusMessage.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.statusMessage.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.statusMessage.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.target.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.target.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.target.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.verb.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.verb.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.verb.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.type The following keys were changed: - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig.properties.transportInfo.description #### beyondcorp:v1 The following keys were added: - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.id - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.apiVersion.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.apiVersion.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.apiVersion.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.createTime.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.createTime.format - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.createTime.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.createTime.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.endTime.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.endTime.format - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.endTime.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.endTime.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.requestedCancellation.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.requestedCancellation.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.requestedCancellation.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.statusMessage.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.statusMessage.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.statusMessage.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.target.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.target.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.target.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.verb.description - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.verb.readOnly - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.properties.verb.type - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata.type --- discovery/beyondcorp-v1.json | 46 +- discovery/beyondcorp-v1alpha.json | 340 ++++++++++++++- src/apis/beyondcorp/v1.ts | 33 ++ src/apis/beyondcorp/v1alpha.ts | 669 +++++++++++++++++++++++++++++- 4 files changed, 1084 insertions(+), 4 deletions(-) diff --git a/discovery/beyondcorp-v1.json b/discovery/beyondcorp-v1.json index cdc8e98ebd1..942bc612354 100644 --- a/discovery/beyondcorp-v1.json +++ b/discovery/beyondcorp-v1.json @@ -1804,7 +1804,7 @@ } } }, - "revision": "20240207", + "revision": "20240306", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3015,6 +3015,50 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index d782735e0ce..b3b162618b1 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -3302,6 +3302,197 @@ } } }, + "global": { + "resources": { + "securityGateways": { + "methods": { + "create": { + "description": "Creates a new SecurityGateway in a given project and global location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.global.securityGateways.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id}/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + }, + "securityGatewayId": { + "description": "Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/securityGateways", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single SecurityGateway.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}", + "httpMethod": "DELETE", + "id": "beyondcorp.projects.locations.global.securityGateways.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single SecurityGateway.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.global.securityGateways.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the PartnerTenant using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SecurityGateways in a given project and global location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.global.securityGateways.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName \"test-security-gateway\" For more information, please refer to https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/securityGateways", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single SecurityGateway.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}", + "httpMethod": "PATCH", + "id": "beyondcorp.projects.locations.global.securityGateways.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Mutable fields include: display_name, gateway_regions.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "insights": { "methods": { "configuredInsight": { @@ -3716,7 +3907,7 @@ } } }, - "revision": "20240207", + "revision": "20240228", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5319,7 +5510,7 @@ }, "transportInfo": { "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaTransportInfo", - "description": "Required. Transport layer information to verify for the proxy server." + "description": "Optional. Transport layer information to verify for the proxy server." }, "updateTime": { "description": "Output only. Timestamp when the resource was last modified.", @@ -5815,6 +6006,151 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse": { + "description": "Message for response to listing SecurityGateways.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "securityGateways": { + "description": "A list of BeyondCorp SecurityGateway in the project.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway" + }, + "type": "array" + }, + "unreachable": { + "description": "A list of locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig": { + "description": "Message contains the configuration for each supported region for the securityGateway instance.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig", + "properties": { + "egressIpAddresses": { + "description": "Output only. External IP addresses that will be used for establishing connection to the egress endpoints.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "region": { + "description": "Required. The region where the egress connectivity is required.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway": { + "description": "Information about a BeyoncCorp SecurityGateway resource.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway", + "properties": { + "createTime": { + "description": "Output only. Timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. Name of the resource.", + "type": "string" + }, + "regionConfigs": { + "description": "Optional. List of regions where the egress connectivity is required.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig" + }, + "type": "array" + }, + "state": { + "description": "Output only. The operational state of the SecurityGateway.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "UPDATING", + "DELETING", + "RUNNING", + "DOWN", + "ERROR" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "SecurityGateway is being created.", + "SecurityGateway is being updated.", + "SecurityGateway is being deleted.", + "SecurityGateway is running.", + "SecurityGateway is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF.", + "SecurityGateway encountered an error and is in an indeterministic state." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the resource was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/src/apis/beyondcorp/v1.ts b/src/apis/beyondcorp/v1.ts index f900055564e..c1898ae14f2 100644 --- a/src/apis/beyondcorp/v1.ts +++ b/src/apis/beyondcorp/v1.ts @@ -980,6 +980,39 @@ export namespace beyondcorp_v1 { */ verb?: string | null; } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } /** * The response message for Locations.ListLocations. */ diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 8e3d79e1116..83e36a0693d 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -1255,7 +1255,7 @@ export namespace beyondcorp_v1alpha { */ routingInfo?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaRoutingInfo; /** - * Required. Transport layer information to verify for the proxy server. + * Optional. Transport layer information to verify for the proxy server. */ transportInfo?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaTransportInfo; /** @@ -1570,6 +1570,98 @@ export namespace beyondcorp_v1alpha { */ type?: string | null; } + /** + * Message for response to listing SecurityGateways. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse { + /** + * A token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * A list of BeyondCorp SecurityGateway in the project. + */ + securityGateways?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway[]; + /** + * A list of locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message contains the configuration for each supported region for the securityGateway instance. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig { + /** + * Output only. External IP addresses that will be used for establishing connection to the egress endpoints. + */ + egressIpAddresses?: string[] | null; + /** + * Required. The region where the egress connectivity is required. + */ + region?: string | null; + } + /** + * Information about a BeyoncCorp SecurityGateway resource. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway { + /** + * Output only. Timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. + */ + displayName?: string | null; + /** + * Identifier. Name of the resource. + */ + name?: string | null; + /** + * Optional. List of regions where the egress connectivity is required. + */ + regionConfigs?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaRegionConfig[]; + /** + * Output only. The operational state of the SecurityGateway. + */ + state?: string | null; + /** + * Output only. Timestamp when the resource was last modified. + */ + updateTime?: string | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } /** * The response message for Locations.ListLocations. */ @@ -5778,6 +5870,7 @@ export namespace beyondcorp_v1alpha { clientGateways: Resource$Projects$Locations$Clientgateways; connections: Resource$Projects$Locations$Connections; connectors: Resource$Projects$Locations$Connectors; + global: Resource$Projects$Locations$Global; insights: Resource$Projects$Locations$Insights; netConnections: Resource$Projects$Locations$Netconnections; operations: Resource$Projects$Locations$Operations; @@ -5808,6 +5901,7 @@ export namespace beyondcorp_v1alpha { this.connectors = new Resource$Projects$Locations$Connectors( this.context ); + this.global = new Resource$Projects$Locations$Global(this.context); this.insights = new Resource$Projects$Locations$Insights(this.context); this.netConnections = new Resource$Projects$Locations$Netconnections( this.context @@ -12258,6 +12352,579 @@ export namespace beyondcorp_v1alpha { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } + export class Resource$Projects$Locations$Global { + context: APIRequestContext; + securityGateways: Resource$Projects$Locations$Global$Securitygateways; + constructor(context: APIRequestContext) { + this.context = context; + this.securityGateways = + new Resource$Projects$Locations$Global$Securitygateways(this.context); + } + } + + export class Resource$Projects$Locations$Global$Securitygateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new SecurityGateway in a given project and global location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Securitygateways$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/securityGateways').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Securitygateways$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Securitygateways$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists SecurityGateways in a given project and global location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Global$Securitygateways$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Global$Securitygateways$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Global$Securitygateways$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Global$Securitygateways$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Securitygateways$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/securityGateways').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Securitygateways$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Create + extends StandardParameters { + /** + * Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id\}/locations/global` + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + /** + * Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. + */ + securityGatewayId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; + } + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Delete + extends StandardParameters { + /** + * Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Get + extends StandardParameters { + /** + * Required. The resource name of the PartnerTenant using the form: `projects/{project_id\}/locations/global/securityGateway/{security_gateway_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Global$Securitygateways$List + extends StandardParameters { + /** + * Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160. + */ + filter?: string; + /** + * Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any. + */ + pageToken?: string; + /** + * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/global/` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Patch + extends StandardParameters { + /** + * Identifier. Name of the resource. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Mutable fields include: display_name, gateway_regions. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; + } + export class Resource$Projects$Locations$Insights { context: APIRequestContext; constructor(context: APIRequestContext) { From bb0336c60f51e34284473f3091b6e24290187d55 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 11/78] feat(bigquery): update the API #### bigquery:v2 The following keys were added: - schemas.Dataset.properties.linkedDatasetMetadata.$ref - schemas.Dataset.properties.linkedDatasetMetadata.description - schemas.Dataset.properties.linkedDatasetMetadata.readOnly - schemas.LinkedDatasetMetadata.description - schemas.LinkedDatasetMetadata.id - schemas.LinkedDatasetMetadata.properties.linkState.description - schemas.LinkedDatasetMetadata.properties.linkState.enum - schemas.LinkedDatasetMetadata.properties.linkState.enumDescriptions - schemas.LinkedDatasetMetadata.properties.linkState.readOnly - schemas.LinkedDatasetMetadata.properties.linkState.type - schemas.LinkedDatasetMetadata.type - schemas.PartitionedColumn.description - schemas.PartitionedColumn.id - schemas.PartitionedColumn.properties.field.description - schemas.PartitionedColumn.properties.field.readOnly - schemas.PartitionedColumn.properties.field.type - schemas.PartitionedColumn.type - schemas.PartitioningDefinition.description - schemas.PartitioningDefinition.id - schemas.PartitioningDefinition.properties.partitionedColumn.description - schemas.PartitioningDefinition.properties.partitionedColumn.items.$ref - schemas.PartitioningDefinition.properties.partitionedColumn.readOnly - schemas.PartitioningDefinition.properties.partitionedColumn.type - schemas.PartitioningDefinition.type - schemas.Table.properties.partitionDefinition.$ref - schemas.Table.properties.partitionDefinition.description - schemas.Table.properties.partitionDefinition.readOnly The following keys were changed: - schemas.SparkStatistics.properties.gcsStagingBucket.description - schemas.SparkStatistics.properties.kmsKeyName.description - schemas.TableFieldSchema.properties.rangeElementType.properties.type.description - schemas.TableFieldSchema.properties.type.description --- discovery/bigquery-v2.json | 69 +++++++++++++++++++++++++++++++++++--- src/apis/bigquery/v2.ts | 41 ++++++++++++++++++++-- 2 files changed, 102 insertions(+), 8 deletions(-) diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index 5629fb538e0..b35157faae1 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -1844,7 +1844,7 @@ } } }, - "revision": "20240211", + "revision": "20240229", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -3140,6 +3140,11 @@ "readOnly": true, "type": "string" }, + "linkedDatasetMetadata": { + "$ref": "LinkedDatasetMetadata", + "description": "Output only. Metadata about the LinkedDataset. Filled out when the dataset type is LINKED.", + "readOnly": true + }, "linkedDatasetSource": { "$ref": "LinkedDatasetSource", "description": "Optional. The source dataset reference when the dataset is of type LINKED. For all other dataset types it is not set. This field cannot be updated once it is set. Any attempt to update this field using Update and Patch API Operations will be ignored." @@ -5776,6 +5781,28 @@ "id": "JsonValue", "type": "any" }, + "LinkedDatasetMetadata": { + "description": "Metadata about the Linked Dataset.", + "id": "LinkedDatasetMetadata", + "properties": { + "linkState": { + "description": "Output only. Specifies whether Linked Dataset is currently in a linked state or not.", + "enum": [ + "LINK_STATE_UNSPECIFIED", + "LINKED", + "UNLINKED" + ], + "enumDescriptions": [ + "The default value. Default to the LINKED state.", + "Normal Linked Dataset state. Data is queryable via the Linked Dataset.", + "Data publisher or owner has unlinked this Linked Dataset. It means you can no longer query or see the data in the Linked Dataset." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "LinkedDatasetSource": { "description": "A dataset source type which refers to another BigQuery dataset.", "id": "LinkedDatasetSource", @@ -6407,6 +6434,33 @@ }, "type": "object" }, + "PartitionedColumn": { + "description": "The partitioning column information.", + "id": "PartitionedColumn", + "properties": { + "field": { + "description": "Output only. The name of the partition column.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "PartitioningDefinition": { + "description": "The partitioning information, which includes managed table and external table partition information.", + "id": "PartitioningDefinition", + "properties": { + "partitionedColumn": { + "description": "Output only. Details about each partitioning column. BigQuery native tables only support 1 partitioning column. Other table types may support 0, 1 or more partitioning columns.", + "items": { + "$ref": "PartitionedColumn" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "PerformanceInsights": { "description": "Performance insights for the job.", "id": "PerformanceInsights", @@ -7608,12 +7662,12 @@ "type": "object" }, "gcsStagingBucket": { - "description": "Output only. The Google Cloud Storage bucket that is used as the default filesystem by the Spark application. This fields is only filled when the Spark procedure uses the INVOKER security mode. It is inferred from the system variable @@spark_proc_properties.staging_bucket if it is provided. Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]`", + "description": "Output only. The Google Cloud Storage bucket that is used as the default file system by the Spark application. This field is only filled when the Spark procedure uses the invoker security mode. The `gcsStagingBucket` bucket is inferred from the `@@spark_proc_properties.staging_bucket` system variable (if it is provided). Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]`", "readOnly": true, "type": "string" }, "kmsKeyName": { - "description": "Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses DEFINER security mode, the Cloud KMS key is inferred from the Spark connection associated with the procedure if it is provided. Otherwise the key is inferred from the default key of the Spark connection's project if the CMEK organization policy is enforced. If the Spark procedure uses INVOKER security mode, the Cloud KMS encryption key is inferred from the system variable @@spark_proc_properties.kms_key_name if it is provided. Otherwise, the key is inferred fromt he default key of the BigQuery job's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]`", + "description": "Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses the invoker security mode, the Cloud KMS encryption key is either inferred from the provided system variable, `@@spark_proc_properties.kms_key_name`, or the default key of the BigQuery job's project (if the CMEK organization policy is enforced). Otherwise, the Cloud KMS key is either inferred from the Spark connection associated with the procedure (if it is provided), or from the default key of the Spark connection's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]`", "readOnly": true, "type": "string" }, @@ -8043,6 +8097,11 @@ "readOnly": true, "type": "string" }, + "partitionDefinition": { + "$ref": "PartitioningDefinition", + "description": "Output only. The partition information for all table formats, including managed partitioned tables, hive partitioned tables, and iceberg partitioned tables.", + "readOnly": true + }, "rangePartitioning": { "$ref": "RangePartitioning", "description": "If specified, configures range partitioning for this table." @@ -8370,7 +8429,7 @@ "description": "Represents the type of a field element.", "properties": { "type": { - "description": "Required. The type of a field element. See TableFieldSchema.type.", + "description": "Required. The type of a field element. For more information, see TableFieldSchema.type.", "type": "string" } }, @@ -8396,7 +8455,7 @@ "type": "string" }, "type": { - "description": "Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) Use of RECORD/STRUCT indicates that the field contains a nested schema.", + "description": "Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.", "type": "string" } }, diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index d97fd77e48c..a8cf32b2afb 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -943,6 +943,10 @@ export namespace bigquery_v2 { * Output only. The date when this dataset was last modified, in milliseconds since the epoch. */ lastModifiedTime?: string | null; + /** + * Output only. Metadata about the LinkedDataset. Filled out when the dataset type is LINKED. + */ + linkedDatasetMetadata?: Schema$LinkedDatasetMetadata; /** * Optional. The source dataset reference when the dataset is of type LINKED. For all other dataset types it is not set. This field cannot be updated once it is set. Any attempt to update this field using Update and Patch API Operations will be ignored. */ @@ -2803,6 +2807,15 @@ export namespace bigquery_v2 { encoding?: string | null; } export interface Schema$JsonValue {} + /** + * Metadata about the Linked Dataset. + */ + export interface Schema$LinkedDatasetMetadata { + /** + * Output only. Specifies whether Linked Dataset is currently in a linked state or not. + */ + linkState?: string | null; + } /** * A dataset source type which refers to another BigQuery dataset. */ @@ -3147,6 +3160,24 @@ export namespace bigquery_v2 { */ enumAsString?: boolean | null; } + /** + * The partitioning column information. + */ + export interface Schema$PartitionedColumn { + /** + * Output only. The name of the partition column. + */ + field?: string | null; + } + /** + * The partitioning information, which includes managed table and external table partition information. + */ + export interface Schema$PartitioningDefinition { + /** + * Output only. Details about each partitioning column. BigQuery native tables only support 1 partitioning column. Other table types may support 0, 1 or more partitioning columns. + */ + partitionedColumn?: Schema$PartitionedColumn[]; + } /** * Performance insights for the job. */ @@ -3958,11 +3989,11 @@ export namespace bigquery_v2 { */ endpoints?: {[key: string]: string} | null; /** - * Output only. The Google Cloud Storage bucket that is used as the default filesystem by the Spark application. This fields is only filled when the Spark procedure uses the INVOKER security mode. It is inferred from the system variable @@spark_proc_properties.staging_bucket if it is provided. Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]` + * Output only. The Google Cloud Storage bucket that is used as the default file system by the Spark application. This field is only filled when the Spark procedure uses the invoker security mode. The `gcsStagingBucket` bucket is inferred from the `@@spark_proc_properties.staging_bucket` system variable (if it is provided). Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]` */ gcsStagingBucket?: string | null; /** - * Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses DEFINER security mode, the Cloud KMS key is inferred from the Spark connection associated with the procedure if it is provided. Otherwise the key is inferred from the default key of the Spark connection's project if the CMEK organization policy is enforced. If the Spark procedure uses INVOKER security mode, the Cloud KMS encryption key is inferred from the system variable @@spark_proc_properties.kms_key_name if it is provided. Otherwise, the key is inferred fromt he default key of the BigQuery job's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` + * Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses the invoker security mode, the Cloud KMS encryption key is either inferred from the provided system variable, `@@spark_proc_properties.kms_key_name`, or the default key of the BigQuery job's project (if the CMEK organization policy is enforced). Otherwise, the Cloud KMS key is either inferred from the Spark connection associated with the procedure (if it is provided), or from the default key of the Spark connection's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` */ kmsKeyName?: string | null; /** @@ -4237,6 +4268,10 @@ export namespace bigquery_v2 { * Output only. The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. */ numTotalPhysicalBytes?: string | null; + /** + * Output only. The partition information for all table formats, including managed partitioned tables, hive partitioned tables, and iceberg partitioned tables. + */ + partitionDefinition?: Schema$PartitioningDefinition; /** * If specified, configures range partitioning for this table. */ @@ -4439,7 +4474,7 @@ export namespace bigquery_v2 { */ scale?: string | null; /** - * Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) Use of RECORD/STRUCT indicates that the field contains a nested schema. + * Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. */ type?: string | null; } From f3a175e2cd55c214b2b58c28415135208d599315 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 12/78] fix(bigqueryreservation): update the API #### bigqueryreservation:v1 The following keys were changed: - schemas.Assignment.properties.jobType.enum - schemas.Assignment.properties.jobType.enumDescriptions - schemas.Reservation.properties.concurrency.description --- discovery/bigqueryreservation-v1.json | 10 ++++++---- src/apis/bigqueryreservation/v1.ts | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index 8057bcf5bba..4c73f131ebd 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -851,7 +851,7 @@ } } }, - "revision": "20240217", + "revision": "20240306", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -869,14 +869,16 @@ "PIPELINE", "QUERY", "ML_EXTERNAL", - "BACKGROUND" + "BACKGROUND", + "CONTINUOUS" ], "enumDescriptions": [ "Invalid type. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", "Pipeline (load/export) jobs from the project will use the reservation.", "Query jobs from the project will use the reservation.", "BigQuery ML jobs that use services external to BigQuery for model training. These jobs will not utilize idle slots from other reservations.", - "Background jobs that BigQuery runs for the customers in the background." + "Background jobs that BigQuery runs for the customers in the background.", + "Continuous SQL jobs will use this reservation. Reservations with continuous assignments cannot be mixed with non-continuous assignments." ], "type": "string" }, @@ -1204,7 +1206,7 @@ "description": "The configuration parameters for the auto scaling feature." }, "concurrency": { - "description": "Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as `target_job_concurrency` in the Information Schema, DDL and BQ CLI.", + "description": "Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI.", "format": "int64", "type": "string" }, diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index de31d0153a1..8ddc9d5f73f 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -302,7 +302,7 @@ export namespace bigqueryreservation_v1 { */ autoscale?: Schema$Autoscale; /** - * Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as `target_job_concurrency` in the Information Schema, DDL and BQ CLI. + * Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI. */ concurrency?: string | null; /** From 2ffb49daad06e1919d81694e50315a2d573141be Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 13/78] feat(bigtableadmin): update the API #### bigtableadmin:v2 The following keys were added: - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.flatPath - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.httpMethod - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.id - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameterOrder - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameters.authorizedViewId.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameters.authorizedViewId.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameters.authorizedViewId.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameters.parent.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameters.parent.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameters.parent.pattern - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameters.parent.required - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.parameters.parent.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.path - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.request.$ref - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.response.$ref - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.create.scopes - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.flatPath - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.httpMethod - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.id - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameterOrder - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameters.etag.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameters.etag.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameters.etag.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameters.name.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameters.name.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameters.name.pattern - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameters.name.required - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.parameters.name.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.path - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.response.$ref - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.delete.scopes - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.flatPath - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.httpMethod - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.id - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameterOrder - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.name.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.name.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.name.pattern - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.name.required - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.name.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.view.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.view.enum - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.view.enumDescriptions - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.view.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.parameters.view.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.path - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.response.$ref - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.get.scopes - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.flatPath - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.httpMethod - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.id - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameterOrder - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.pageSize.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.pageSize.format - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.pageSize.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.pageSize.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.pageToken.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.pageToken.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.pageToken.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.parent.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.parent.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.parent.pattern - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.parent.required - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.parent.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.view.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.view.enum - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.view.enumDescriptions - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.view.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.parameters.view.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.path - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.response.$ref - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.list.scopes - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.flatPath - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.httpMethod - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.id - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameterOrder - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.ignoreWarnings.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.ignoreWarnings.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.ignoreWarnings.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.name.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.name.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.name.pattern - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.name.required - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.name.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.updateMask.description - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.updateMask.format - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.updateMask.location - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.parameters.updateMask.type - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.path - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.request.$ref - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.response.$ref - resources.projects.resources.instances.resources.tables.resources.authorizedViews.methods.patch.scopes - schemas.AuthorizedView.description - schemas.AuthorizedView.id - schemas.AuthorizedView.properties.deletionProtection.description - schemas.AuthorizedView.properties.deletionProtection.type - schemas.AuthorizedView.properties.etag.description - schemas.AuthorizedView.properties.etag.type - schemas.AuthorizedView.properties.name.description - schemas.AuthorizedView.properties.name.type - schemas.AuthorizedView.properties.subsetView.$ref - schemas.AuthorizedView.properties.subsetView.description - schemas.AuthorizedView.type - schemas.AutomatedBackupPolicy.description - schemas.AutomatedBackupPolicy.id - schemas.AutomatedBackupPolicy.properties.frequency.description - schemas.AutomatedBackupPolicy.properties.frequency.format - schemas.AutomatedBackupPolicy.properties.frequency.type - schemas.AutomatedBackupPolicy.properties.retentionPeriod.description - schemas.AutomatedBackupPolicy.properties.retentionPeriod.format - schemas.AutomatedBackupPolicy.properties.retentionPeriod.type - schemas.AutomatedBackupPolicy.type - schemas.CreateAuthorizedViewMetadata.description - schemas.CreateAuthorizedViewMetadata.id - schemas.CreateAuthorizedViewMetadata.properties.finishTime.description - schemas.CreateAuthorizedViewMetadata.properties.finishTime.format - schemas.CreateAuthorizedViewMetadata.properties.finishTime.type - schemas.CreateAuthorizedViewMetadata.properties.originalRequest.$ref - schemas.CreateAuthorizedViewMetadata.properties.originalRequest.description - schemas.CreateAuthorizedViewMetadata.properties.requestTime.description - schemas.CreateAuthorizedViewMetadata.properties.requestTime.format - schemas.CreateAuthorizedViewMetadata.properties.requestTime.type - schemas.CreateAuthorizedViewMetadata.type - schemas.CreateAuthorizedViewRequest.description - schemas.CreateAuthorizedViewRequest.id - schemas.CreateAuthorizedViewRequest.properties.authorizedView.$ref - schemas.CreateAuthorizedViewRequest.properties.authorizedView.description - schemas.CreateAuthorizedViewRequest.properties.authorizedViewId.description - schemas.CreateAuthorizedViewRequest.properties.authorizedViewId.type - schemas.CreateAuthorizedViewRequest.properties.parent.description - schemas.CreateAuthorizedViewRequest.properties.parent.type - schemas.CreateAuthorizedViewRequest.type - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.description - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.id - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.properties.qualifierPrefixes.description - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.properties.qualifierPrefixes.items.format - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.properties.qualifierPrefixes.items.type - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.properties.qualifierPrefixes.type - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.properties.qualifiers.description - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.properties.qualifiers.items.format - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.properties.qualifiers.items.type - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.properties.qualifiers.type - schemas.GoogleBigtableAdminV2AuthorizedViewFamilySubsets.type - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.description - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.id - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.properties.familySubsets.additionalProperties.$ref - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.properties.familySubsets.description - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.properties.familySubsets.type - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.properties.rowPrefixes.description - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.properties.rowPrefixes.items.format - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.properties.rowPrefixes.items.type - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.properties.rowPrefixes.type - schemas.GoogleBigtableAdminV2AuthorizedViewSubsetView.type - schemas.ListAuthorizedViewsResponse.description - schemas.ListAuthorizedViewsResponse.id - schemas.ListAuthorizedViewsResponse.properties.authorizedViews.description - schemas.ListAuthorizedViewsResponse.properties.authorizedViews.items.$ref - schemas.ListAuthorizedViewsResponse.properties.authorizedViews.type - schemas.ListAuthorizedViewsResponse.properties.nextPageToken.description - schemas.ListAuthorizedViewsResponse.properties.nextPageToken.type - schemas.ListAuthorizedViewsResponse.type - schemas.Modification.properties.updateMask.description - schemas.Modification.properties.updateMask.format - schemas.Modification.properties.updateMask.type - schemas.Table.properties.automatedBackupPolicy.$ref - schemas.Table.properties.automatedBackupPolicy.description - schemas.UpdateAuthorizedViewMetadata.description - schemas.UpdateAuthorizedViewMetadata.id - schemas.UpdateAuthorizedViewMetadata.properties.finishTime.description - schemas.UpdateAuthorizedViewMetadata.properties.finishTime.format - schemas.UpdateAuthorizedViewMetadata.properties.finishTime.type - schemas.UpdateAuthorizedViewMetadata.properties.originalRequest.$ref - schemas.UpdateAuthorizedViewMetadata.properties.originalRequest.description - schemas.UpdateAuthorizedViewMetadata.properties.requestTime.description - schemas.UpdateAuthorizedViewMetadata.properties.requestTime.format - schemas.UpdateAuthorizedViewMetadata.properties.requestTime.type - schemas.UpdateAuthorizedViewMetadata.type - schemas.UpdateAuthorizedViewRequest.description - schemas.UpdateAuthorizedViewRequest.id - schemas.UpdateAuthorizedViewRequest.properties.authorizedView.$ref - schemas.UpdateAuthorizedViewRequest.properties.authorizedView.description - schemas.UpdateAuthorizedViewRequest.properties.ignoreWarnings.description - schemas.UpdateAuthorizedViewRequest.properties.ignoreWarnings.type - schemas.UpdateAuthorizedViewRequest.properties.updateMask.description - schemas.UpdateAuthorizedViewRequest.properties.updateMask.format - schemas.UpdateAuthorizedViewRequest.properties.updateMask.type - schemas.UpdateAuthorizedViewRequest.type --- discovery/bigtableadmin-v2.json | 418 +++++++++++++++++++- src/apis/bigtableadmin/v2.ts | 682 ++++++++++++++++++++++++++++++++ 2 files changed, 1099 insertions(+), 1 deletion(-) diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index fa50f9c8eba..5567bdee07b 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -1817,6 +1817,229 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "authorizedViews": { + "methods": { + "create": { + "description": "Creates a new AuthorizedView in a table.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.tables.authorizedViews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "authorizedViewId": { + "description": "Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/authorizedViews", + "request": { + "$ref": "AuthorizedView" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Permanently deletes a specified AuthorizedView.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}", + "httpMethod": "DELETE", + "id": "bigtableadmin.projects.instances.tables.authorizedViews.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The current etag of the AuthorizedView. If an etag is provided and does not match the current etag of the AuthorizedView, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The unique name of the AuthorizedView to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information from a specified AuthorizedView.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}", + "httpMethod": "GET", + "id": "bigtableadmin.projects.instances.tables.authorizedViews.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique name of the requested AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The resource_view to be applied to the returned AuthorizedView's fields. Default to BASIC.", + "enum": [ + "RESPONSE_VIEW_UNSPECIFIED", + "NAME_ONLY", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "Uses the default view for each method as documented in the request.", + "Only populates `name`.", + "Only populates the AuthorizedView's basic metadata. This includes: name, deletion_protection, etag.", + "Populates every fields." + ], + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "AuthorizedView" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all AuthorizedViews from a specific table.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews", + "httpMethod": "GET", + "id": "bigtableadmin.projects.instances.tables.authorizedViews.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value of `next_page_token` returned by a previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The resource_view to be applied to the returned views' fields. Default to NAME_ONLY.", + "enum": [ + "RESPONSE_VIEW_UNSPECIFIED", + "NAME_ONLY", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "Uses the default view for each method as documented in the request.", + "Only populates `name`.", + "Only populates the AuthorizedView's basic metadata. This includes: name, deletion_protection, etag.", + "Populates every fields." + ], + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/authorizedViews", + "response": { + "$ref": "ListAuthorizedViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an AuthorizedView in a table.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}", + "httpMethod": "PATCH", + "id": "bigtableadmin.projects.instances.tables.authorizedViews.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "ignoreWarnings": { + "description": "Optional. If true, ignore the safety checks when updating the AuthorizedView.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value `*` means to overwrite all fields (including fields not set in the request).", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "AuthorizedView" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.table", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } } } @@ -1875,7 +2098,7 @@ } } }, - "revision": "20240221", + "revision": "20240306", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -1974,6 +2197,46 @@ }, "type": "object" }, + "AuthorizedView": { + "description": "Placeholder for admin API work while we work out the internals.", + "id": "AuthorizedView", + "properties": { + "deletionProtection": { + "description": "Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set.", + "type": "boolean" + }, + "etag": { + "description": "The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag.", + "type": "string" + }, + "name": { + "description": "Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`", + "type": "string" + }, + "subsetView": { + "$ref": "GoogleBigtableAdminV2AuthorizedViewSubsetView", + "description": "An AuthorizedView permitting access to an explicit subset of a Table." + } + }, + "type": "object" + }, + "AutomatedBackupPolicy": { + "description": "Defines an automated backup policy for a table", + "id": "AutomatedBackupPolicy", + "properties": { + "frequency": { + "description": "Required. How frequently automated backups should occur. The only supported value at this time is 24 hours.", + "format": "google-duration", + "type": "string" + }, + "retentionPeriod": { + "description": "Required. How long the automated backups should be retained. The only supported value at this time is 3 days.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "AutoscalingLimits": { "description": "Limits for the number of nodes a Cluster can autoscale up/down to.", "id": "AutoscalingLimits", @@ -2361,6 +2624,46 @@ }, "type": "object" }, + "CreateAuthorizedViewMetadata": { + "description": "The metadata for the Operation returned by CreateAuthorizedView.", + "id": "CreateAuthorizedViewMetadata", + "properties": { + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", + "format": "google-datetime", + "type": "string" + }, + "originalRequest": { + "$ref": "CreateAuthorizedViewRequest", + "description": "The request that prompted the initiation of this CreateInstance operation." + }, + "requestTime": { + "description": "The time at which the original request was received.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "CreateAuthorizedViewRequest": { + "description": "The request for CreateAuthorizedView", + "id": "CreateAuthorizedViewRequest", + "properties": { + "authorizedView": { + "$ref": "AuthorizedView", + "description": "Required. The AuthorizedView to create." + }, + "authorizedViewId": { + "description": "Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}`.", + "type": "string" + }, + "parent": { + "description": "Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.", + "type": "string" + } + }, + "type": "object" + }, "CreateBackupMetadata": { "description": "Metadata type for the operation returned by CreateBackup.", "id": "CreateBackupMetadata", @@ -2655,6 +2958,51 @@ }, "type": "object" }, + "GoogleBigtableAdminV2AuthorizedViewFamilySubsets": { + "description": "Subsets of a column family that are included in this AuthorizedView.", + "id": "GoogleBigtableAdminV2AuthorizedViewFamilySubsets", + "properties": { + "qualifierPrefixes": { + "description": "Prefixes for qualifiers to be included in the AuthorizedView. Every qualifier starting with one of these prefixes is included in the AuthorizedView. To provide access to all qualifiers, include the empty string as a prefix (\"\").", + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "qualifiers": { + "description": "Individual exact column qualifiers to be included in the AuthorizedView.", + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2AuthorizedViewSubsetView": { + "description": "Defines a simple AuthorizedView that is a subset of the underlying Table.", + "id": "GoogleBigtableAdminV2AuthorizedViewSubsetView", + "properties": { + "familySubsets": { + "additionalProperties": { + "$ref": "GoogleBigtableAdminV2AuthorizedViewFamilySubsets" + }, + "description": "Map from column family name to the columns in this family to be included in the AuthorizedView.", + "type": "object" + }, + "rowPrefixes": { + "description": "Row prefixes to be included in the AuthorizedView. To provide access to all rows, include the empty string as a prefix (\"\").", + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "HotTablet": { "description": "A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.", "id": "HotTablet", @@ -2797,6 +3145,24 @@ }, "type": "object" }, + "ListAuthorizedViewsResponse": { + "description": "Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews", + "id": "ListAuthorizedViewsResponse", + "properties": { + "authorizedViews": { + "description": "The AuthorizedViews present in the requested table.", + "items": { + "$ref": "AuthorizedView" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.", + "type": "string" + } + }, + "type": "object" + }, "ListBackupsResponse": { "description": "The response for ListBackups.", "id": "ListBackupsResponse", @@ -2990,6 +3356,11 @@ "update": { "$ref": "ColumnFamily", "description": "Update an existing column family to the specified schema, or fail if no column family exists with the given ID." + }, + "updateMask": { + "description": "Optional. A mask specifying which fields (e.g. `gc_rule`) in the `update` mod should be updated, ignored for other modification types. If unset or empty, we treat it as updating `gc_rule` to be backward compatible.", + "format": "google-fieldmask", + "type": "string" } }, "type": "object" @@ -3351,6 +3722,10 @@ "description": "A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.", "id": "Table", "properties": { + "automatedBackupPolicy": { + "$ref": "AutomatedBackupPolicy", + "description": "If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled." + }, "changeStreamConfig": { "$ref": "ChangeStreamConfig", "description": "If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained." @@ -3539,6 +3914,47 @@ "properties": {}, "type": "object" }, + "UpdateAuthorizedViewMetadata": { + "description": "Metadata for the google.longrunning.Operation returned by UpdateAuthorizedView.", + "id": "UpdateAuthorizedViewMetadata", + "properties": { + "finishTime": { + "description": "The time at which the operation failed or was completed successfully.", + "format": "google-datetime", + "type": "string" + }, + "originalRequest": { + "$ref": "UpdateAuthorizedViewRequest", + "description": "The request that prompted the initiation of this UpdateAuthorizedView operation." + }, + "requestTime": { + "description": "The time at which the original request was received.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "UpdateAuthorizedViewRequest": { + "description": "The request for UpdateAuthorizedView.", + "id": "UpdateAuthorizedViewRequest", + "properties": { + "authorizedView": { + "$ref": "AuthorizedView", + "description": "Required. The AuthorizedView to update. The `name` in `authorized_view` is used to identify the AuthorizedView. AuthorizedView name must in this format projects//instances//tables//authorizedViews/" + }, + "ignoreWarnings": { + "description": "Optional. If true, ignore the safety checks when updating the AuthorizedView.", + "type": "boolean" + }, + "updateMask": { + "description": "Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value `*` means to overwrite all fields (including fields not set in the request).", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "UpdateClusterMetadata": { "description": "The metadata for the Operation returned by UpdateCluster.", "id": "UpdateClusterMetadata", diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 5c138cf06e7..0c2667962eb 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -185,6 +185,40 @@ export namespace bigtableadmin_v2 { */ logType?: string | null; } + /** + * Placeholder for admin API work while we work out the internals. + */ + export interface Schema$AuthorizedView { + /** + * Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set. + */ + deletionProtection?: boolean | null; + /** + * The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag. + */ + etag?: string | null; + /** + * Identifier. The name of this AuthorizedView. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}/authorizedViews/{authorized_view\}` + */ + name?: string | null; + /** + * An AuthorizedView permitting access to an explicit subset of a Table. + */ + subsetView?: Schema$GoogleBigtableAdminV2AuthorizedViewSubsetView; + } + /** + * Defines an automated backup policy for a table + */ + export interface Schema$AutomatedBackupPolicy { + /** + * Required. How frequently automated backups should occur. The only supported value at this time is 24 hours. + */ + frequency?: string | null; + /** + * Required. How long the automated backups should be retained. The only supported value at this time is 3 days. + */ + retentionPeriod?: string | null; + } /** * Limits for the number of nodes a Cluster can autoscale up/down to. */ @@ -453,6 +487,40 @@ export namespace bigtableadmin_v2 { */ sourceBackup?: string | null; } + /** + * The metadata for the Operation returned by CreateAuthorizedView. + */ + export interface Schema$CreateAuthorizedViewMetadata { + /** + * The time at which the operation failed or was completed successfully. + */ + finishTime?: string | null; + /** + * The request that prompted the initiation of this CreateInstance operation. + */ + originalRequest?: Schema$CreateAuthorizedViewRequest; + /** + * The time at which the original request was received. + */ + requestTime?: string | null; + } + /** + * The request for CreateAuthorizedView + */ + export interface Schema$CreateAuthorizedViewRequest { + /** + * Required. The AuthorizedView to create. + */ + authorizedView?: Schema$AuthorizedView; + /** + * Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project\}/instances/{instance\}/tables/{table\}/authorizedView/{authorized_view\}`. + */ + authorizedViewId?: string | null; + /** + * Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}`. + */ + parent?: string | null; + } /** * Metadata type for the operation returned by CreateBackup. */ @@ -683,6 +751,34 @@ export namespace bigtableadmin_v2 { */ requestedPolicyVersion?: number | null; } + /** + * Subsets of a column family that are included in this AuthorizedView. + */ + export interface Schema$GoogleBigtableAdminV2AuthorizedViewFamilySubsets { + /** + * Prefixes for qualifiers to be included in the AuthorizedView. Every qualifier starting with one of these prefixes is included in the AuthorizedView. To provide access to all qualifiers, include the empty string as a prefix (""). + */ + qualifierPrefixes?: string[] | null; + /** + * Individual exact column qualifiers to be included in the AuthorizedView. + */ + qualifiers?: string[] | null; + } + /** + * Defines a simple AuthorizedView that is a subset of the underlying Table. + */ + export interface Schema$GoogleBigtableAdminV2AuthorizedViewSubsetView { + /** + * Map from column family name to the columns in this family to be included in the AuthorizedView. + */ + familySubsets?: { + [key: string]: Schema$GoogleBigtableAdminV2AuthorizedViewFamilySubsets; + } | null; + /** + * Row prefixes to be included in the AuthorizedView. To provide access to all rows, include the empty string as a prefix (""). + */ + rowPrefixes?: string[] | null; + } /** * A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time. */ @@ -775,6 +871,19 @@ export namespace bigtableadmin_v2 { */ nextPageToken?: string | null; } + /** + * Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews + */ + export interface Schema$ListAuthorizedViewsResponse { + /** + * The AuthorizedViews present in the requested table. + */ + authorizedViews?: Schema$AuthorizedView[]; + /** + * Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results. + */ + nextPageToken?: string | null; + } /** * The response for ListBackups. */ @@ -919,6 +1028,10 @@ export namespace bigtableadmin_v2 { * Update an existing column family to the specified schema, or fail if no column family exists with the given ID. */ update?: Schema$ColumnFamily; + /** + * Optional. A mask specifying which fields (e.g. `gc_rule`) in the `update` mod should be updated, ignored for other modification types. If unset or empty, we treat it as updating `gc_rule` to be backward compatible. + */ + updateMask?: string | null; } /** * Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies @@ -1174,6 +1287,10 @@ export namespace bigtableadmin_v2 { * A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. */ export interface Schema$Table { + /** + * If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. + */ + automatedBackupPolicy?: Schema$AutomatedBackupPolicy; /** * If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. */ @@ -1294,6 +1411,40 @@ export namespace bigtableadmin_v2 { * The metadata for the Operation returned by UpdateAppProfile. */ export interface Schema$UpdateAppProfileMetadata {} + /** + * Metadata for the google.longrunning.Operation returned by UpdateAuthorizedView. + */ + export interface Schema$UpdateAuthorizedViewMetadata { + /** + * The time at which the operation failed or was completed successfully. + */ + finishTime?: string | null; + /** + * The request that prompted the initiation of this UpdateAuthorizedView operation. + */ + originalRequest?: Schema$UpdateAuthorizedViewRequest; + /** + * The time at which the original request was received. + */ + requestTime?: string | null; + } + /** + * The request for UpdateAuthorizedView. + */ + export interface Schema$UpdateAuthorizedViewRequest { + /** + * Required. The AuthorizedView to update. The `name` in `authorized_view` is used to identify the AuthorizedView. AuthorizedView name must in this format projects//instances//tables//authorizedViews/ + */ + authorizedView?: Schema$AuthorizedView; + /** + * Optional. If true, ignore the safety checks when updating the AuthorizedView. + */ + ignoreWarnings?: boolean | null; + /** + * Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value `*` means to overwrite all fields (including fields not set in the request). + */ + updateMask?: string | null; + } /** * The metadata for the Operation returned by UpdateCluster. */ @@ -4676,8 +4827,11 @@ export namespace bigtableadmin_v2 { export class Resource$Projects$Instances$Tables { context: APIRequestContext; + authorizedViews: Resource$Projects$Instances$Tables$Authorizedviews; constructor(context: APIRequestContext) { this.context = context; + this.authorizedViews = + new Resource$Projects$Instances$Tables$Authorizedviews(this.context); } /** @@ -6108,6 +6262,534 @@ export namespace bigtableadmin_v2 { requestBody?: Schema$UndeleteTableRequest; } + export class Resource$Projects$Instances$Tables$Authorizedviews { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new AuthorizedView in a table. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Instances$Tables$Authorizedviews$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Tables$Authorizedviews$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Tables$Authorizedviews$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Tables$Authorizedviews$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/authorizedViews').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Permanently deletes a specified AuthorizedView. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information from a specified AuthorizedView. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Instances$Tables$Authorizedviews$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Tables$Authorizedviews$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Tables$Authorizedviews$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Tables$Authorizedviews$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all AuthorizedViews from a specific table. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Instances$Tables$Authorizedviews$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Tables$Authorizedviews$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Tables$Authorizedviews$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Tables$Authorizedviews$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/authorizedViews').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an AuthorizedView in a table. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Instances$Tables$Authorizedviews$Create + extends StandardParameters { + /** + * Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project\}/instances/{instance\}/tables/{table\}/authorizedView/{authorized_view\}`. + */ + authorizedViewId?: string; + /** + * Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AuthorizedView; + } + export interface Params$Resource$Projects$Instances$Tables$Authorizedviews$Delete + extends StandardParameters { + /** + * Optional. The current etag of the AuthorizedView. If an etag is provided and does not match the current etag of the AuthorizedView, deletion will be blocked and an ABORTED error will be returned. + */ + etag?: string; + /** + * Required. The unique name of the AuthorizedView to be deleted. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}/authorizedViews/{authorized_view\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Tables$Authorizedviews$Get + extends StandardParameters { + /** + * Required. The unique name of the requested AuthorizedView. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}/authorizedViews/{authorized_view\}`. + */ + name?: string; + /** + * Optional. The resource_view to be applied to the returned AuthorizedView's fields. Default to BASIC. + */ + view?: string; + } + export interface Params$Resource$Projects$Instances$Tables$Authorizedviews$List + extends StandardParameters { + /** + * Optional. Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. + */ + pageSize?: number; + /** + * Optional. The value of `next_page_token` returned by a previous call. + */ + pageToken?: string; + /** + * Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}`. + */ + parent?: string; + /** + * Optional. The resource_view to be applied to the returned views' fields. Default to NAME_ONLY. + */ + view?: string; + } + export interface Params$Resource$Projects$Instances$Tables$Authorizedviews$Patch + extends StandardParameters { + /** + * Optional. If true, ignore the safety checks when updating the AuthorizedView. + */ + ignoreWarnings?: boolean; + /** + * Identifier. The name of this AuthorizedView. Values are of the form `projects/{project\}/instances/{instance\}/tables/{table\}/authorizedViews/{authorized_view\}` + */ + name?: string; + /** + * Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value `*` means to overwrite all fields (including fields not set in the request). + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AuthorizedView; + } + export class Resource$Projects$Locations { context: APIRequestContext; constructor(context: APIRequestContext) { From 2ac1b12dc6b8d84f33ce94eebf545161a58fa9fd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 14/78] feat(chat): update the API #### chat:v1 The following keys were added: - schemas.Annotation.properties.richLinkMetadata.$ref - schemas.Annotation.properties.richLinkMetadata.description - schemas.DriveLinkData.description - schemas.DriveLinkData.id - schemas.DriveLinkData.properties.driveDataRef.$ref - schemas.DriveLinkData.properties.driveDataRef.description - schemas.DriveLinkData.properties.mimeType.description - schemas.DriveLinkData.properties.mimeType.type - schemas.DriveLinkData.type - schemas.RichLinkMetadata.description - schemas.RichLinkMetadata.id - schemas.RichLinkMetadata.properties.driveLinkData.$ref - schemas.RichLinkMetadata.properties.driveLinkData.description - schemas.RichLinkMetadata.properties.richLinkType.description - schemas.RichLinkMetadata.properties.richLinkType.enum - schemas.RichLinkMetadata.properties.richLinkType.enumDescriptions - schemas.RichLinkMetadata.properties.richLinkType.type - schemas.RichLinkMetadata.properties.uri.description - schemas.RichLinkMetadata.properties.uri.type - schemas.RichLinkMetadata.type The following keys were changed: - resources.spaces.methods.list.parameters.pageSize.description - resources.spaces.resources.members.methods.list.parameters.pageSize.description - resources.spaces.resources.messages.methods.list.parameters.pageSize.description - schemas.Annotation.properties.type.enum - schemas.Annotation.properties.type.enumDescriptions - schemas.ChatClientDataSourceMarkup.description - schemas.CommonEventObject.properties.hostApp.enum - schemas.CommonEventObject.properties.hostApp.enumDescriptions - schemas.GoogleAppsCardV1Action.properties.interaction.description - schemas.GoogleAppsCardV1Action.properties.interaction.enumDescriptions - schemas.GoogleAppsCardV1Card.description - schemas.GoogleAppsCardV1Column.description - schemas.GoogleAppsCardV1Column.properties.horizontalSizeStyle.description - schemas.GoogleAppsCardV1Column.properties.verticalAlignment.description - schemas.GoogleAppsCardV1Columns.description - schemas.GoogleAppsCardV1PlatformDataSource.description - schemas.GoogleAppsCardV1SelectionInput.properties.type.enumDescriptions - schemas.GoogleAppsCardV1TextInput.properties.placeholderText.description - schemas.GoogleAppsCardV1Widgets.description - schemas.HostAppDataSourceMarkup.description - schemas.Message.properties.formattedText.description - schemas.SpaceDataSource.description --- discovery/chat-v1.json | 96 +++++++++++++++++++++++++++++++----------- src/apis/chat/v1.ts | 66 ++++++++++++++++++++++------- 2 files changed, 121 insertions(+), 41 deletions(-) diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index b437e2174f7..453a8f21ad1 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -371,7 +371,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", + "description": "Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.", "format": "int32", "location": "query", "type": "integer" @@ -549,7 +549,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", + "description": "Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.", "format": "int32", "location": "query", "type": "integer" @@ -733,7 +733,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", + "description": "The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.", "format": "int32", "location": "query", "type": "integer" @@ -990,7 +990,7 @@ } } }, - "revision": "20240222", + "revision": "20240310", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -1111,6 +1111,10 @@ "format": "int32", "type": "integer" }, + "richLinkMetadata": { + "$ref": "RichLinkMetadata", + "description": "The metadata for a rich link." + }, "slashCommand": { "$ref": "SlashCommandMetadata", "description": "The metadata for a slash command." @@ -1125,12 +1129,14 @@ "enum": [ "ANNOTATION_TYPE_UNSPECIFIED", "USER_MENTION", - "SLASH_COMMAND" + "SLASH_COMMAND", + "RICH_LINK" ], "enumDescriptions": [ "Default value for the enum. Don't use.", "A user is mentioned.", - "A slash command is invoked." + "A slash command is invoked.", + "A rich link annotation." ], "type": "string" }, @@ -1348,7 +1354,7 @@ "type": "object" }, "ChatClientDataSourceMarkup": { - "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/chat):", + "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "ChatClientDataSourceMarkup", "properties": { "spaceDataSource": { @@ -1409,8 +1415,7 @@ "SHEETS", "SLIDES", "DRAWINGS", - "CHAT", - "CHAT_IN_GMAIL" + "CHAT" ], "enumDescriptions": [ "Google can't identify a host app.", @@ -1423,8 +1428,7 @@ "The add-on launches from Google Sheets.", "The add-on launches from Google Slides.", "The add-on launches from Google Drawings.", - "A Google Chat app. Not used for Google Workspace Add-ons.", - "The add-on or appfinder widget launches from Chat-in-Gmail" + "A Google Chat app. Not used for Google Workspace Add-ons." ], "type": "string" }, @@ -1675,6 +1679,21 @@ }, "type": "object" }, + "DriveLinkData": { + "description": "Data for Google Drive links.", + "id": "DriveLinkData", + "properties": { + "driveDataRef": { + "$ref": "DriveDataRef", + "description": "A [DriveDataRef](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file." + }, + "mimeType": { + "description": "The mime type of the linked Google Drive resource.", + "type": "string" + } + }, + "type": "object" + }, "Emoji": { "description": "An emoji that is used as a reaction to a message.", "id": "Emoji", @@ -1740,14 +1759,14 @@ "type": "string" }, "interaction": { - "description": "Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/chat/how-tos/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/chat):", + "description": "Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/chat/how-tos/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):", "enum": [ "INTERACTION_UNSPECIFIED", "OPEN_DIALOG" ], "enumDescriptions": [ "Default value. The `action` executes as normal.", - "Opens a [dialog](https://developers.google.com/chat/how-tos/dialogs), a windowed, card-based interface that Chat apps use to interact with users. Only supported by Chat apps in response to button-clicks on card messages. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/chat):" + "Opens a [dialog](https://developers.google.com/chat/how-tos/dialogs), a windowed, card-based interface that Chat apps use to interact with users. Only supported by Chat apps in response to button-clicks on card messages. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):" ], "type": "string" }, @@ -1868,7 +1887,7 @@ "type": "object" }, "GoogleAppsCardV1Card": { - "description": "A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui). * For Google Workspace Add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\", }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\", }, \"text\": \"sasha@example.com\", } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\", }, \"text\": \"Online\", }, }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\", }, \"text\": \"+1 (555) 555-1234\", } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\", } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\", } ], } } }, ], } }, ], }, ], }, } ], } ```", + "description": "A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui). * For Google Workspace Add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```", "id": "GoogleAppsCardV1Card", "properties": { "cardActions": { @@ -1998,7 +2017,7 @@ "type": "object" }, "GoogleAppsCardV1Column": { - "description": "A column. [Google Chat apps](https://developers.google.com/chat):", + "description": "A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.", "id": "GoogleAppsCardV1Column", "properties": { "horizontalAlignment": { @@ -2018,7 +2037,7 @@ "type": "string" }, "horizontalSizeStyle": { - "description": "Specifies how a column fills the width of the card. [Google Chat apps](https://developers.google.com/chat):", + "description": "Specifies how a column fills the width of the card.", "enum": [ "HORIZONTAL_SIZE_STYLE_UNSPECIFIED", "FILL_AVAILABLE_SPACE", @@ -2032,7 +2051,7 @@ "type": "string" }, "verticalAlignment": { - "description": "Specifies whether widgets align to the top, bottom, or center of a column. [Google Chat apps](https://developers.google.com/chat):", + "description": "Specifies whether widgets align to the top, bottom, or center of a column.", "enum": [ "VERTICAL_ALIGNMENT_UNSPECIFIED", "CENTER", @@ -2058,7 +2077,7 @@ "type": "object" }, "GoogleAppsCardV1Columns": { - "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Columns](https://developers.google.com/chat/ui/widgets/columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in [Developer Preview](https://developers.google.com/workspace/preview).", + "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Columns](https://developers.google.com/chat/ui/widgets/columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.", "id": "GoogleAppsCardV1Columns", "properties": { "columnItems": { @@ -2398,7 +2417,7 @@ "type": "object" }, "GoogleAppsCardV1PlatformDataSource": { - "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/chat):", + "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "GoogleAppsCardV1PlatformDataSource", "properties": { "commonDataSource": { @@ -2502,7 +2521,7 @@ "A set of radio buttons. Users can select one radio button.", "A set of switches. Users can turn on one or more switches.", "A dropdown menu. Users can select one item from the menu.", - "A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multiselect menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus, see the [`SelectionInput` widget page](https://developers.google.com/chat/ui/widgets/selection-input#multiselect-menu). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): multiselect for Google Workspace Add-ons are in [Developer Preview](https://developers.google.com/workspace/preview)." + "A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multiselect menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus, see the [`SelectionInput` widget page](https://developers.google.com/chat/ui/widgets/selection-input#multiselect-menu). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Multiselect for Google Workspace Add-ons are in Developer Preview." ], "type": "string" } @@ -2627,7 +2646,7 @@ "description": "What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/chat/how-tos/dialogs) in Google Chat." }, "placeholderText": { - "description": "Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/chat):", + "description": "Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):", "type": "string" }, "type": { @@ -2724,7 +2743,7 @@ "type": "object" }, "GoogleAppsCardV1Widgets": { - "description": "The supported widgets that you can include in a column. [Google Chat apps](https://developers.google.com/chat):", + "description": "The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.", "id": "GoogleAppsCardV1Widgets", "properties": { "buttonList": { @@ -2770,7 +2789,7 @@ "type": "object" }, "HostAppDataSourceMarkup": { - "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/chat):", + "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "HostAppDataSourceMarkup", "properties": { "chatDataSource": { @@ -3252,7 +3271,7 @@ "type": "string" }, "formattedText": { - "description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, and monospace block. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message)", + "description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message)", "readOnly": true, "type": "string" }, @@ -3374,6 +3393,33 @@ }, "type": "object" }, + "RichLinkMetadata": { + "description": "A rich link to a resource.", + "id": "RichLinkMetadata", + "properties": { + "driveLinkData": { + "$ref": "DriveLinkData", + "description": "Data for a drive link." + }, + "richLinkType": { + "description": "The rich link type.", + "enum": [ + "RICH_LINK_TYPE_UNSPECIFIED", + "DRIVE_FILE" + ], + "enumDescriptions": [ + "Default value for the enum. Don't use.", + "A Google Drive rich link type." + ], + "type": "string" + }, + "uri": { + "description": "The URI of this link.", + "type": "string" + } + }, + "type": "object" + }, "Section": { "description": "A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).", "id": "Section", @@ -3588,7 +3634,7 @@ "type": "object" }, "SpaceDataSource": { - "description": "A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/chat):", + "description": "A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "SpaceDataSource", "properties": { "defaultToCurrentSpace": { diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 92a2ac1e908..a8dea9d904a 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -181,6 +181,10 @@ export namespace chat_v1 { * Length of the substring in the plain-text message body this annotation corresponds to. */ length?: number | null; + /** + * The metadata for a rich link. + */ + richLinkMetadata?: Schema$RichLinkMetadata; /** * The metadata for a slash command. */ @@ -350,7 +354,7 @@ export namespace chat_v1 { error?: Schema$Status; } /** - * For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/chat): + * For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): */ export interface Schema$ChatClientDataSourceMarkup { /** @@ -550,6 +554,19 @@ export namespace chat_v1 { */ driveFileId?: string | null; } + /** + * Data for Google Drive links. + */ + export interface Schema$DriveLinkData { + /** + * A [DriveDataRef](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. + */ + driveDataRef?: Schema$DriveDataRef; + /** + * The mime type of the linked Google Drive resource. + */ + mimeType?: string | null; + } /** * An emoji that is used as a reaction to a message. */ @@ -602,7 +619,7 @@ export namespace chat_v1 { */ function?: string | null; /** - * Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/chat/how-tos/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/chat): + * Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/chat/how-tos/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat): */ interaction?: string | null; /** @@ -687,7 +704,7 @@ export namespace chat_v1 { buttons?: Schema$GoogleAppsCardV1Button[]; } /** - * A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui). * For Google Workspace Add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", \}, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL", \}, "text": "sasha@example.com", \} \}, { "decoratedText": { "startIcon": { "knownIcon": "PERSON", \}, "text": "Online", \}, \}, { "decoratedText": { "startIcon": { "knownIcon": "PHONE", \}, "text": "+1 (555) 555-1234", \} \}, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share", \} \} \}, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT", \} ], \} \} \}, ], \} \}, ], \}, ], \}, \} ], \} ``` + * A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui). * For Google Workspace Add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" \}, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" \}, "text": "sasha@example.com" \} \}, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" \}, "text": "Online" \} \}, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" \}, "text": "+1 (555) 555-1234" \} \}, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" \} \} \}, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" \} ] \} \} \} ] \} \} ] \} ] \} \} ] \} ``` */ export interface Schema$GoogleAppsCardV1Card { /** @@ -775,7 +792,7 @@ export namespace chat_v1 { title?: string | null; } /** - * A column. [Google Chat apps](https://developers.google.com/chat): + * A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview. */ export interface Schema$GoogleAppsCardV1Column { /** @@ -783,11 +800,11 @@ export namespace chat_v1 { */ horizontalAlignment?: string | null; /** - * Specifies how a column fills the width of the card. [Google Chat apps](https://developers.google.com/chat): + * Specifies how a column fills the width of the card. */ horizontalSizeStyle?: string | null; /** - * Specifies whether widgets align to the top, bottom, or center of a column. [Google Chat apps](https://developers.google.com/chat): + * Specifies whether widgets align to the top, bottom, or center of a column. */ verticalAlignment?: string | null; /** @@ -796,7 +813,7 @@ export namespace chat_v1 { widgets?: Schema$GoogleAppsCardV1Widgets[]; } /** - * The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Columns](https://developers.google.com/chat/ui/widgets/columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in [Developer Preview](https://developers.google.com/workspace/preview). + * The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Columns](https://developers.google.com/chat/ui/widgets/columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview. */ export interface Schema$GoogleAppsCardV1Columns { /** @@ -1043,7 +1060,7 @@ export namespace chat_v1 { url?: string | null; } /** - * For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/chat): + * For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): */ export interface Schema$GoogleAppsCardV1PlatformDataSource { /** @@ -1214,7 +1231,7 @@ export namespace chat_v1 { */ onChangeAction?: Schema$GoogleAppsCardV1Action; /** - * Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/chat): + * Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat): */ placeholderText?: string | null; /** @@ -1285,7 +1302,7 @@ export namespace chat_v1 { textParagraph?: Schema$GoogleAppsCardV1TextParagraph; } /** - * The supported widgets that you can include in a column. [Google Chat apps](https://developers.google.com/chat): + * The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview. */ export interface Schema$GoogleAppsCardV1Widgets { /** @@ -1327,7 +1344,7 @@ export namespace chat_v1 { name?: string | null; } /** - * For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/chat): + * For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): */ export interface Schema$HostAppDataSourceMarkup { /** @@ -1579,7 +1596,7 @@ export namespace chat_v1 { */ fallbackText?: string | null; /** - * Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, and monospace block. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url\}|{rendered_text\}\>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name\}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message) + * Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url\}|{rendered_text\}\>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name\}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message) */ formattedText?: string | null; /** @@ -1679,6 +1696,23 @@ export namespace chat_v1 { */ user?: Schema$User; } + /** + * A rich link to a resource. + */ + export interface Schema$RichLinkMetadata { + /** + * Data for a drive link. + */ + driveLinkData?: Schema$DriveLinkData; + /** + * The rich link type. + */ + richLinkType?: string | null; + /** + * The URI of this link. + */ + uri?: string | null; + } /** * A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float). */ @@ -1807,7 +1841,7 @@ export namespace chat_v1 { type?: string | null; } /** - * A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/chat): + * A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): */ export interface Schema$SpaceDataSource { /** @@ -2961,7 +2995,7 @@ export namespace chat_v1 { */ filter?: string; /** - * Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error. + * Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error. */ pageSize?: number; /** @@ -3378,7 +3412,7 @@ export namespace chat_v1 { */ filter?: string; /** - * Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error. + * Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error. */ pageSize?: number; /** @@ -3982,7 +4016,7 @@ export namespace chat_v1 { */ orderBy?: string; /** - * The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error. + * The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error. */ pageSize?: number; /** From 131c12acfaa6da342816048c965167d98f3bb340 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 15/78] feat(chromemanagement): update the API #### chromemanagement:v1 The following keys were added: - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.description - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.flatPath - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.httpMethod - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.id - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameterOrder - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.customer.description - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.customer.location - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.customer.pattern - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.customer.required - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.customer.type - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.extensionId.description - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.extensionId.location - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.extensionId.type - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.orgUnitId.description - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.orgUnitId.location - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.orgUnitId.type - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.pageSize.description - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.pageSize.format - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.pageSize.location - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.pageSize.type - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.pageToken.description - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.pageToken.location - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.parameters.pageToken.type - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.path - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.response.$ref - resources.customers.resources.apps.methods.fetchDevicesRequestingExtension.scopes - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.description - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.flatPath - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.httpMethod - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.id - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameterOrder - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.customer.description - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.customer.location - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.customer.pattern - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.customer.required - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.customer.type - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.extensionId.description - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.extensionId.location - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.extensionId.type - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.orgUnitId.description - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.orgUnitId.location - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.orgUnitId.type - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.pageSize.description - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.pageSize.format - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.pageSize.location - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.pageSize.type - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.pageToken.description - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.pageToken.location - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.parameters.pageToken.type - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.path - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.response.$ref - resources.customers.resources.apps.methods.fetchUsersRequestingExtension.scopes - schemas.GoogleChromeManagementV1DeviceRequestingExtensionDetails.description - schemas.GoogleChromeManagementV1DeviceRequestingExtensionDetails.id - schemas.GoogleChromeManagementV1DeviceRequestingExtensionDetails.properties.deviceName.description - schemas.GoogleChromeManagementV1DeviceRequestingExtensionDetails.properties.deviceName.type - schemas.GoogleChromeManagementV1DeviceRequestingExtensionDetails.properties.justification.description - schemas.GoogleChromeManagementV1DeviceRequestingExtensionDetails.properties.justification.type - schemas.GoogleChromeManagementV1DeviceRequestingExtensionDetails.type - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.description - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.id - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.properties.deviceDetails.description - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.properties.deviceDetails.items.$ref - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.properties.deviceDetails.type - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.properties.nextPageToken.description - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.properties.nextPageToken.type - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.properties.totalSize.description - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.properties.totalSize.format - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.properties.totalSize.type - schemas.GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse.type - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.description - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.id - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.properties.nextPageToken.description - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.properties.nextPageToken.type - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.properties.totalSize.description - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.properties.totalSize.format - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.properties.totalSize.type - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.properties.userDetails.description - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.properties.userDetails.items.$ref - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.properties.userDetails.type - schemas.GoogleChromeManagementV1FetchUsersRequestingExtensionResponse.type - schemas.GoogleChromeManagementV1UserRequestingExtensionDetails.description - schemas.GoogleChromeManagementV1UserRequestingExtensionDetails.id - schemas.GoogleChromeManagementV1UserRequestingExtensionDetails.properties.email.description - schemas.GoogleChromeManagementV1UserRequestingExtensionDetails.properties.email.type - schemas.GoogleChromeManagementV1UserRequestingExtensionDetails.properties.justification.description - schemas.GoogleChromeManagementV1UserRequestingExtensionDetails.properties.justification.type - schemas.GoogleChromeManagementV1UserRequestingExtensionDetails.type The following keys were changed: - resources.customers.resources.telemetry.resources.devices.methods.get.parameters.readMask.description - resources.customers.resources.telemetry.resources.devices.methods.list.parameters.readMask.description - resources.customers.resources.telemetry.resources.events.methods.list.parameters.readMask.description - resources.customers.resources.telemetry.resources.users.methods.get.parameters.readMask.description - resources.customers.resources.telemetry.resources.users.methods.list.parameters.readMask.description --- discovery/chromemanagement-v1.json | 180 ++++++++++++++++- src/apis/chromemanagement/v1.ts | 310 ++++++++++++++++++++++++++++- 2 files changed, 479 insertions(+), 11 deletions(-) diff --git a/discovery/chromemanagement-v1.json b/discovery/chromemanagement-v1.json index 32f3e51d685..bdf519ae2b7 100644 --- a/discovery/chromemanagement-v1.json +++ b/discovery/chromemanagement-v1.json @@ -160,6 +160,98 @@ "scopes": [ "https://www.googleapis.com/auth/chrome.management.appdetails.readonly" ] + }, + "fetchDevicesRequestingExtension": { + "description": "Get a list of devices that have requested to install an extension.", + "flatPath": "v1/customers/{customersId}/apps:fetchDevicesRequestingExtension", + "httpMethod": "GET", + "id": "chromemanagement.customers.apps.fetchDevicesRequestingExtension", + "parameterOrder": [ + "customer" + ], + "parameters": { + "customer": { + "description": "Required. The customer ID or \"my_customer\" prefixed with \"customers/\".", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + }, + "extensionId": { + "description": "Required. The extension for which we want to find requesting devices.", + "location": "query", + "type": "string" + }, + "orgUnitId": { + "description": "The ID of the organizational unit. Only consider devices that directly belong to this org unit, i.e. sub-orgunits are not counted. If omitted, all data will be returned.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of results to return. Maximum and default are 50. Any page size larger than 50 will be coerced to 50.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token to specify the page of the request to be returned. Token expires after 1 day.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+customer}/apps:fetchDevicesRequestingExtension", + "response": { + "$ref": "GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.appdetails.readonly" + ] + }, + "fetchUsersRequestingExtension": { + "description": "Get a list of users that have requested to install an extension.", + "flatPath": "v1/customers/{customersId}/apps:fetchUsersRequestingExtension", + "httpMethod": "GET", + "id": "chromemanagement.customers.apps.fetchUsersRequestingExtension", + "parameterOrder": [ + "customer" + ], + "parameters": { + "customer": { + "description": "Required. The customer ID or \"my_customer\" prefixed with \"customers/\".", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + }, + "extensionId": { + "description": "Required. The extension for which we want to find the requesting users.", + "location": "query", + "type": "string" + }, + "orgUnitId": { + "description": "The ID of the organizational unit. Only consider devices that directly belong to this org unit, i.e. sub-orgunits are not counted. If omitted, all data will be returned.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of results to return. Maximum and default are 50. Any page size larger than 50 will be coerced to 50.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token to specify the page of the request to be returned. Token expires after 1 day.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+customer}/apps:fetchUsersRequestingExtension", + "response": { + "$ref": "GoogleChromeManagementV1FetchUsersRequestingExtensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.appdetails.readonly" + ] } }, "resources": { @@ -746,7 +838,7 @@ "type": "string" }, "readMask": { - "description": "Required. Read mask to specify which fields to return.", + "description": "Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report - boot_performance_report - heartbeat_status_report - network_bandwidth_report - peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -793,7 +885,7 @@ "type": "string" }, "readMask": { - "description": "Required. Read mask to specify which fields to return.", + "description": "Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report - boot_performance_report - heartbeat_status_report - network_bandwidth_report - peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -844,7 +936,7 @@ "type": "string" }, "readMask": { - "description": "Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required.", + "description": "Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -972,7 +1064,7 @@ "type": "string" }, "readMask": { - "description": "Read mask to specify which fields to return.", + "description": "Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1019,7 +1111,7 @@ "type": "string" }, "readMask": { - "description": "Read mask to specify which fields to return.", + "description": "Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1040,7 +1132,7 @@ } } }, - "revision": "20240227", + "revision": "20240312", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -2087,6 +2179,21 @@ }, "type": "object" }, + "GoogleChromeManagementV1DeviceRequestingExtensionDetails": { + "description": "Details of a device requesting an extension, including the name of the device and the justification of the request.", + "id": "GoogleChromeManagementV1DeviceRequestingExtensionDetails", + "properties": { + "deviceName": { + "description": "The name of a device that has requested the extension.", + "type": "string" + }, + "justification": { + "description": "Request justification as entered by the user.", + "type": "string" + } + }, + "type": "object" + }, "GoogleChromeManagementV1DiskInfo": { "description": "Status of the single storage device.", "id": "GoogleChromeManagementV1DiskInfo", @@ -2279,6 +2386,52 @@ }, "type": "object" }, + "GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse": { + "description": "Response containing a list of devices that have requested the queried extension.", + "id": "GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse", + "properties": { + "deviceDetails": { + "description": "Details of devices that have requested the queried extension.", + "items": { + "$ref": "GoogleChromeManagementV1DeviceRequestingExtensionDetails" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Optional. Token to specify the next page in the list. Token expires after 1 day.", + "type": "string" + }, + "totalSize": { + "description": "Optional. Total number of devices in response.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleChromeManagementV1FetchUsersRequestingExtensionResponse": { + "description": "Response containing a list of users that have requested the queried extension.", + "id": "GoogleChromeManagementV1FetchUsersRequestingExtensionResponse", + "properties": { + "nextPageToken": { + "description": "Token to specify the next page in the list.", + "type": "string" + }, + "totalSize": { + "description": "Total number of users in response.", + "format": "int32", + "type": "integer" + }, + "userDetails": { + "description": "Details of users that have requested the queried extension.", + "items": { + "$ref": "GoogleChromeManagementV1UserRequestingExtensionDetails" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleChromeManagementV1FindInstalledAppDevicesResponse": { "description": "Response containing a list of devices with queried app installed.", "id": "GoogleChromeManagementV1FindInstalledAppDevicesResponse", @@ -3988,6 +4141,21 @@ }, "type": "object" }, + "GoogleChromeManagementV1UserRequestingExtensionDetails": { + "description": "Details of a user requesting an extension, including the email and the justification.", + "id": "GoogleChromeManagementV1UserRequestingExtensionDetails", + "properties": { + "email": { + "description": "The e-mail address of a user that has requested the extension.", + "type": "string" + }, + "justification": { + "description": "Request justification as entered by the user.", + "type": "string" + } + }, + "type": "object" + }, "GoogleProtobufEmpty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "GoogleProtobufEmpty", diff --git a/src/apis/chromemanagement/v1.ts b/src/apis/chromemanagement/v1.ts index 16ceae4d81c..b989b35e4ff 100644 --- a/src/apis/chromemanagement/v1.ts +++ b/src/apis/chromemanagement/v1.ts @@ -793,6 +793,19 @@ export namespace chromemanagement_v1 { */ count?: string | null; } + /** + * Details of a device requesting an extension, including the name of the device and the justification of the request. + */ + export interface Schema$GoogleChromeManagementV1DeviceRequestingExtensionDetails { + /** + * The name of a device that has requested the extension. + */ + deviceName?: string | null; + /** + * Request justification as entered by the user. + */ + justification?: string | null; + } /** * Status of the single storage device. */ @@ -929,6 +942,40 @@ export namespace chromemanagement_v1 { */ totalSize?: string | null; } + /** + * Response containing a list of devices that have requested the queried extension. + */ + export interface Schema$GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse { + /** + * Details of devices that have requested the queried extension. + */ + deviceDetails?: Schema$GoogleChromeManagementV1DeviceRequestingExtensionDetails[]; + /** + * Optional. Token to specify the next page in the list. Token expires after 1 day. + */ + nextPageToken?: string | null; + /** + * Optional. Total number of devices in response. + */ + totalSize?: number | null; + } + /** + * Response containing a list of users that have requested the queried extension. + */ + export interface Schema$GoogleChromeManagementV1FetchUsersRequestingExtensionResponse { + /** + * Token to specify the next page in the list. + */ + nextPageToken?: string | null; + /** + * Total number of users in response. + */ + totalSize?: number | null; + /** + * Details of users that have requested the queried extension. + */ + userDetails?: Schema$GoogleChromeManagementV1UserRequestingExtensionDetails[]; + } /** * Response containing a list of devices with queried app installed. */ @@ -1972,6 +2019,19 @@ export namespace chromemanagement_v1 { */ userId?: string | null; } + /** + * Details of a user requesting an extension, including the email and the justification. + */ + export interface Schema$GoogleChromeManagementV1UserRequestingExtensionDetails { + /** + * The e-mail address of a user that has requested the extension. + */ + email?: string | null; + /** + * Request justification as entered by the user. + */ + justification?: string | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -2131,6 +2191,200 @@ export namespace chromemanagement_v1 { ); } } + + /** + * Get a list of devices that have requested to install an extension. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchDevicesRequestingExtension( + params: Params$Resource$Customers$Apps$Fetchdevicesrequestingextension, + options: StreamMethodOptions + ): GaxiosPromise; + fetchDevicesRequestingExtension( + params?: Params$Resource$Customers$Apps$Fetchdevicesrequestingextension, + options?: MethodOptions + ): GaxiosPromise; + fetchDevicesRequestingExtension( + params: Params$Resource$Customers$Apps$Fetchdevicesrequestingextension, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchDevicesRequestingExtension( + params: Params$Resource$Customers$Apps$Fetchdevicesrequestingextension, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchDevicesRequestingExtension( + params: Params$Resource$Customers$Apps$Fetchdevicesrequestingextension, + callback: BodyResponseCallback + ): void; + fetchDevicesRequestingExtension( + callback: BodyResponseCallback + ): void; + fetchDevicesRequestingExtension( + paramsOrCallback?: + | Params$Resource$Customers$Apps$Fetchdevicesrequestingextension + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Apps$Fetchdevicesrequestingextension; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Customers$Apps$Fetchdevicesrequestingextension; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://chromemanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+customer}/apps:fetchDevicesRequestingExtension' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customer'], + pathParams: ['customer'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Get a list of users that have requested to install an extension. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchUsersRequestingExtension( + params: Params$Resource$Customers$Apps$Fetchusersrequestingextension, + options: StreamMethodOptions + ): GaxiosPromise; + fetchUsersRequestingExtension( + params?: Params$Resource$Customers$Apps$Fetchusersrequestingextension, + options?: MethodOptions + ): GaxiosPromise; + fetchUsersRequestingExtension( + params: Params$Resource$Customers$Apps$Fetchusersrequestingextension, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchUsersRequestingExtension( + params: Params$Resource$Customers$Apps$Fetchusersrequestingextension, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchUsersRequestingExtension( + params: Params$Resource$Customers$Apps$Fetchusersrequestingextension, + callback: BodyResponseCallback + ): void; + fetchUsersRequestingExtension( + callback: BodyResponseCallback + ): void; + fetchUsersRequestingExtension( + paramsOrCallback?: + | Params$Resource$Customers$Apps$Fetchusersrequestingextension + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Apps$Fetchusersrequestingextension; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Customers$Apps$Fetchusersrequestingextension; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://chromemanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+customer}/apps:fetchUsersRequestingExtension' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customer'], + pathParams: ['customer'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Customers$Apps$Countchromeapprequests @@ -2156,6 +2410,52 @@ export namespace chromemanagement_v1 { */ pageToken?: string; } + export interface Params$Resource$Customers$Apps$Fetchdevicesrequestingextension + extends StandardParameters { + /** + * Required. The customer ID or "my_customer" prefixed with "customers/". + */ + customer?: string; + /** + * Required. The extension for which we want to find requesting devices. + */ + extensionId?: string; + /** + * The ID of the organizational unit. Only consider devices that directly belong to this org unit, i.e. sub-orgunits are not counted. If omitted, all data will be returned. + */ + orgUnitId?: string; + /** + * Optional. Maximum number of results to return. Maximum and default are 50. Any page size larger than 50 will be coerced to 50. + */ + pageSize?: number; + /** + * Optional. Token to specify the page of the request to be returned. Token expires after 1 day. + */ + pageToken?: string; + } + export interface Params$Resource$Customers$Apps$Fetchusersrequestingextension + extends StandardParameters { + /** + * Required. The customer ID or "my_customer" prefixed with "customers/". + */ + customer?: string; + /** + * Required. The extension for which we want to find the requesting users. + */ + extensionId?: string; + /** + * The ID of the organizational unit. Only consider devices that directly belong to this org unit, i.e. sub-orgunits are not counted. If omitted, all data will be returned. + */ + orgUnitId?: string; + /** + * Optional. Maximum number of results to return. Maximum and default are 50. Any page size larger than 50 will be coerced to 50. + */ + pageSize?: number; + /** + * Optional. Token to specify the page of the request to be returned. Token expires after 1 day. + */ + pageToken?: string; + } export class Resource$Customers$Apps$Android { context: APIRequestContext; @@ -3909,7 +4209,7 @@ export namespace chromemanagement_v1 { */ name?: string; /** - * Required. Read mask to specify which fields to return. + * Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report - boot_performance_report - heartbeat_status_report - network_bandwidth_report - peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report */ readMask?: string; } @@ -3932,7 +4232,7 @@ export namespace chromemanagement_v1 { */ parent?: string; /** - * Required. Read mask to specify which fields to return. + * Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report - boot_performance_report - heartbeat_status_report - network_bandwidth_report - peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report */ readMask?: string; } @@ -4060,7 +4360,7 @@ export namespace chromemanagement_v1 { */ parent?: string; /** - * Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. + * Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event */ readMask?: string; } @@ -4595,7 +4895,7 @@ export namespace chromemanagement_v1 { */ name?: string; /** - * Read mask to specify which fields to return. + * Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report */ readMask?: string; } @@ -4618,7 +4918,7 @@ export namespace chromemanagement_v1 { */ parent?: string; /** - * Read mask to specify which fields to return. + * Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report */ readMask?: string; } From b7cf2f02200478f1ccf0b6e17aeb9ba73f8a30dd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 16/78] feat(cloudbilling): update the API #### cloudbilling:v1beta The following keys were added: - resources.billingAccounts.resources.anomalies.methods.get.description - resources.billingAccounts.resources.anomalies.methods.get.flatPath - resources.billingAccounts.resources.anomalies.methods.get.httpMethod - resources.billingAccounts.resources.anomalies.methods.get.id - resources.billingAccounts.resources.anomalies.methods.get.parameterOrder - resources.billingAccounts.resources.anomalies.methods.get.parameters.name.description - resources.billingAccounts.resources.anomalies.methods.get.parameters.name.location - resources.billingAccounts.resources.anomalies.methods.get.parameters.name.pattern - resources.billingAccounts.resources.anomalies.methods.get.parameters.name.required - resources.billingAccounts.resources.anomalies.methods.get.parameters.name.type - resources.billingAccounts.resources.anomalies.methods.get.path - resources.billingAccounts.resources.anomalies.methods.get.response.$ref - resources.billingAccounts.resources.anomalies.methods.get.scopes - resources.billingAccounts.resources.anomalies.methods.list.description - resources.billingAccounts.resources.anomalies.methods.list.flatPath - resources.billingAccounts.resources.anomalies.methods.list.httpMethod - resources.billingAccounts.resources.anomalies.methods.list.id - resources.billingAccounts.resources.anomalies.methods.list.parameterOrder - resources.billingAccounts.resources.anomalies.methods.list.parameters.filter.description - resources.billingAccounts.resources.anomalies.methods.list.parameters.filter.location - resources.billingAccounts.resources.anomalies.methods.list.parameters.filter.type - resources.billingAccounts.resources.anomalies.methods.list.parameters.pageSize.description - resources.billingAccounts.resources.anomalies.methods.list.parameters.pageSize.format - resources.billingAccounts.resources.anomalies.methods.list.parameters.pageSize.location - resources.billingAccounts.resources.anomalies.methods.list.parameters.pageSize.type - resources.billingAccounts.resources.anomalies.methods.list.parameters.pageToken.description - resources.billingAccounts.resources.anomalies.methods.list.parameters.pageToken.location - resources.billingAccounts.resources.anomalies.methods.list.parameters.pageToken.type - resources.billingAccounts.resources.anomalies.methods.list.parameters.parent.description - resources.billingAccounts.resources.anomalies.methods.list.parameters.parent.location - resources.billingAccounts.resources.anomalies.methods.list.parameters.parent.pattern - resources.billingAccounts.resources.anomalies.methods.list.parameters.parent.required - resources.billingAccounts.resources.anomalies.methods.list.parameters.parent.type - resources.billingAccounts.resources.anomalies.methods.list.path - resources.billingAccounts.resources.anomalies.methods.list.response.$ref - resources.billingAccounts.resources.anomalies.methods.list.scopes - resources.projects.resources.anomalies.methods.get.description - resources.projects.resources.anomalies.methods.get.flatPath - resources.projects.resources.anomalies.methods.get.httpMethod - resources.projects.resources.anomalies.methods.get.id - resources.projects.resources.anomalies.methods.get.parameterOrder - resources.projects.resources.anomalies.methods.get.parameters.name.description - resources.projects.resources.anomalies.methods.get.parameters.name.location - resources.projects.resources.anomalies.methods.get.parameters.name.pattern - resources.projects.resources.anomalies.methods.get.parameters.name.required - resources.projects.resources.anomalies.methods.get.parameters.name.type - resources.projects.resources.anomalies.methods.get.path - resources.projects.resources.anomalies.methods.get.response.$ref - resources.projects.resources.anomalies.methods.get.scopes - resources.projects.resources.anomalies.methods.list.description - resources.projects.resources.anomalies.methods.list.flatPath - resources.projects.resources.anomalies.methods.list.httpMethod - resources.projects.resources.anomalies.methods.list.id - resources.projects.resources.anomalies.methods.list.parameterOrder - resources.projects.resources.anomalies.methods.list.parameters.filter.description - resources.projects.resources.anomalies.methods.list.parameters.filter.location - resources.projects.resources.anomalies.methods.list.parameters.filter.type - resources.projects.resources.anomalies.methods.list.parameters.pageSize.description - resources.projects.resources.anomalies.methods.list.parameters.pageSize.format - resources.projects.resources.anomalies.methods.list.parameters.pageSize.location - resources.projects.resources.anomalies.methods.list.parameters.pageSize.type - resources.projects.resources.anomalies.methods.list.parameters.pageToken.description - resources.projects.resources.anomalies.methods.list.parameters.pageToken.location - resources.projects.resources.anomalies.methods.list.parameters.pageToken.type - resources.projects.resources.anomalies.methods.list.parameters.parent.description - resources.projects.resources.anomalies.methods.list.parameters.parent.location - resources.projects.resources.anomalies.methods.list.parameters.parent.pattern - resources.projects.resources.anomalies.methods.list.parameters.parent.required - resources.projects.resources.anomalies.methods.list.parameters.parent.type - resources.projects.resources.anomalies.methods.list.path - resources.projects.resources.anomalies.methods.list.response.$ref - resources.projects.resources.anomalies.methods.list.scopes - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.id - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.detectionTime.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.detectionTime.format - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.detectionTime.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.deviation.$ref - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.deviation.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.name.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.name.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.resourceDisplayName.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.resourceDisplayName.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.rootCauses.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.rootCauses.items.$ref - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.rootCauses.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.scope.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.scope.enum - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.scope.enumDescriptions - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.scope.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.severity.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.severity.enum - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.severity.enumDescriptions - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.severity.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.updateTime.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.updateTime.format - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.updateTime.readOnly - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.properties.updateTime.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomaly.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.id - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.actualSpend.$ref - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.actualSpend.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.deviationAmount.$ref - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.deviationAmount.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.deviationPercentage.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.deviationPercentage.format - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.deviationPercentage.type - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.expectedSpend.$ref - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.properties.expectedSpend.description - schemas.GoogleCloudBillingAnomaliesV1betaAnomalyDeviation.type - schemas.GoogleCloudBillingAnomaliesV1betaCause.description - schemas.GoogleCloudBillingAnomaliesV1betaCause.id - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.causeType.description - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.causeType.enum - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.causeType.enumDescriptions - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.causeType.type - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.deviation.$ref - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.deviation.description - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.displayName.description - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.displayName.type - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.resource.description - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.resource.type - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.subCauses.description - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.subCauses.items.$ref - schemas.GoogleCloudBillingAnomaliesV1betaCause.properties.subCauses.type - schemas.GoogleCloudBillingAnomaliesV1betaCause.type - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse.description - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse.id - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse.properties.anomalies.description - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse.properties.anomalies.items.$ref - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse.properties.anomalies.type - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse.properties.nextPageToken.description - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse.properties.nextPageToken.type - schemas.GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse.type --- discovery/cloudbilling-v1beta.json | 307 +++++++++++++++- src/apis/cloudbilling/v1beta.ts | 555 +++++++++++++++++++++++++++++ 2 files changed, 861 insertions(+), 1 deletion(-) diff --git a/discovery/cloudbilling-v1beta.json b/discovery/cloudbilling-v1beta.json index 8dc15333b81..b262a546674 100644 --- a/discovery/cloudbilling-v1beta.json +++ b/discovery/cloudbilling-v1beta.json @@ -145,6 +145,80 @@ } }, "resources": { + "anomalies": { + "methods": { + "get": { + "description": "Gets an anomaly for a billing account or a project.", + "flatPath": "v1beta/billingAccounts/{billingAccountsId}/anomalies/{anomaliesId}", + "httpMethod": "GET", + "id": "cloudbilling.billingAccounts.anomalies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/anomalies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-billing", + "https://www.googleapis.com/auth/cloud-billing.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists anomalies for a billing account or a project.", + "flatPath": "v1beta/billingAccounts/{billingAccountsId}/anomalies", + "httpMethod": "GET", + "id": "cloudbilling.billingAccounts.anomalies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = \"20231201\" AND end_time = \"20240120\" .", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}.", + "location": "path", + "pattern": "^billingAccounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/anomalies", + "response": { + "$ref": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-billing", + "https://www.googleapis.com/auth/cloud-billing.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "services": { "methods": { "get": { @@ -515,6 +589,84 @@ } } }, + "projects": { + "resources": { + "anomalies": { + "methods": { + "get": { + "description": "Gets an anomaly for a billing account or a project.", + "flatPath": "v1beta/projects/{projectsId}/anomalies/{anomaliesId}", + "httpMethod": "GET", + "id": "cloudbilling.projects.anomalies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}.", + "location": "path", + "pattern": "^projects/[^/]+/anomalies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-billing", + "https://www.googleapis.com/auth/cloud-billing.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists anomalies for a billing account or a project.", + "flatPath": "v1beta/projects/{projectsId}/anomalies", + "httpMethod": "GET", + "id": "cloudbilling.projects.anomalies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = \"20231201\" AND end_time = \"20240120\" .", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/anomalies", + "response": { + "$ref": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-billing", + "https://www.googleapis.com/auth/cloud-billing.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "skuGroups": { "methods": { "get": { @@ -758,7 +910,7 @@ } } }, - "revision": "20231215", + "revision": "20240311", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "CacheFillRegions": { @@ -1319,6 +1471,159 @@ }, "type": "object" }, + "GoogleCloudBillingAnomaliesV1betaAnomaly": { + "description": "Encapsulates an anomaly.", + "id": "GoogleCloudBillingAnomaliesV1betaAnomaly", + "properties": { + "detectionTime": { + "description": "Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.", + "format": "google-datetime", + "type": "string" + }, + "deviation": { + "$ref": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", + "description": "Deviation information of the anomaly." + }, + "name": { + "description": "Identifier. Resource name for the anomaly.", + "type": "string" + }, + "resourceDisplayName": { + "description": "The display name of the resource that the anomaly occurred in/belongs to.", + "type": "string" + }, + "rootCauses": { + "description": "A list of causes which contribute to the anomaly.", + "items": { + "$ref": "GoogleCloudBillingAnomaliesV1betaCause" + }, + "type": "array" + }, + "scope": { + "description": "Indicate the scope of the anomaly.", + "enum": [ + "SCOPE_UNSPECIFIED", + "SCOPE_BILLING_ACCOUNT", + "SCOPE_PROJECT" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates the anomaly is for a billing account.", + "Indicates the anomaly is for a project." + ], + "type": "string" + }, + "severity": { + "description": "Severity of the anomaly. Unspecified if severity is not met/assigned.", + "enum": [ + "ANOMALY_SEVERITY_UNSPECIFIED", + "ANOMALY_SEVERITY_LOW", + "ANOMALY_SEVERITY_MEDIUM", + "ANOMALY_SEVERITY_HIGH" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates the anomaly's severity is low.", + "Indicates the anomaly's severity is medium.", + "Indicates the anomaly's severity is high." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The most recent anomaly's last updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation": { + "description": "Encapsulates the deviation information.", + "id": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", + "properties": { + "actualSpend": { + "$ref": "Money", + "description": "The actual spend for the anomaly." + }, + "deviationAmount": { + "$ref": "Money", + "description": "The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend." + }, + "deviationPercentage": { + "description": "The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.", + "format": "double", + "type": "number" + }, + "expectedSpend": { + "$ref": "Money", + "description": "The expected spend for the anomaly." + } + }, + "type": "object" + }, + "GoogleCloudBillingAnomaliesV1betaCause": { + "description": "Encapsulates the information of the reason which caused the anomaly.", + "id": "GoogleCloudBillingAnomaliesV1betaCause", + "properties": { + "causeType": { + "description": "The cause type.", + "enum": [ + "CAUSE_TYPE_UNSPECIFIED", + "CAUSE_TYPE_PROJECT", + "CAUSE_TYPE_SERVICE", + "CAUSE_TYPE_SKU", + "CAUSE_TYPE_LOCATION" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Caused by a project.", + "Caused by a service.", + "Caused by a SKU.", + "Caused by a location." + ], + "type": "string" + }, + "deviation": { + "$ref": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", + "description": "The deviation information for the cause." + }, + "displayName": { + "description": "The display name of the cause.", + "type": "string" + }, + "resource": { + "description": "The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}. location: locations/{location}.", + "type": "string" + }, + "subCauses": { + "description": "The sub causes.", + "items": { + "$ref": "GoogleCloudBillingAnomaliesV1betaCause" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse": { + "description": "Response message for ListAnomalies.", + "id": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse", + "properties": { + "anomalies": { + "description": "The returned anomalies.", + "items": { + "$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudBillingBillingaccountpricesV1betaAggregationInfo": { "description": "Encapsulates the aggregation information such as aggregation level and interval for a billing account price.", "id": "GoogleCloudBillingBillingaccountpricesV1betaAggregationInfo", diff --git a/src/apis/cloudbilling/v1beta.ts b/src/apis/cloudbilling/v1beta.ts index d17ad8f9648..777cbf41ab9 100644 --- a/src/apis/cloudbilling/v1beta.ts +++ b/src/apis/cloudbilling/v1beta.ts @@ -113,6 +113,7 @@ export namespace cloudbilling_v1beta { export class Cloudbilling { context: APIRequestContext; billingAccounts: Resource$Billingaccounts; + projects: Resource$Projects; skuGroups: Resource$Skugroups; skus: Resource$Skus; v1beta: Resource$V1beta; @@ -124,6 +125,7 @@ export namespace cloudbilling_v1beta { }; this.billingAccounts = new Resource$Billingaccounts(this.context); + this.projects = new Resource$Projects(this.context); this.skuGroups = new Resource$Skugroups(this.context); this.skus = new Resource$Skus(this.context); this.v1beta = new Resource$V1beta(this.context); @@ -480,6 +482,102 @@ export namespace cloudbilling_v1beta { */ estimationTimeFrameOffset?: string | null; } + /** + * Encapsulates an anomaly. + */ + export interface Schema$GoogleCloudBillingAnomaliesV1betaAnomaly { + /** + * Time that the anomaly was detected. Will be set to 00:00 google time of the detected date. + */ + detectionTime?: string | null; + /** + * Deviation information of the anomaly. + */ + deviation?: Schema$GoogleCloudBillingAnomaliesV1betaAnomalyDeviation; + /** + * Identifier. Resource name for the anomaly. + */ + name?: string | null; + /** + * The display name of the resource that the anomaly occurred in/belongs to. + */ + resourceDisplayName?: string | null; + /** + * A list of causes which contribute to the anomaly. + */ + rootCauses?: Schema$GoogleCloudBillingAnomaliesV1betaCause[]; + /** + * Indicate the scope of the anomaly. + */ + scope?: string | null; + /** + * Severity of the anomaly. Unspecified if severity is not met/assigned. + */ + severity?: string | null; + /** + * Output only. The most recent anomaly's last updated time. + */ + updateTime?: string | null; + } + /** + * Encapsulates the deviation information. + */ + export interface Schema$GoogleCloudBillingAnomaliesV1betaAnomalyDeviation { + /** + * The actual spend for the anomaly. + */ + actualSpend?: Schema$Money; + /** + * The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend. + */ + deviationAmount?: Schema$Money; + /** + * The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100. + */ + deviationPercentage?: number | null; + /** + * The expected spend for the anomaly. + */ + expectedSpend?: Schema$Money; + } + /** + * Encapsulates the information of the reason which caused the anomaly. + */ + export interface Schema$GoogleCloudBillingAnomaliesV1betaCause { + /** + * The cause type. + */ + causeType?: string | null; + /** + * The deviation information for the cause. + */ + deviation?: Schema$GoogleCloudBillingAnomaliesV1betaAnomalyDeviation; + /** + * The display name of the cause. + */ + displayName?: string | null; + /** + * The resource name of the cause. project: projects/{project\}. service: services/{service\}. sku: services/{service\}/skus/{sku\}. location: locations/{location\}. + */ + resource?: string | null; + /** + * The sub causes. + */ + subCauses?: Schema$GoogleCloudBillingAnomaliesV1betaCause[]; + } + /** + * Response message for ListAnomalies. + */ + export interface Schema$GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse { + /** + * The returned anomalies. + */ + anomalies?: Schema$GoogleCloudBillingAnomaliesV1betaAnomaly[]; + /** + * Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Encapsulates the aggregation information such as aggregation level and interval for a billing account price. */ @@ -1607,11 +1705,13 @@ export namespace cloudbilling_v1beta { export class Resource$Billingaccounts { context: APIRequestContext; + anomalies: Resource$Billingaccounts$Anomalies; services: Resource$Billingaccounts$Services; skuGroups: Resource$Billingaccounts$Skugroups; skus: Resource$Billingaccounts$Skus; constructor(context: APIRequestContext) { this.context = context; + this.anomalies = new Resource$Billingaccounts$Anomalies(this.context); this.services = new Resource$Billingaccounts$Services(this.context); this.skuGroups = new Resource$Billingaccounts$Skugroups(this.context); this.skus = new Resource$Billingaccounts$Skus(this.context); @@ -1726,6 +1826,229 @@ export namespace cloudbilling_v1beta { requestBody?: Schema$EstimateCostScenarioForBillingAccountRequest; } + export class Resource$Billingaccounts$Anomalies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets an anomaly for a billing account or a project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Billingaccounts$Anomalies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Billingaccounts$Anomalies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Billingaccounts$Anomalies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Billingaccounts$Anomalies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Billingaccounts$Anomalies$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Billingaccounts$Anomalies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Anomalies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingaccounts$Anomalies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbilling.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists anomalies for a billing account or a project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Billingaccounts$Anomalies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Billingaccounts$Anomalies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Billingaccounts$Anomalies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingaccounts$Anomalies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingaccounts$Anomalies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Billingaccounts$Anomalies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Anomalies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingaccounts$Anomalies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbilling.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/anomalies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Billingaccounts$Anomalies$Get + extends StandardParameters { + /** + * Required. Format for project: projects/{project\}/anomalies/{anomalies\}. Format for billing account: billingAccounts/{billing_account\}/anomalies/{anomalies\}. + */ + name?: string; + } + export interface Params$Resource$Billingaccounts$Anomalies$List + extends StandardParameters { + /** + * Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = "20231201" AND end_time = "20240120" . + */ + filter?: string; + /** + * Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned. + */ + pageToken?: string; + /** + * Required. The project to list Anomaly for the project. Format for project: projects/{project\}. Format for billing account: billingAccounts/{billing_account\}. + */ + parent?: string; + } + export class Resource$Billingaccounts$Services { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -2847,6 +3170,238 @@ export namespace cloudbilling_v1beta { parent?: string; } + export class Resource$Projects { + context: APIRequestContext; + anomalies: Resource$Projects$Anomalies; + constructor(context: APIRequestContext) { + this.context = context; + this.anomalies = new Resource$Projects$Anomalies(this.context); + } + } + + export class Resource$Projects$Anomalies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets an anomaly for a billing account or a project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Anomalies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Anomalies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Anomalies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Anomalies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Anomalies$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Anomalies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Anomalies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Anomalies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbilling.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists anomalies for a billing account or a project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Anomalies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Anomalies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Anomalies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Anomalies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Anomalies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Anomalies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Anomalies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Anomalies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbilling.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/anomalies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Anomalies$Get + extends StandardParameters { + /** + * Required. Format for project: projects/{project\}/anomalies/{anomalies\}. Format for billing account: billingAccounts/{billing_account\}/anomalies/{anomalies\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Anomalies$List + extends StandardParameters { + /** + * Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = "20231201" AND end_time = "20240120" . + */ + filter?: string; + /** + * Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned. + */ + pageToken?: string; + /** + * Required. The project to list Anomaly for the project. Format for project: projects/{project\}. Format for billing account: billingAccounts/{billing_account\}. + */ + parent?: string; + } + export class Resource$Skugroups { context: APIRequestContext; skus: Resource$Skugroups$Skus; From 5ed8cc66f925e0472f2931bc984ccd23c6408ed4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:47 +0000 Subject: [PATCH 17/78] feat(cloudbuild)!: update the API BREAKING CHANGE: This release has breaking changes. #### cloudbuild:v1 The following keys were deleted: - schemas.PrivatePoolV1Config.properties.privateServiceConnect.$ref - schemas.PrivatePoolV1Config.properties.privateServiceConnect.description - schemas.PrivateServiceConnect.description - schemas.PrivateServiceConnect.id - schemas.PrivateServiceConnect.properties.networkAttachment.description - schemas.PrivateServiceConnect.properties.networkAttachment.type - schemas.PrivateServiceConnect.properties.publicIpAddressDisabled.description - schemas.PrivateServiceConnect.properties.publicIpAddressDisabled.type - schemas.PrivateServiceConnect.properties.routeAllTraffic.description - schemas.PrivateServiceConnect.properties.routeAllTraffic.type - schemas.PrivateServiceConnect.type The following keys were added: - schemas.BuildOptions.properties.machineType.enumDeprecated #### cloudbuild:v2 The following keys were added: - schemas.PipelineResult.description - schemas.PipelineResult.id - schemas.PipelineResult.properties.description.description - schemas.PipelineResult.properties.description.readOnly - schemas.PipelineResult.properties.description.type - schemas.PipelineResult.properties.name.description - schemas.PipelineResult.properties.name.readOnly - schemas.PipelineResult.properties.name.type - schemas.PipelineResult.properties.type.description - schemas.PipelineResult.properties.type.enum - schemas.PipelineResult.properties.type.enumDescriptions - schemas.PipelineResult.properties.type.readOnly - schemas.PipelineResult.properties.type.type - schemas.PipelineResult.properties.value.$ref - schemas.PipelineResult.properties.value.description - schemas.PipelineResult.properties.value.readOnly - schemas.PipelineResult.type - schemas.PipelineRun.properties.results.description - schemas.PipelineRun.properties.results.items.$ref - schemas.PipelineRun.properties.results.readOnly - schemas.PipelineRun.properties.results.type - schemas.PipelineRun.properties.serviceAccount.deprecated - schemas.PipelineRunResult.description - schemas.PipelineRunResult.id - schemas.PipelineRunResult.properties.name.description - schemas.PipelineRunResult.properties.name.readOnly - schemas.PipelineRunResult.properties.name.type - schemas.PipelineRunResult.properties.value.$ref - schemas.PipelineRunResult.properties.value.description - schemas.PipelineRunResult.properties.value.readOnly - schemas.PipelineRunResult.type - schemas.PipelineSpec.properties.results.description - schemas.PipelineSpec.properties.results.items.$ref - schemas.PipelineSpec.properties.results.readOnly - schemas.PipelineSpec.properties.results.type - schemas.ResultValue.description - schemas.ResultValue.id - schemas.ResultValue.properties.arrayVal.description - schemas.ResultValue.properties.arrayVal.items.type - schemas.ResultValue.properties.arrayVal.type - schemas.ResultValue.properties.objectVal.additionalProperties.type - schemas.ResultValue.properties.objectVal.description - schemas.ResultValue.properties.objectVal.type - schemas.ResultValue.properties.stringVal.description - schemas.ResultValue.properties.stringVal.type - schemas.ResultValue.properties.type.description - schemas.ResultValue.properties.type.enum - schemas.ResultValue.properties.type.enumDescriptions - schemas.ResultValue.properties.type.readOnly - schemas.ResultValue.properties.type.type - schemas.ResultValue.type The following keys were changed: - schemas.PipelineRun.properties.serviceAccount.description --- discovery/cloudbuild-v1.json | 33 +++------- discovery/cloudbuild-v2.json | 119 ++++++++++++++++++++++++++++++++++- src/apis/cloudbuild/v1.ts | 21 ------- src/apis/cloudbuild/v2.ts | 65 ++++++++++++++++++- 4 files changed, 190 insertions(+), 48 deletions(-) diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index 62fbdb0fe4f..6d6f183f04b 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -2346,7 +2346,7 @@ } } }, - "revision": "20240223", + "revision": "20240310", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3089,6 +3089,14 @@ "E2_HIGHCPU_32", "E2_MEDIUM" ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "Standard machine type.", "Highcpu machine with 8 CPUs.", @@ -4576,10 +4584,6 @@ "$ref": "NetworkConfig", "description": "Network configuration for the pool." }, - "privateServiceConnect": { - "$ref": "PrivateServiceConnect", - "description": "Immutable. Private Service Connect(PSC) Network configuration for the pool." - }, "workerConfig": { "$ref": "WorkerConfig", "description": "Machine configuration for the workers in the pool." @@ -4587,25 +4591,6 @@ }, "type": "object" }, - "PrivateServiceConnect": { - "description": "Defines the Private Service Connect network configuration for the pool.", - "id": "PrivateServiceConnect", - "properties": { - "networkAttachment": { - "description": "Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)", - "type": "string" - }, - "publicIpAddressDisabled": { - "description": "Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect.", - "type": "boolean" - }, - "routeAllTraffic": { - "description": "Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface.", - "type": "boolean" - } - }, - "type": "object" - }, "ProcessAppManifestCallbackOperationMetadata": { "description": "Metadata for `ProcessAppManifestCallback` operation.", "id": "ProcessAppManifestCallbackOperationMetadata", diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index 363d48bfd58..4c382ba710f 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -844,7 +844,7 @@ } } }, - "revision": "20240223", + "revision": "20240310", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -1885,6 +1885,45 @@ }, "type": "object" }, + "PipelineResult": { + "description": "A value produced by a Pipeline.", + "id": "PipelineResult", + "properties": { + "description": { + "description": "Output only. Description of the result.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Name of the result.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of data that the result holds.", + "enum": [ + "TYPE_UNSPECIFIED", + "STRING", + "ARRAY", + "OBJECT" + ], + "enumDescriptions": [ + "Default enum type; should not be used.", + "Default", + "Array type", + "Object type" + ], + "readOnly": true, + "type": "string" + }, + "value": { + "$ref": "ResultValue", + "description": "Output only. Value of the result.", + "readOnly": true + } + }, + "type": "object" + }, "PipelineRun": { "description": "Message describing PipelineRun object", "id": "PipelineRun", @@ -1988,12 +2027,21 @@ "description": "Output only. The exact PipelineSpec used to instantiate the run.", "readOnly": true }, + "results": { + "description": "Optional. Output only. List of results written out by the pipeline's containers", + "items": { + "$ref": "PipelineRunResult" + }, + "readOnly": true, + "type": "array" + }, "security": { "$ref": "Security", "description": "Optional. Security configuration." }, "serviceAccount": { - "description": "Service account used in the Pipeline.", + "deprecated": true, + "description": "Service account used in the Pipeline. Deprecated; please use security.service_account instead.", "type": "string" }, "skippedTasks": { @@ -2049,6 +2097,23 @@ }, "type": "object" }, + "PipelineRunResult": { + "description": "PipelineRunResult used to describe the results of a pipeline", + "id": "PipelineRunResult", + "properties": { + "name": { + "description": "Output only. Name of the TaskRun", + "readOnly": true, + "type": "string" + }, + "value": { + "$ref": "ResultValue", + "description": "Output only. Value of the result.", + "readOnly": true + } + }, + "type": "object" + }, "PipelineSpec": { "description": "PipelineSpec defines the desired state of Pipeline.", "id": "PipelineSpec", @@ -2072,6 +2137,14 @@ }, "type": "array" }, + "results": { + "description": "Optional. Output only. List of results written out by the pipeline's containers", + "items": { + "$ref": "PipelineResult" + }, + "readOnly": true, + "type": "array" + }, "tasks": { "description": "List of Tasks that execute when this Pipeline is run.", "items": { @@ -2325,6 +2398,48 @@ }, "type": "object" }, + "ResultValue": { + "description": "ResultValue holds different types of data for a single result.", + "id": "ResultValue", + "properties": { + "arrayVal": { + "description": "Value of the result if type is array.", + "items": { + "type": "string" + }, + "type": "array" + }, + "objectVal": { + "additionalProperties": { + "type": "string" + }, + "description": "Value of the result if type is object.", + "type": "object" + }, + "stringVal": { + "description": "Value of the result if type is string.", + "type": "string" + }, + "type": { + "description": "Output only. The type of data that the result holds.", + "enum": [ + "TYPE_UNSPECIFIED", + "STRING", + "ARRAY", + "OBJECT" + ], + "enumDescriptions": [ + "Default enum type; should not be used.", + "Default", + "Array type", + "Object type" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "RunWorkflowCustomOperationMetadata": { "description": "Represents the custom metadata of the RunWorkflow long-running operation.", "id": "RunWorkflowCustomOperationMetadata", diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 8b98c787fa9..8add379c3ee 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -1722,32 +1722,11 @@ export namespace cloudbuild_v1 { * Network configuration for the pool. */ networkConfig?: Schema$NetworkConfig; - /** - * Immutable. Private Service Connect(PSC) Network configuration for the pool. - */ - privateServiceConnect?: Schema$PrivateServiceConnect; /** * Machine configuration for the workers in the pool. */ workerConfig?: Schema$WorkerConfig; } - /** - * Defines the Private Service Connect network configuration for the pool. - */ - export interface Schema$PrivateServiceConnect { - /** - * Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project\}/regions/{region\}/networkAttachments/{networkAttachment\}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments) - */ - networkAttachment?: string | null; - /** - * Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect. - */ - publicIpAddressDisabled?: boolean | null; - /** - * Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface. - */ - routeAllTraffic?: boolean | null; - } /** * Metadata for `ProcessAppManifestCallback` operation. */ diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index 9eec4565ab1..36afdf7b2b8 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -874,6 +874,27 @@ export namespace cloudbuild_v2 { */ resolver?: string | null; } + /** + * A value produced by a Pipeline. + */ + export interface Schema$PipelineResult { + /** + * Output only. Description of the result. + */ + description?: string | null; + /** + * Output only. Name of the result. + */ + name?: string | null; + /** + * Output only. The type of data that the result holds. + */ + type?: string | null; + /** + * Output only. Value of the result. + */ + value?: Schema$ResultValue; + } /** * Message describing PipelineRun object */ @@ -942,12 +963,16 @@ export namespace cloudbuild_v2 { * Output only. The exact PipelineSpec used to instantiate the run. */ resolvedPipelineSpec?: Schema$PipelineSpec; + /** + * Optional. Output only. List of results written out by the pipeline's containers + */ + results?: Schema$PipelineRunResult[]; /** * Optional. Security configuration. */ security?: Schema$Security; /** - * Service account used in the Pipeline. + * Service account used in the Pipeline. Deprecated; please use security.service_account instead. */ serviceAccount?: string | null; /** @@ -987,6 +1012,19 @@ export namespace cloudbuild_v2 { */ workspaces?: Schema$WorkspaceBinding[]; } + /** + * PipelineRunResult used to describe the results of a pipeline + */ + export interface Schema$PipelineRunResult { + /** + * Output only. Name of the TaskRun + */ + name?: string | null; + /** + * Output only. Value of the result. + */ + value?: Schema$ResultValue; + } /** * PipelineSpec defines the desired state of Pipeline. */ @@ -1003,6 +1041,10 @@ export namespace cloudbuild_v2 { * List of parameters. */ params?: Schema$ParamSpec[]; + /** + * Optional. Output only. List of results written out by the pipeline's containers + */ + results?: Schema$PipelineResult[]; /** * List of Tasks that execute when this Pipeline is run. */ @@ -1163,6 +1205,27 @@ export namespace cloudbuild_v2 { */ webhookId?: string | null; } + /** + * ResultValue holds different types of data for a single result. + */ + export interface Schema$ResultValue { + /** + * Value of the result if type is array. + */ + arrayVal?: string[] | null; + /** + * Value of the result if type is object. + */ + objectVal?: {[key: string]: string} | null; + /** + * Value of the result if type is string. + */ + stringVal?: string | null; + /** + * Output only. The type of data that the result holds. + */ + type?: string | null; + } /** * Represents the custom metadata of the RunWorkflow long-running operation. */ From 7537bf0701b1b1504860e4ca2b3dc0070aaff85f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:48 +0000 Subject: [PATCH 18/78] feat(clouddeploy): update the API #### clouddeploy:v1 The following keys were added: - schemas.AutomationRolloutMetadata.properties.currentRepairAutomationRun.description - schemas.AutomationRolloutMetadata.properties.currentRepairAutomationRun.readOnly - schemas.AutomationRolloutMetadata.properties.currentRepairAutomationRun.type The following keys were changed: - schemas.AutomationEvent.properties.type.enum - schemas.AutomationEvent.properties.type.enumDeprecated - schemas.AutomationEvent.properties.type.enumDescriptions - schemas.AutomationRun.properties.state.enum - schemas.AutomationRun.properties.state.enumDescriptions - schemas.AutomationRunEvent.properties.type.enum - schemas.AutomationRunEvent.properties.type.enumDeprecated - schemas.AutomationRunEvent.properties.type.enumDescriptions - schemas.DeliveryPipelineNotificationEvent.properties.type.enum - schemas.DeliveryPipelineNotificationEvent.properties.type.enumDeprecated - schemas.DeliveryPipelineNotificationEvent.properties.type.enumDescriptions - schemas.JobRunNotificationEvent.properties.type.enum - schemas.JobRunNotificationEvent.properties.type.enumDeprecated - schemas.JobRunNotificationEvent.properties.type.enumDescriptions - schemas.ReleaseNotificationEvent.properties.type.enum - schemas.ReleaseNotificationEvent.properties.type.enumDeprecated - schemas.ReleaseNotificationEvent.properties.type.enumDescriptions - schemas.ReleaseRenderEvent.properties.type.enum - schemas.ReleaseRenderEvent.properties.type.enumDeprecated - schemas.ReleaseRenderEvent.properties.type.enumDescriptions - schemas.RetryAttempt.properties.state.enum - schemas.RetryAttempt.properties.state.enumDescriptions - schemas.RollbackAttempt.properties.state.enum - schemas.RollbackAttempt.properties.state.enumDescriptions - schemas.RolloutNotificationEvent.properties.type.enum - schemas.RolloutNotificationEvent.properties.type.enumDeprecated - schemas.RolloutNotificationEvent.properties.type.enumDescriptions - schemas.RolloutUpdateEvent.properties.type.enum - schemas.RolloutUpdateEvent.properties.type.enumDeprecated - schemas.RolloutUpdateEvent.properties.type.enumDescriptions - schemas.TargetNotificationEvent.properties.type.enum - schemas.TargetNotificationEvent.properties.type.enumDeprecated - schemas.TargetNotificationEvent.properties.type.enumDescriptions --- discovery/clouddeploy-v1.json | 52 ++++++++++++++++++++++++++++++----- src/apis/clouddeploy/v1.ts | 4 +++ 2 files changed, 49 insertions(+), 7 deletions(-) diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index 05c14da5a7b..69758aebcd8 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -2065,7 +2065,7 @@ } } }, - "revision": "20240207", + "revision": "20240228", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -2348,6 +2348,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -2358,6 +2359,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -2368,6 +2370,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -2401,6 +2404,11 @@ "readOnly": true, "type": "array" }, + "currentRepairAutomationRun": { + "description": "Output only. The current AutomationRun repairing the rollout.", + "readOnly": true, + "type": "string" + }, "promoteAutomationRun": { "description": "Output only. The ID of the AutomationRun initiated by a promote release rule.", "readOnly": true, @@ -2516,7 +2524,8 @@ "CANCELLED", "FAILED", "IN_PROGRESS", - "PENDING" + "PENDING", + "ABORTED" ], "enumDescriptions": [ "The `AutomationRun` has an unspecified state.", @@ -2524,7 +2533,8 @@ "The `AutomationRun` was cancelled.", "The `AutomationRun` has failed.", "The `AutomationRun` is in progress.", - "The `AutomationRun` is pending." + "The `AutomationRun` is pending.", + "The `AutomationRun` was aborted." ], "readOnly": true, "type": "string" @@ -2592,6 +2602,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -2602,6 +2613,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -2612,6 +2624,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3144,6 +3157,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3154,6 +3168,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -3164,6 +3179,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3691,6 +3707,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3701,6 +3718,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -3711,6 +3729,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4688,6 +4707,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -4698,6 +4718,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -4708,6 +4729,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4768,6 +4790,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -4778,6 +4801,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -4788,6 +4812,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4967,7 +4992,8 @@ "REPAIR_STATE_FAILED", "REPAIR_STATE_IN_PROGRESS", "REPAIR_STATE_PENDING", - "REPAIR_STATE_SKIPPED" + "REPAIR_STATE_SKIPPED", + "REPAIR_STATE_ABORTED" ], "enumDescriptions": [ "The `repair` has an unspecified state.", @@ -4976,7 +5002,8 @@ "The `repair` action has failed.", "The `repair` action is in progress.", "The `repair` action is pending.", - "The `repair` action was skipped." + "The `repair` action was skipped.", + "The `repair` action was aborted." ], "readOnly": true, "type": "string" @@ -5098,7 +5125,8 @@ "REPAIR_STATE_FAILED", "REPAIR_STATE_IN_PROGRESS", "REPAIR_STATE_PENDING", - "REPAIR_STATE_SKIPPED" + "REPAIR_STATE_SKIPPED", + "REPAIR_STATE_ABORTED" ], "enumDescriptions": [ "The `repair` has an unspecified state.", @@ -5107,7 +5135,8 @@ "The `repair` action has failed.", "The `repair` action is in progress.", "The `repair` action is pending.", - "The `repair` action was skipped." + "The `repair` action was skipped.", + "The `repair` action was aborted." ], "readOnly": true, "type": "string" @@ -5409,6 +5438,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -5419,6 +5449,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -5429,6 +5460,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -5510,6 +5542,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -5520,6 +5553,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -5530,6 +5564,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -5972,6 +6007,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -5982,6 +6018,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -5992,6 +6029,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" diff --git a/src/apis/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index 6b9826c338e..e9361dbde82 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -343,6 +343,10 @@ export namespace clouddeploy_v1 { * Output only. The IDs of the AutomationRuns initiated by an advance rollout rule. */ advanceAutomationRuns?: string[] | null; + /** + * Output only. The current AutomationRun repairing the rollout. + */ + currentRepairAutomationRun?: string | null; /** * Output only. The ID of the AutomationRun initiated by a promote release rule. */ From d94398def4c4fc9e4bd21dab46dcd2888e249375 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:48 +0000 Subject: [PATCH 19/78] feat(cloudfunctions): update the API #### cloudfunctions:v2alpha The following keys were added: - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.description - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.location - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.type The following keys were changed: - schemas.BuildConfig.properties.dockerRegistry.description #### cloudfunctions:v2beta The following keys were added: - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.description - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.location - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.type The following keys were changed: - schemas.BuildConfig.properties.dockerRegistry.description #### cloudfunctions:v2 The following keys were added: - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.description - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.location - resources.projects.resources.locations.resources.functions.methods.get.parameters.revision.type The following keys were changed: - schemas.BuildConfig.properties.dockerRegistry.description --- discovery/cloudfunctions-v2.json | 9 +++++++-- discovery/cloudfunctions-v2alpha.json | 9 +++++++-- discovery/cloudfunctions-v2beta.json | 9 +++++++-- src/apis/cloudfunctions/v2.ts | 6 +++++- src/apis/cloudfunctions/v2alpha.ts | 6 +++++- src/apis/cloudfunctions/v2beta.ts | 6 +++++- 6 files changed, 36 insertions(+), 9 deletions(-) diff --git a/discovery/cloudfunctions-v2.json b/discovery/cloudfunctions-v2.json index f38d00f3861..6980ccc1787 100644 --- a/discovery/cloudfunctions-v2.json +++ b/discovery/cloudfunctions-v2.json @@ -339,6 +339,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", "required": true, "type": "string" + }, + "revision": { + "description": "Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function.", + "location": "query", + "type": "string" } }, "path": "v2/{+name}", @@ -711,7 +716,7 @@ } } }, - "revision": "20240220", + "revision": "20240307", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -809,7 +814,7 @@ "type": "string" }, "dockerRegistry": { - "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If `docker_repository` field is specified, this field will be automatically set as `ARTIFACT_REGISTRY`. If unspecified, it currently defaults to `CONTAINER_REGISTRY`. This field may be overridden by the backend for eligible deployments.", + "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", "enum": [ "DOCKER_REGISTRY_UNSPECIFIED", "CONTAINER_REGISTRY", diff --git a/discovery/cloudfunctions-v2alpha.json b/discovery/cloudfunctions-v2alpha.json index 9bc635ace1b..5b9cbfb7efd 100644 --- a/discovery/cloudfunctions-v2alpha.json +++ b/discovery/cloudfunctions-v2alpha.json @@ -339,6 +339,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", "required": true, "type": "string" + }, + "revision": { + "description": "Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function.", + "location": "query", + "type": "string" } }, "path": "v2alpha/{+name}", @@ -711,7 +716,7 @@ } } }, - "revision": "20240220", + "revision": "20240307", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -809,7 +814,7 @@ "type": "string" }, "dockerRegistry": { - "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If `docker_repository` field is specified, this field will be automatically set as `ARTIFACT_REGISTRY`. If unspecified, it currently defaults to `CONTAINER_REGISTRY`. This field may be overridden by the backend for eligible deployments.", + "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", "enum": [ "DOCKER_REGISTRY_UNSPECIFIED", "CONTAINER_REGISTRY", diff --git a/discovery/cloudfunctions-v2beta.json b/discovery/cloudfunctions-v2beta.json index 1c069ff3350..899d18f150d 100644 --- a/discovery/cloudfunctions-v2beta.json +++ b/discovery/cloudfunctions-v2beta.json @@ -339,6 +339,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", "required": true, "type": "string" + }, + "revision": { + "description": "Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function.", + "location": "query", + "type": "string" } }, "path": "v2beta/{+name}", @@ -711,7 +716,7 @@ } } }, - "revision": "20240220", + "revision": "20240307", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -809,7 +814,7 @@ "type": "string" }, "dockerRegistry": { - "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If `docker_repository` field is specified, this field will be automatically set as `ARTIFACT_REGISTRY`. If unspecified, it currently defaults to `CONTAINER_REGISTRY`. This field may be overridden by the backend for eligible deployments.", + "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", "enum": [ "DOCKER_REGISTRY_UNSPECIFIED", "CONTAINER_REGISTRY", diff --git a/src/apis/cloudfunctions/v2.ts b/src/apis/cloudfunctions/v2.ts index a26b6d78e62..62713dc367a 100644 --- a/src/apis/cloudfunctions/v2.ts +++ b/src/apis/cloudfunctions/v2.ts @@ -185,7 +185,7 @@ export namespace cloudfunctions_v2 { */ build?: string | null; /** - * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If `docker_repository` field is specified, this field will be automatically set as `ARTIFACT_REGISTRY`. If unspecified, it currently defaults to `CONTAINER_REGISTRY`. This field may be overridden by the backend for eligible deployments. + * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */ dockerRegistry?: string | null; /** @@ -2813,6 +2813,10 @@ export namespace cloudfunctions_v2 { * Required. The name of the function which details should be obtained. */ name?: string; + /** + * Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function. + */ + revision?: string; } export interface Params$Resource$Projects$Locations$Functions$Getiampolicy extends StandardParameters { diff --git a/src/apis/cloudfunctions/v2alpha.ts b/src/apis/cloudfunctions/v2alpha.ts index a7721d35100..d5100d4fa94 100644 --- a/src/apis/cloudfunctions/v2alpha.ts +++ b/src/apis/cloudfunctions/v2alpha.ts @@ -185,7 +185,7 @@ export namespace cloudfunctions_v2alpha { */ build?: string | null; /** - * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If `docker_repository` field is specified, this field will be automatically set as `ARTIFACT_REGISTRY`. If unspecified, it currently defaults to `CONTAINER_REGISTRY`. This field may be overridden by the backend for eligible deployments. + * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */ dockerRegistry?: string | null; /** @@ -2812,6 +2812,10 @@ export namespace cloudfunctions_v2alpha { * Required. The name of the function which details should be obtained. */ name?: string; + /** + * Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function. + */ + revision?: string; } export interface Params$Resource$Projects$Locations$Functions$Getiampolicy extends StandardParameters { diff --git a/src/apis/cloudfunctions/v2beta.ts b/src/apis/cloudfunctions/v2beta.ts index e12f4f38801..c5b3a554ed5 100644 --- a/src/apis/cloudfunctions/v2beta.ts +++ b/src/apis/cloudfunctions/v2beta.ts @@ -185,7 +185,7 @@ export namespace cloudfunctions_v2beta { */ build?: string | null; /** - * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If `docker_repository` field is specified, this field will be automatically set as `ARTIFACT_REGISTRY`. If unspecified, it currently defaults to `CONTAINER_REGISTRY`. This field may be overridden by the backend for eligible deployments. + * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */ dockerRegistry?: string | null; /** @@ -2812,6 +2812,10 @@ export namespace cloudfunctions_v2beta { * Required. The name of the function which details should be obtained. */ name?: string; + /** + * Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function. + */ + revision?: string; } export interface Params$Resource$Projects$Locations$Functions$Getiampolicy extends StandardParameters { From ba88c53f37a67b2830c2ab992832a0caa54d51c0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:48 +0000 Subject: [PATCH 20/78] feat(cloudidentity): update the API #### cloudidentity:v1beta1 The following keys were added: - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.id - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.chromeBrowserInfo.$ref - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.chromeBrowserInfo.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.chromeProfileId.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.chromeProfileId.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.lastProfileSyncTime.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.lastProfileSyncTime.format - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.lastProfileSyncTime.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.id - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.enum - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.enumDescriptions - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.readOnly - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserVersion.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserVersion.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isBuiltInDnsClientEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isBuiltInDnsClientEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isBulkDataEntryAnalysisEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isBulkDataEntryAnalysisEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isChromeCleanupEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isChromeCleanupEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isChromeRemoteDesktopAppBlocked.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isChromeRemoteDesktopAppBlocked.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isFileDownloadAnalysisEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isFileDownloadAnalysisEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isFileUploadAnalysisEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isFileUploadAnalysisEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isRealtimeUrlCheckEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isRealtimeUrlCheckEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isSecurityEventAnalysisEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isSecurityEventAnalysisEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isSiteIsolationEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isSiteIsolationEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isThirdPartyBlockingEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isThirdPartyBlockingEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.passwordProtectionWarningTrigger.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.passwordProtectionWarningTrigger.enum - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.passwordProtectionWarningTrigger.enumDescriptions - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.passwordProtectionWarningTrigger.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.safeBrowsingProtectionLevel.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.safeBrowsingProtectionLevel.enum - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.safeBrowsingProtectionLevel.enumDescriptions - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.safeBrowsingProtectionLevel.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.id - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.certificateTemplate.$ref - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.certificateTemplate.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.fingerprint.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.fingerprint.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.issuer.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.issuer.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.serialNumber.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.serialNumber.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.subject.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.subject.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.thumbprint.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.thumbprint.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.enum - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.enumDescriptions - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.readOnly - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityExpirationTime.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityExpirationTime.format - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityExpirationTime.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityStartTime.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityStartTime.format - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityStartTime.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.id - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.id.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.id.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.majorVersion.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.majorVersion.format - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.majorVersion.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.minorVersion.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.minorVersion.format - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.minorVersion.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.type - schemas.GoogleAppsCloudidentityDevicesV1Device.properties.endpointVerificationSpecificAttributes.$ref - schemas.GoogleAppsCloudidentityDevicesV1Device.properties.endpointVerificationSpecificAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1Device.properties.endpointVerificationSpecificAttributes.readOnly - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.id - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.additionalSignals.additionalProperties.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.additionalSignals.additionalProperties.type - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.additionalSignals.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.additionalSignals.type - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.browserAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.browserAttributes.items.$ref - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.browserAttributes.type - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.certificateAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.certificateAttributes.items.$ref - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.certificateAttributes.type - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.type #### cloudidentity:v1 The following keys were added: - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.id - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.chromeBrowserInfo.$ref - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.chromeBrowserInfo.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.chromeProfileId.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.chromeProfileId.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.lastProfileSyncTime.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.lastProfileSyncTime.format - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.properties.lastProfileSyncTime.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserAttributes.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.id - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.enum - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.enumDescriptions - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.readOnly - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserManagementState.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserVersion.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.browserVersion.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isBuiltInDnsClientEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isBuiltInDnsClientEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isBulkDataEntryAnalysisEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isBulkDataEntryAnalysisEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isChromeCleanupEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isChromeCleanupEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isChromeRemoteDesktopAppBlocked.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isChromeRemoteDesktopAppBlocked.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isFileDownloadAnalysisEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isFileDownloadAnalysisEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isFileUploadAnalysisEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isFileUploadAnalysisEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isRealtimeUrlCheckEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isRealtimeUrlCheckEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isSecurityEventAnalysisEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isSecurityEventAnalysisEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isSiteIsolationEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isSiteIsolationEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isThirdPartyBlockingEnabled.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.isThirdPartyBlockingEnabled.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.passwordProtectionWarningTrigger.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.passwordProtectionWarningTrigger.enum - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.passwordProtectionWarningTrigger.enumDescriptions - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.passwordProtectionWarningTrigger.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.safeBrowsingProtectionLevel.description - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.safeBrowsingProtectionLevel.enum - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.safeBrowsingProtectionLevel.enumDescriptions - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.properties.safeBrowsingProtectionLevel.type - schemas.GoogleAppsCloudidentityDevicesV1BrowserInfo.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.id - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.certificateTemplate.$ref - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.certificateTemplate.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.fingerprint.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.fingerprint.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.issuer.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.issuer.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.serialNumber.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.serialNumber.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.subject.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.subject.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.thumbprint.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.thumbprint.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.enum - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.enumDescriptions - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.readOnly - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validationState.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityExpirationTime.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityExpirationTime.format - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityExpirationTime.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityStartTime.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityStartTime.format - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.properties.validityStartTime.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateAttributes.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.id - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.id.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.id.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.majorVersion.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.majorVersion.format - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.majorVersion.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.minorVersion.description - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.minorVersion.format - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.properties.minorVersion.type - schemas.GoogleAppsCloudidentityDevicesV1CertificateTemplate.type - schemas.GoogleAppsCloudidentityDevicesV1Device.properties.endpointVerificationSpecificAttributes.$ref - schemas.GoogleAppsCloudidentityDevicesV1Device.properties.endpointVerificationSpecificAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1Device.properties.endpointVerificationSpecificAttributes.readOnly - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.id - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.additionalSignals.additionalProperties.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.additionalSignals.additionalProperties.type - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.additionalSignals.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.additionalSignals.type - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.browserAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.browserAttributes.items.$ref - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.browserAttributes.type - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.certificateAttributes.description - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.certificateAttributes.items.$ref - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.properties.certificateAttributes.type - schemas.GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes.type --- discovery/cloudidentity-v1.json | 235 ++++++++++++++++++++++++++- discovery/cloudidentity-v1beta1.json | 235 ++++++++++++++++++++++++++- src/apis/cloudidentity/v1.ts | 157 ++++++++++++++++++ src/apis/cloudidentity/v1beta1.ts | 157 ++++++++++++++++++ 4 files changed, 782 insertions(+), 2 deletions(-) diff --git a/discovery/cloudidentity-v1.json b/discovery/cloudidentity-v1.json index 475556fba10..cfa1ea056ca 100644 --- a/discovery/cloudidentity-v1.json +++ b/discovery/cloudidentity-v1.json @@ -1990,7 +1990,7 @@ } } }, - "revision": "20240206", + "revision": "20240312", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -2324,6 +2324,128 @@ }, "type": "object" }, + "GoogleAppsCloudidentityDevicesV1BrowserAttributes": { + "description": "Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", + "id": "GoogleAppsCloudidentityDevicesV1BrowserAttributes", + "properties": { + "chromeBrowserInfo": { + "$ref": "GoogleAppsCloudidentityDevicesV1BrowserInfo", + "description": "Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)." + }, + "chromeProfileId": { + "description": "Chrome profile ID that is exposed by the Chrome API. It is unique for each device.", + "type": "string" + }, + "lastProfileSyncTime": { + "description": "Timestamp in milliseconds since Epoch when the profile/gcm id was last synced.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAppsCloudidentityDevicesV1BrowserInfo": { + "description": "Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). LINT.IfChange", + "id": "GoogleAppsCloudidentityDevicesV1BrowserInfo", + "properties": { + "browserManagementState": { + "description": "Output only. Browser's management state.", + "enum": [ + "UNSPECIFIED", + "UNMANAGED", + "MANAGED_BY_OTHER_DOMAIN", + "PROFILE_MANAGED", + "BROWSER_MANAGED" + ], + "enumDescriptions": [ + "Management state is not specified.", + "Browser/Profile is not managed by any customer.", + "Browser/Profile is managed, but by some other customer.", + "Profile is managed by customer.", + "Browser is managed by customer." + ], + "readOnly": true, + "type": "string" + }, + "browserVersion": { + "description": "Version of the request initiating browser.", + "type": "string" + }, + "isBuiltInDnsClientEnabled": { + "description": "Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled).", + "type": "boolean" + }, + "isBulkDataEntryAnalysisEnabled": { + "description": "Current state of [bulk data analysis](https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isChromeCleanupEnabled": { + "description": "Current state of [Chrome Cleanup](https://chromeenterprise.google/policies/#ChromeCleanupEnabled).", + "type": "boolean" + }, + "isChromeRemoteDesktopAppBlocked": { + "description": "Current state of [Chrome Remote Desktop app](https://chromeenterprise.google/policies/#URLBlocklist).", + "type": "boolean" + }, + "isFileDownloadAnalysisEnabled": { + "description": "Current state of [file download analysis](https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isFileUploadAnalysisEnabled": { + "description": "Current state of [file upload analysis](https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isRealtimeUrlCheckEnabled": { + "description": "Current state of [real-time URL check](https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isSecurityEventAnalysisEnabled": { + "description": "Current state of [security event analysis](https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isSiteIsolationEnabled": { + "description": "Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins).", + "type": "boolean" + }, + "isThirdPartyBlockingEnabled": { + "description": "Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled).", + "type": "boolean" + }, + "passwordProtectionWarningTrigger": { + "description": "Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger).", + "enum": [ + "PASSWORD_PROTECTION_TRIGGER_UNSPECIFIED", + "PROTECTION_OFF", + "PASSWORD_REUSE", + "PHISHING_REUSE" + ], + "enumDescriptions": [ + "Password protection is not specified.", + "Password reuse is never detected.", + "Warning is shown when the user reuses their protected password on a non-allowed site.", + "Warning is shown when the user reuses their protected password on a phishing site." + ], + "type": "string" + }, + "safeBrowsingProtectionLevel": { + "description": "Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel).", + "enum": [ + "SAFE_BROWSING_LEVEL_UNSPECIFIED", + "DISABLED", + "STANDARD", + "ENHANCED" + ], + "enumDescriptions": [ + "Browser protection level is not specified.", + "No protection against dangerous websites, downloads, and extensions.", + "Standard protection against websites, downloads, and extensions that are known to be dangerous.", + "Faster, proactive protection against dangerous websites, downloads, and extensions." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleAppsCloudidentityDevicesV1CancelWipeDeviceMetadata": { "description": "Metadata for CancelWipeDevice LRO.", "id": "GoogleAppsCloudidentityDevicesV1CancelWipeDeviceMetadata", @@ -2380,6 +2502,83 @@ }, "type": "object" }, + "GoogleAppsCloudidentityDevicesV1CertificateAttributes": { + "description": "Stores information about a certificate.", + "id": "GoogleAppsCloudidentityDevicesV1CertificateAttributes", + "properties": { + "certificateTemplate": { + "$ref": "GoogleAppsCloudidentityDevicesV1CertificateTemplate", + "description": "The X.509 extension for CertificateTemplate." + }, + "fingerprint": { + "description": "The encoded certificate fingerprint.", + "type": "string" + }, + "issuer": { + "description": "The name of the issuer of this certificate.", + "type": "string" + }, + "serialNumber": { + "description": "Serial number of the certificate, Example: \"123456789\".", + "type": "string" + }, + "subject": { + "description": "The subject name of this certificate.", + "type": "string" + }, + "thumbprint": { + "description": "The certificate thumbprint.", + "type": "string" + }, + "validationState": { + "description": "Output only. Validation state of this certificate.", + "enum": [ + "CERTIFICATE_VALIDATION_STATE_UNSPECIFIED", + "VALIDATION_SUCCESSFUL", + "VALIDATION_FAILED" + ], + "enumDescriptions": [ + "Default value.", + "Certificate validation was successful.", + "Certificate validation failed." + ], + "readOnly": true, + "type": "string" + }, + "validityExpirationTime": { + "description": "Certificate not valid at or after this timestamp.", + "format": "google-datetime", + "type": "string" + }, + "validityStartTime": { + "description": "Certificate not valid before this timestamp.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAppsCloudidentityDevicesV1CertificateTemplate": { + "description": "CertificateTemplate (v3 Extension in X.509).", + "id": "GoogleAppsCloudidentityDevicesV1CertificateTemplate", + "properties": { + "id": { + "description": "The template id of the template. Example: \"1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047\".", + "type": "string" + }, + "majorVersion": { + "description": "The Major version of the template. Example: 100.", + "format": "int32", + "type": "integer" + }, + "minorVersion": { + "description": "The minor version of the template. Example: 12.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleAppsCloudidentityDevicesV1ClientState": { "description": "Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users", "id": "GoogleAppsCloudidentityDevicesV1ClientState", @@ -2641,6 +2840,11 @@ "readOnly": true, "type": "string" }, + "endpointVerificationSpecificAttributes": { + "$ref": "GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes", + "description": "Output only. Attributes specific to [Endpoint Verification](https://cloud.google.com/endpoint-verification/docs/overview) devices.", + "readOnly": true + }, "hostname": { "description": "Host name of the device.", "type": "string" @@ -2855,6 +3059,35 @@ }, "type": "object" }, + "GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes": { + "description": "Resource representing the [Endpoint Verification-specific attributes](https://cloud.google.com/endpoint-verification/docs/device-information) of a device.", + "id": "GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes", + "properties": { + "additionalSignals": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist.", + "type": "object" + }, + "browserAttributes": { + "description": "Details of browser profiles reported by Endpoint Verification.", + "items": { + "$ref": "GoogleAppsCloudidentityDevicesV1BrowserAttributes" + }, + "type": "array" + }, + "certificateAttributes": { + "description": "Details of certificates.", + "items": { + "$ref": "GoogleAppsCloudidentityDevicesV1CertificateAttributes" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleAppsCloudidentityDevicesV1ListClientStatesResponse": { "description": "Response message that is returned in ListClientStates.", "id": "GoogleAppsCloudidentityDevicesV1ListClientStatesResponse", diff --git a/discovery/cloudidentity-v1beta1.json b/discovery/cloudidentity-v1beta1.json index 893243ca6df..33aab99f845 100644 --- a/discovery/cloudidentity-v1beta1.json +++ b/discovery/cloudidentity-v1beta1.json @@ -2015,7 +2015,7 @@ } } }, - "revision": "20240206", + "revision": "20240312", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -3162,6 +3162,128 @@ }, "type": "object" }, + "GoogleAppsCloudidentityDevicesV1BrowserAttributes": { + "description": "Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", + "id": "GoogleAppsCloudidentityDevicesV1BrowserAttributes", + "properties": { + "chromeBrowserInfo": { + "$ref": "GoogleAppsCloudidentityDevicesV1BrowserInfo", + "description": "Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)." + }, + "chromeProfileId": { + "description": "Chrome profile ID that is exposed by the Chrome API. It is unique for each device.", + "type": "string" + }, + "lastProfileSyncTime": { + "description": "Timestamp in milliseconds since Epoch when the profile/gcm id was last synced.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAppsCloudidentityDevicesV1BrowserInfo": { + "description": "Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). LINT.IfChange", + "id": "GoogleAppsCloudidentityDevicesV1BrowserInfo", + "properties": { + "browserManagementState": { + "description": "Output only. Browser's management state.", + "enum": [ + "UNSPECIFIED", + "UNMANAGED", + "MANAGED_BY_OTHER_DOMAIN", + "PROFILE_MANAGED", + "BROWSER_MANAGED" + ], + "enumDescriptions": [ + "Management state is not specified.", + "Browser/Profile is not managed by any customer.", + "Browser/Profile is managed, but by some other customer.", + "Profile is managed by customer.", + "Browser is managed by customer." + ], + "readOnly": true, + "type": "string" + }, + "browserVersion": { + "description": "Version of the request initiating browser.", + "type": "string" + }, + "isBuiltInDnsClientEnabled": { + "description": "Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled).", + "type": "boolean" + }, + "isBulkDataEntryAnalysisEnabled": { + "description": "Current state of [bulk data analysis](https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isChromeCleanupEnabled": { + "description": "Current state of [Chrome Cleanup](https://chromeenterprise.google/policies/#ChromeCleanupEnabled).", + "type": "boolean" + }, + "isChromeRemoteDesktopAppBlocked": { + "description": "Current state of [Chrome Remote Desktop app](https://chromeenterprise.google/policies/#URLBlocklist).", + "type": "boolean" + }, + "isFileDownloadAnalysisEnabled": { + "description": "Current state of [file download analysis](https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isFileUploadAnalysisEnabled": { + "description": "Current state of [file upload analysis](https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isRealtimeUrlCheckEnabled": { + "description": "Current state of [real-time URL check](https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isSecurityEventAnalysisEnabled": { + "description": "Current state of [security event analysis](https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector). Set to true if provider list from Chrome is non-empty.", + "type": "boolean" + }, + "isSiteIsolationEnabled": { + "description": "Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins).", + "type": "boolean" + }, + "isThirdPartyBlockingEnabled": { + "description": "Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled).", + "type": "boolean" + }, + "passwordProtectionWarningTrigger": { + "description": "Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger).", + "enum": [ + "PASSWORD_PROTECTION_TRIGGER_UNSPECIFIED", + "PROTECTION_OFF", + "PASSWORD_REUSE", + "PHISHING_REUSE" + ], + "enumDescriptions": [ + "Password protection is not specified.", + "Password reuse is never detected.", + "Warning is shown when the user reuses their protected password on a non-allowed site.", + "Warning is shown when the user reuses their protected password on a phishing site." + ], + "type": "string" + }, + "safeBrowsingProtectionLevel": { + "description": "Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel).", + "enum": [ + "SAFE_BROWSING_LEVEL_UNSPECIFIED", + "DISABLED", + "STANDARD", + "ENHANCED" + ], + "enumDescriptions": [ + "Browser protection level is not specified.", + "No protection against dangerous websites, downloads, and extensions.", + "Standard protection against websites, downloads, and extensions that are known to be dangerous.", + "Faster, proactive protection against dangerous websites, downloads, and extensions." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleAppsCloudidentityDevicesV1CancelWipeDeviceMetadata": { "description": "Metadata for CancelWipeDevice LRO.", "id": "GoogleAppsCloudidentityDevicesV1CancelWipeDeviceMetadata", @@ -3196,6 +3318,83 @@ }, "type": "object" }, + "GoogleAppsCloudidentityDevicesV1CertificateAttributes": { + "description": "Stores information about a certificate.", + "id": "GoogleAppsCloudidentityDevicesV1CertificateAttributes", + "properties": { + "certificateTemplate": { + "$ref": "GoogleAppsCloudidentityDevicesV1CertificateTemplate", + "description": "The X.509 extension for CertificateTemplate." + }, + "fingerprint": { + "description": "The encoded certificate fingerprint.", + "type": "string" + }, + "issuer": { + "description": "The name of the issuer of this certificate.", + "type": "string" + }, + "serialNumber": { + "description": "Serial number of the certificate, Example: \"123456789\".", + "type": "string" + }, + "subject": { + "description": "The subject name of this certificate.", + "type": "string" + }, + "thumbprint": { + "description": "The certificate thumbprint.", + "type": "string" + }, + "validationState": { + "description": "Output only. Validation state of this certificate.", + "enum": [ + "CERTIFICATE_VALIDATION_STATE_UNSPECIFIED", + "VALIDATION_SUCCESSFUL", + "VALIDATION_FAILED" + ], + "enumDescriptions": [ + "Default value.", + "Certificate validation was successful.", + "Certificate validation failed." + ], + "readOnly": true, + "type": "string" + }, + "validityExpirationTime": { + "description": "Certificate not valid at or after this timestamp.", + "format": "google-datetime", + "type": "string" + }, + "validityStartTime": { + "description": "Certificate not valid before this timestamp.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAppsCloudidentityDevicesV1CertificateTemplate": { + "description": "CertificateTemplate (v3 Extension in X.509).", + "id": "GoogleAppsCloudidentityDevicesV1CertificateTemplate", + "properties": { + "id": { + "description": "The template id of the template. Example: \"1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047\".", + "type": "string" + }, + "majorVersion": { + "description": "The Major version of the template. Example: 100.", + "format": "int32", + "type": "integer" + }, + "minorVersion": { + "description": "The minor version of the template. Example: 12.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleAppsCloudidentityDevicesV1ClientState": { "description": "Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users", "id": "GoogleAppsCloudidentityDevicesV1ClientState", @@ -3457,6 +3656,11 @@ "readOnly": true, "type": "string" }, + "endpointVerificationSpecificAttributes": { + "$ref": "GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes", + "description": "Output only. Attributes specific to [Endpoint Verification](https://cloud.google.com/endpoint-verification/docs/overview) devices.", + "readOnly": true + }, "hostname": { "description": "Host name of the device.", "type": "string" @@ -3671,6 +3875,35 @@ }, "type": "object" }, + "GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes": { + "description": "Resource representing the [Endpoint Verification-specific attributes](https://cloud.google.com/endpoint-verification/docs/device-information) of a device.", + "id": "GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes", + "properties": { + "additionalSignals": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist.", + "type": "object" + }, + "browserAttributes": { + "description": "Details of browser profiles reported by Endpoint Verification.", + "items": { + "$ref": "GoogleAppsCloudidentityDevicesV1BrowserAttributes" + }, + "type": "array" + }, + "certificateAttributes": { + "description": "Details of certificates.", + "items": { + "$ref": "GoogleAppsCloudidentityDevicesV1CertificateAttributes" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleAppsCloudidentityDevicesV1ListEndpointAppsMetadata": { "description": "Metadata for ListEndpointApps LRO.", "id": "GoogleAppsCloudidentityDevicesV1ListEndpointAppsMetadata", diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 361ec93f4b6..db7af8e8dd2 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -366,6 +366,84 @@ export namespace cloudidentity_v1 { */ deviceUser?: Schema$GoogleAppsCloudidentityDevicesV1DeviceUser; } + /** + * Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1BrowserAttributes { + /** + * Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + */ + chromeBrowserInfo?: Schema$GoogleAppsCloudidentityDevicesV1BrowserInfo; + /** + * Chrome profile ID that is exposed by the Chrome API. It is unique for each device. + */ + chromeProfileId?: string | null; + /** + * Timestamp in milliseconds since Epoch when the profile/gcm id was last synced. + */ + lastProfileSyncTime?: string | null; + } + /** + * Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). LINT.IfChange + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1BrowserInfo { + /** + * Output only. Browser's management state. + */ + browserManagementState?: string | null; + /** + * Version of the request initiating browser. + */ + browserVersion?: string | null; + /** + * Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled). + */ + isBuiltInDnsClientEnabled?: boolean | null; + /** + * Current state of [bulk data analysis](https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + */ + isBulkDataEntryAnalysisEnabled?: boolean | null; + /** + * Current state of [Chrome Cleanup](https://chromeenterprise.google/policies/#ChromeCleanupEnabled). + */ + isChromeCleanupEnabled?: boolean | null; + /** + * Current state of [Chrome Remote Desktop app](https://chromeenterprise.google/policies/#URLBlocklist). + */ + isChromeRemoteDesktopAppBlocked?: boolean | null; + /** + * Current state of [file download analysis](https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + */ + isFileDownloadAnalysisEnabled?: boolean | null; + /** + * Current state of [file upload analysis](https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + */ + isFileUploadAnalysisEnabled?: boolean | null; + /** + * Current state of [real-time URL check](https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode). Set to true if provider list from Chrome is non-empty. + */ + isRealtimeUrlCheckEnabled?: boolean | null; + /** + * Current state of [security event analysis](https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + */ + isSecurityEventAnalysisEnabled?: boolean | null; + /** + * Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins). + */ + isSiteIsolationEnabled?: boolean | null; + /** + * Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled). + */ + isThirdPartyBlockingEnabled?: boolean | null; + /** + * Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger). + */ + passwordProtectionWarningTrigger?: string | null; + /** + * Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel). + */ + safeBrowsingProtectionLevel?: string | null; + } /** * Metadata for CancelWipeDevice LRO. */ @@ -410,6 +488,64 @@ export namespace cloudidentity_v1 { */ deviceUser?: Schema$GoogleAppsCloudidentityDevicesV1DeviceUser; } + /** + * Stores information about a certificate. + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1CertificateAttributes { + /** + * The X.509 extension for CertificateTemplate. + */ + certificateTemplate?: Schema$GoogleAppsCloudidentityDevicesV1CertificateTemplate; + /** + * The encoded certificate fingerprint. + */ + fingerprint?: string | null; + /** + * The name of the issuer of this certificate. + */ + issuer?: string | null; + /** + * Serial number of the certificate, Example: "123456789". + */ + serialNumber?: string | null; + /** + * The subject name of this certificate. + */ + subject?: string | null; + /** + * The certificate thumbprint. + */ + thumbprint?: string | null; + /** + * Output only. Validation state of this certificate. + */ + validationState?: string | null; + /** + * Certificate not valid at or after this timestamp. + */ + validityExpirationTime?: string | null; + /** + * Certificate not valid before this timestamp. + */ + validityStartTime?: string | null; + } + /** + * CertificateTemplate (v3 Extension in X.509). + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1CertificateTemplate { + /** + * The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047". + */ + id?: string | null; + /** + * The Major version of the template. Example: 100. + */ + majorVersion?: number | null; + /** + * The minor version of the template. Example: 12. + */ + minorVersion?: number | null; + } /** * Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users */ @@ -552,6 +688,10 @@ export namespace cloudidentity_v1 { * Output only. Device encryption state. */ encryptionState?: string | null; + /** + * Output only. Attributes specific to [Endpoint Verification](https://cloud.google.com/endpoint-verification/docs/overview) devices. + */ + endpointVerificationSpecificAttributes?: Schema$GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes; /** * Host name of the device. */ @@ -666,6 +806,23 @@ export namespace cloudidentity_v1 { */ userEmail?: string | null; } + /** + * Resource representing the [Endpoint Verification-specific attributes](https://cloud.google.com/endpoint-verification/docs/device-information) of a device. + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes { + /** + * Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist. + */ + additionalSignals?: {[key: string]: any} | null; + /** + * Details of browser profiles reported by Endpoint Verification. + */ + browserAttributes?: Schema$GoogleAppsCloudidentityDevicesV1BrowserAttributes[]; + /** + * Details of certificates. + */ + certificateAttributes?: Schema$GoogleAppsCloudidentityDevicesV1CertificateAttributes[]; + } /** * Response message that is returned in ListClientStates. */ diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 33b2303ea9d..e0fbba8100b 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -850,6 +850,84 @@ export namespace cloudidentity_v1beta1 { */ deviceUser?: Schema$GoogleAppsCloudidentityDevicesV1DeviceUser; } + /** + * Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1BrowserAttributes { + /** + * Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + */ + chromeBrowserInfo?: Schema$GoogleAppsCloudidentityDevicesV1BrowserInfo; + /** + * Chrome profile ID that is exposed by the Chrome API. It is unique for each device. + */ + chromeProfileId?: string | null; + /** + * Timestamp in milliseconds since Epoch when the profile/gcm id was last synced. + */ + lastProfileSyncTime?: string | null; + } + /** + * Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). LINT.IfChange + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1BrowserInfo { + /** + * Output only. Browser's management state. + */ + browserManagementState?: string | null; + /** + * Version of the request initiating browser. + */ + browserVersion?: string | null; + /** + * Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled). + */ + isBuiltInDnsClientEnabled?: boolean | null; + /** + * Current state of [bulk data analysis](https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + */ + isBulkDataEntryAnalysisEnabled?: boolean | null; + /** + * Current state of [Chrome Cleanup](https://chromeenterprise.google/policies/#ChromeCleanupEnabled). + */ + isChromeCleanupEnabled?: boolean | null; + /** + * Current state of [Chrome Remote Desktop app](https://chromeenterprise.google/policies/#URLBlocklist). + */ + isChromeRemoteDesktopAppBlocked?: boolean | null; + /** + * Current state of [file download analysis](https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + */ + isFileDownloadAnalysisEnabled?: boolean | null; + /** + * Current state of [file upload analysis](https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + */ + isFileUploadAnalysisEnabled?: boolean | null; + /** + * Current state of [real-time URL check](https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode). Set to true if provider list from Chrome is non-empty. + */ + isRealtimeUrlCheckEnabled?: boolean | null; + /** + * Current state of [security event analysis](https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + */ + isSecurityEventAnalysisEnabled?: boolean | null; + /** + * Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins). + */ + isSiteIsolationEnabled?: boolean | null; + /** + * Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled). + */ + isThirdPartyBlockingEnabled?: boolean | null; + /** + * Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger). + */ + passwordProtectionWarningTrigger?: string | null; + /** + * Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel). + */ + safeBrowsingProtectionLevel?: string | null; + } /** * Metadata for CancelWipeDevice LRO. */ @@ -876,6 +954,64 @@ export namespace cloudidentity_v1beta1 { */ deviceUser?: Schema$GoogleAppsCloudidentityDevicesV1DeviceUser; } + /** + * Stores information about a certificate. + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1CertificateAttributes { + /** + * The X.509 extension for CertificateTemplate. + */ + certificateTemplate?: Schema$GoogleAppsCloudidentityDevicesV1CertificateTemplate; + /** + * The encoded certificate fingerprint. + */ + fingerprint?: string | null; + /** + * The name of the issuer of this certificate. + */ + issuer?: string | null; + /** + * Serial number of the certificate, Example: "123456789". + */ + serialNumber?: string | null; + /** + * The subject name of this certificate. + */ + subject?: string | null; + /** + * The certificate thumbprint. + */ + thumbprint?: string | null; + /** + * Output only. Validation state of this certificate. + */ + validationState?: string | null; + /** + * Certificate not valid at or after this timestamp. + */ + validityExpirationTime?: string | null; + /** + * Certificate not valid before this timestamp. + */ + validityStartTime?: string | null; + } + /** + * CertificateTemplate (v3 Extension in X.509). + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1CertificateTemplate { + /** + * The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047". + */ + id?: string | null; + /** + * The Major version of the template. Example: 100. + */ + majorVersion?: number | null; + /** + * The minor version of the template. Example: 12. + */ + minorVersion?: number | null; + } /** * Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users */ @@ -1018,6 +1154,10 @@ export namespace cloudidentity_v1beta1 { * Output only. Device encryption state. */ encryptionState?: string | null; + /** + * Output only. Attributes specific to [Endpoint Verification](https://cloud.google.com/endpoint-verification/docs/overview) devices. + */ + endpointVerificationSpecificAttributes?: Schema$GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes; /** * Host name of the device. */ @@ -1132,6 +1272,23 @@ export namespace cloudidentity_v1beta1 { */ userEmail?: string | null; } + /** + * Resource representing the [Endpoint Verification-specific attributes](https://cloud.google.com/endpoint-verification/docs/device-information) of a device. + */ + export interface Schema$GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes { + /** + * Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist. + */ + additionalSignals?: {[key: string]: any} | null; + /** + * Details of browser profiles reported by Endpoint Verification. + */ + browserAttributes?: Schema$GoogleAppsCloudidentityDevicesV1BrowserAttributes[]; + /** + * Details of certificates. + */ + certificateAttributes?: Schema$GoogleAppsCloudidentityDevicesV1CertificateAttributes[]; + } /** * Metadata for ListEndpointApps LRO. */ From de01fce516bea73d0f2417cd1fd433dff0357a33 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:48 +0000 Subject: [PATCH 21/78] feat(cloudresourcemanager): update the API #### cloudresourcemanager:v2beta1 The following keys were added: - schemas.Folder.properties.tags.additionalProperties.type - schemas.Folder.properties.tags.description - schemas.Folder.properties.tags.type #### cloudresourcemanager:v1 The following keys were added: - schemas.Project.properties.tags.additionalProperties.type - schemas.Project.properties.tags.description - schemas.Project.properties.tags.type #### cloudresourcemanager:v2 The following keys were added: - schemas.Folder.properties.tags.additionalProperties.type - schemas.Folder.properties.tags.description - schemas.Folder.properties.tags.type #### cloudresourcemanager:v3 The following keys were added: - schemas.Folder.properties.tags.additionalProperties.type - schemas.Folder.properties.tags.description - schemas.Folder.properties.tags.type - schemas.Project.properties.tags.additionalProperties.type - schemas.Project.properties.tags.description - schemas.Project.properties.tags.type --- discovery/cloudresourcemanager-v1.json | 9 ++++++++- discovery/cloudresourcemanager-v2.json | 9 ++++++++- discovery/cloudresourcemanager-v2beta1.json | 9 ++++++++- discovery/cloudresourcemanager-v3.json | 16 +++++++++++++++- src/apis/cloudresourcemanager/v1.ts | 4 ++++ src/apis/cloudresourcemanager/v2.ts | 4 ++++ src/apis/cloudresourcemanager/v2beta1.ts | 4 ++++ src/apis/cloudresourcemanager/v3.ts | 8 ++++++++ 8 files changed, 59 insertions(+), 4 deletions(-) diff --git a/discovery/cloudresourcemanager-v1.json b/discovery/cloudresourcemanager-v1.json index b937c55319f..909edf11909 100644 --- a/discovery/cloudresourcemanager-v1.json +++ b/discovery/cloudresourcemanager-v1.json @@ -1171,7 +1171,7 @@ } } }, - "revision": "20240128", + "revision": "20240310", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { @@ -2074,6 +2074,13 @@ "description": "The number uniquely identifying the project. Example: `415104041262` Read-only.", "format": "int64", "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this project. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.", + "type": "object" } }, "type": "object" diff --git a/discovery/cloudresourcemanager-v2.json b/discovery/cloudresourcemanager-v2.json index e124bd8463a..bf0506547a2 100644 --- a/discovery/cloudresourcemanager-v2.json +++ b/discovery/cloudresourcemanager-v2.json @@ -450,7 +450,7 @@ } } }, - "revision": "20240128", + "revision": "20240310", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -738,6 +738,13 @@ "parent": { "description": "Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.", "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.", + "type": "object" } }, "type": "object" diff --git a/discovery/cloudresourcemanager-v2beta1.json b/discovery/cloudresourcemanager-v2beta1.json index 5f80013d499..00a6dc248df 100644 --- a/discovery/cloudresourcemanager-v2beta1.json +++ b/discovery/cloudresourcemanager-v2beta1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20240128", + "revision": "20240310", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -738,6 +738,13 @@ "parent": { "description": "Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.", "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.", + "type": "object" } }, "type": "object" diff --git a/discovery/cloudresourcemanager-v3.json b/discovery/cloudresourcemanager-v3.json index 62f6eebb336..6f56849aa20 100644 --- a/discovery/cloudresourcemanager-v3.json +++ b/discovery/cloudresourcemanager-v3.json @@ -1805,7 +1805,7 @@ } } }, - "revision": "20240128", + "revision": "20240310", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -2142,6 +2142,13 @@ "readOnly": true, "type": "string" }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.", + "type": "object" + }, "updateTime": { "description": "Output only. Timestamp when the folder was last modified.", "format": "google-datetime", @@ -2653,6 +2660,13 @@ "readOnly": true, "type": "string" }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this project. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.", + "type": "object" + }, "updateTime": { "description": "Output only. The most recent time this resource was modified.", "format": "google-datetime", diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 1a0a528b7af..097df8bdee8 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -766,6 +766,10 @@ export namespace cloudresourcemanager_v1 { * The number uniquely identifying the project. Example: `415104041262` Read-only. */ projectNumber?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this project. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" Note: Currently this field is in Preview. + */ + tags?: {[key: string]: string} | null; } /** * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 5606d47e2cb..6b061a50236 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -322,6 +322,10 @@ export namespace cloudresourcemanager_v2 { * Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */ parent?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" Note: Currently this field is in Preview. + */ + tags?: {[key: string]: string} | null; } /** * Metadata describing a long running folder operation diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index eb404e11b44..10c85c88939 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -322,6 +322,10 @@ export namespace cloudresourcemanager_v2beta1 { * Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */ parent?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" Note: Currently this field is in Preview. + */ + tags?: {[key: string]: string} | null; } /** * Metadata describing a long running folder operation diff --git a/src/apis/cloudresourcemanager/v3.ts b/src/apis/cloudresourcemanager/v3.ts index 27947cb921c..93601406c66 100644 --- a/src/apis/cloudresourcemanager/v3.ts +++ b/src/apis/cloudresourcemanager/v3.ts @@ -377,6 +377,10 @@ export namespace cloudresourcemanager_v3 { * Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder. */ state?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" Note: Currently this field is in Preview. + */ + tags?: {[key: string]: string} | null; /** * Output only. Timestamp when the folder was last modified. */ @@ -725,6 +729,10 @@ export namespace cloudresourcemanager_v3 { * Output only. The project lifecycle state. */ state?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this project. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" Note: Currently this field is in Preview. + */ + tags?: {[key: string]: string} | null; /** * Output only. The most recent time this resource was modified. */ From ae1260a4fd045464e931c15f2229f0789b987a94 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:48 +0000 Subject: [PATCH 22/78] fix(cloudsupport): update the API #### cloudsupport:v2beta The following keys were changed: - resources.cases.methods.list.parameters.productLine.description - schemas.Case.description #### cloudsupport:v2 The following keys were changed: - schemas.Case.description --- discovery/cloudsupport-v2.json | 4 ++-- discovery/cloudsupport-v2beta.json | 6 +++--- src/apis/cloudsupport/v2.ts | 2 +- src/apis/cloudsupport/v2beta.ts | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/discovery/cloudsupport-v2.json b/discovery/cloudsupport-v2.json index e5e8c42be6d..cbcd5e00b74 100644 --- a/discovery/cloudsupport-v2.json +++ b/discovery/cloudsupport-v2.json @@ -552,7 +552,7 @@ } } }, - "revision": "20240221", + "revision": "20240312", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -650,7 +650,7 @@ "type": "object" }, "Case": { - "description": "A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510). Next ID: 38", + "description": "A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).", "id": "Case", "properties": { "classification": { diff --git a/discovery/cloudsupport-v2beta.json b/discovery/cloudsupport-v2beta.json index 9238624e7f7..734b6c8bfd8 100644 --- a/discovery/cloudsupport-v2beta.json +++ b/discovery/cloudsupport-v2beta.json @@ -305,7 +305,7 @@ "type": "string" }, "productLine": { - "description": "The product line to request cases for.", + "description": "The product line for which to request cases for. If unspecified, only Google Cloud cases will be returned.", "enum": [ "PRODUCT_LINE_UNSPECIFIED", "GOOGLE_CLOUD", @@ -583,7 +583,7 @@ } } }, - "revision": "20240221", + "revision": "20240312", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -681,7 +681,7 @@ "type": "object" }, "Case": { - "description": "A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510). Next ID: 38", + "description": "A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).", "id": "Case", "properties": { "classification": { diff --git a/src/apis/cloudsupport/v2.ts b/src/apis/cloudsupport/v2.ts index c3c1fc4692c..21437b58022 100644 --- a/src/apis/cloudsupport/v2.ts +++ b/src/apis/cloudsupport/v2.ts @@ -204,7 +204,7 @@ export namespace cloudsupport_v2 { uploadMetadataContainer?: string | null; } /** - * A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510). Next ID: 38 + * A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510). */ export interface Schema$Case { /** diff --git a/src/apis/cloudsupport/v2beta.ts b/src/apis/cloudsupport/v2beta.ts index e52c722203b..d8ef1018f67 100644 --- a/src/apis/cloudsupport/v2beta.ts +++ b/src/apis/cloudsupport/v2beta.ts @@ -204,7 +204,7 @@ export namespace cloudsupport_v2beta { uploadMetadataContainer?: string | null; } /** - * A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510). Next ID: 38 + * A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510). */ export interface Schema$Case { /** @@ -1548,7 +1548,7 @@ export namespace cloudsupport_v2beta { */ parent?: string; /** - * The product line to request cases for. + * The product line for which to request cases for. If unspecified, only Google Cloud cases will be returned. */ productLine?: string; } From aeed97f08644b1665b51a993bb4a6f9c8d43ee8b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:48 +0000 Subject: [PATCH 23/78] fix(cloudtasks): update the API #### cloudtasks:v2beta2 The following keys were changed: - schemas.HeaderOverride.properties.header.description - schemas.HttpTarget.properties.headerOverrides.description #### cloudtasks:v2beta3 The following keys were changed: - schemas.HeaderOverride.properties.header.description - schemas.HttpTarget.properties.headerOverrides.description #### cloudtasks:v2 The following keys were changed: - schemas.HeaderOverride.properties.header.description - schemas.HttpTarget.properties.headerOverrides.description --- discovery/cloudtasks-v2.json | 6 +++--- discovery/cloudtasks-v2beta2.json | 6 +++--- discovery/cloudtasks-v2beta3.json | 6 +++--- src/apis/cloudtasks/v2.ts | 4 ++-- src/apis/cloudtasks/v2beta2.ts | 4 ++-- src/apis/cloudtasks/v2beta3.ts | 4 ++-- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/discovery/cloudtasks-v2.json b/discovery/cloudtasks-v2.json index 10a8056ee4d..6b54a6db132 100644 --- a/discovery/cloudtasks-v2.json +++ b/discovery/cloudtasks-v2.json @@ -779,7 +779,7 @@ } } }, - "revision": "20240130", + "revision": "20240301", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { @@ -1040,7 +1040,7 @@ "properties": { "header": { "$ref": "Header", - "description": "header embodying a key and a value." + "description": "Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms)." } }, "type": "object" @@ -1132,7 +1132,7 @@ "id": "HttpTarget", "properties": { "headerOverrides": { - "description": "HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with \"X-CloudTasks-\", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. The default value is set to \"application/json\"`. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.", + "description": "HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with \"X-CloudTasks-\", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. The default value is set to \"application/json\"`. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).", "items": { "$ref": "HeaderOverride" }, diff --git a/discovery/cloudtasks-v2beta2.json b/discovery/cloudtasks-v2beta2.json index c9a027e3a65..d972dd359b9 100644 --- a/discovery/cloudtasks-v2beta2.json +++ b/discovery/cloudtasks-v2beta2.json @@ -935,7 +935,7 @@ } } }, - "revision": "20240207", + "revision": "20240301", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { @@ -1245,7 +1245,7 @@ "properties": { "header": { "$ref": "Header", - "description": "header embodying a key and a value." + "description": "Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms)." } }, "type": "object" @@ -1337,7 +1337,7 @@ "id": "HttpTarget", "properties": { "headerOverrides": { - "description": "HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with \"X-CloudTasks-\" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-CloudTasks\"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.", + "description": "HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with \"X-CloudTasks-\" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-CloudTasks\"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).", "items": { "$ref": "HeaderOverride" }, diff --git a/discovery/cloudtasks-v2beta3.json b/discovery/cloudtasks-v2beta3.json index a39dd08856f..3324507fde0 100644 --- a/discovery/cloudtasks-v2beta3.json +++ b/discovery/cloudtasks-v2beta3.json @@ -791,7 +791,7 @@ } } }, - "revision": "20240130", + "revision": "20240301", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { @@ -1063,7 +1063,7 @@ "properties": { "header": { "$ref": "Header", - "description": "header embodying a key and a value." + "description": "Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms)." } }, "type": "object" @@ -1155,7 +1155,7 @@ "id": "HttpTarget", "properties": { "headerOverrides": { - "description": "HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with \"X-CloudTasks-\", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. The default value is set to `\"application/json\"`. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.", + "description": "HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with \"X-CloudTasks-\", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. The default value is set to `\"application/json\"`. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).", "items": { "$ref": "HeaderOverride" }, diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 35a72f0c78d..20d3896f126 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -313,7 +313,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$HeaderOverride { /** - * header embodying a key and a value. + * Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms). */ header?: Schema$Header; } @@ -368,7 +368,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$HttpTarget { /** - * HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + * HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms). */ headerOverrides?: Schema$HeaderOverride[]; /** diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 141c0d1d85b..2833acf205f 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -346,7 +346,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$HeaderOverride { /** - * header embodying a key and a value. + * Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms). */ header?: Schema$Header; } @@ -401,7 +401,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$HttpTarget { /** - * HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + * HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms). */ headerOverrides?: Schema$HeaderOverride[]; /** diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 9a0d0fb0490..01f3389545d 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -322,7 +322,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$HeaderOverride { /** - * header embodying a key and a value. + * Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms). */ header?: Schema$Header; } @@ -377,7 +377,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$HttpTarget { /** - * HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + * HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms). */ headerOverrides?: Schema$HeaderOverride[]; /** From 089349119edd00a095bcbafe00ada0d33ac774d1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:48 +0000 Subject: [PATCH 24/78] feat(composer): update the API #### composer:v1beta1 The following keys were added: - schemas.AirflowMetadataRetentionPolicyConfig.description - schemas.AirflowMetadataRetentionPolicyConfig.id - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionDays.description - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionDays.format - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionDays.type - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionMode.description - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionMode.enum - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionMode.enumDescriptions - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionMode.type - schemas.AirflowMetadataRetentionPolicyConfig.type - schemas.DataRetentionConfig.properties.airflowDatabaseRetentionDays.deprecated - schemas.DataRetentionConfig.properties.airflowDatabaseRetentionDays.description - schemas.DataRetentionConfig.properties.airflowDatabaseRetentionDays.format - schemas.DataRetentionConfig.properties.airflowDatabaseRetentionDays.type - schemas.DataRetentionConfig.properties.airflowMetadataRetentionConfig.$ref - schemas.DataRetentionConfig.properties.airflowMetadataRetentionConfig.description #### composer:v1 The following keys were added: - schemas.AirflowMetadataRetentionPolicyConfig.description - schemas.AirflowMetadataRetentionPolicyConfig.id - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionDays.description - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionDays.format - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionDays.type - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionMode.description - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionMode.enum - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionMode.enumDescriptions - schemas.AirflowMetadataRetentionPolicyConfig.properties.retentionMode.type - schemas.AirflowMetadataRetentionPolicyConfig.type - schemas.DataRetentionConfig.properties.airflowMetadataRetentionConfig.$ref - schemas.DataRetentionConfig.properties.airflowMetadataRetentionConfig.description --- discovery/composer-v1.json | 32 ++++++++++++++++++++++++++- discovery/composer-v1beta1.json | 38 ++++++++++++++++++++++++++++++++- src/apis/composer/v1.ts | 17 +++++++++++++++ src/apis/composer/v1beta1.ts | 21 ++++++++++++++++++ 4 files changed, 106 insertions(+), 2 deletions(-) diff --git a/discovery/composer-v1.json b/discovery/composer-v1.json index 6d77ab73cc4..d017c227474 100644 --- a/discovery/composer-v1.json +++ b/discovery/composer-v1.json @@ -938,9 +938,35 @@ } } }, - "revision": "20240204", + "revision": "20240227", "rootUrl": "https://composer.googleapis.com/", "schemas": { + "AirflowMetadataRetentionPolicyConfig": { + "description": "The policy for airflow metadata database retention.", + "id": "AirflowMetadataRetentionPolicyConfig", + "properties": { + "retentionDays": { + "description": "Optional. How many days data should be retained for.", + "format": "int32", + "type": "integer" + }, + "retentionMode": { + "description": "Optional. Retention can be either enabled or disabled.", + "enum": [ + "RETENTION_MODE_UNSPECIFIED", + "RETENTION_MODE_ENABLED", + "RETENTION_MODE_DISABLED" + ], + "enumDescriptions": [ + "Default mode doesn't change environment parameters.", + "Retention policy is enabled.", + "Retention policy is disabled." + ], + "type": "string" + } + }, + "type": "object" + }, "AllowedIpRange": { "description": "Allowed IP range with user-provided description.", "id": "AllowedIpRange", @@ -1138,6 +1164,10 @@ "description": "The configuration setting for Airflow database data retention mechanism.", "id": "DataRetentionConfig", "properties": { + "airflowMetadataRetentionConfig": { + "$ref": "AirflowMetadataRetentionPolicyConfig", + "description": "Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2" + }, "taskLogsRetentionConfig": { "$ref": "TaskLogsRetentionConfig", "description": "Optional. The configuration settings for task logs retention" diff --git a/discovery/composer-v1beta1.json b/discovery/composer-v1beta1.json index 568b428cca6..7e8fe4f1e51 100644 --- a/discovery/composer-v1beta1.json +++ b/discovery/composer-v1beta1.json @@ -994,9 +994,35 @@ } } }, - "revision": "20240123", + "revision": "20240227", "rootUrl": "https://composer.googleapis.com/", "schemas": { + "AirflowMetadataRetentionPolicyConfig": { + "description": "The policy for airflow metadata database retention.", + "id": "AirflowMetadataRetentionPolicyConfig", + "properties": { + "retentionDays": { + "description": "Optional. How many days data should be retained for.", + "format": "int32", + "type": "integer" + }, + "retentionMode": { + "description": "Optional. Retention can be either enabled or disabled.", + "enum": [ + "RETENTION_MODE_UNSPECIFIED", + "RETENTION_MODE_ENABLED", + "RETENTION_MODE_DISABLED" + ], + "enumDescriptions": [ + "Default mode doesn't change environment parameters.", + "Retention policy is enabled.", + "Retention policy is disabled." + ], + "type": "string" + } + }, + "type": "object" + }, "AllowedIpRange": { "description": "Allowed IP range with user-provided description.", "id": "AllowedIpRange", @@ -1205,6 +1231,16 @@ "description": "The configuration setting for Airflow database data retention mechanism.", "id": "DataRetentionConfig", "properties": { + "airflowDatabaseRetentionDays": { + "deprecated": true, + "description": "Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0.", + "format": "int32", + "type": "integer" + }, + "airflowMetadataRetentionConfig": { + "$ref": "AirflowMetadataRetentionPolicyConfig", + "description": "Optional. The retention policy for airflow metadata database." + }, "taskLogsRetentionConfig": { "$ref": "TaskLogsRetentionConfig", "description": "Optional. The configuration settings for task logs retention" diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index 435578bca58..c9e8f350836 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -124,6 +124,19 @@ export namespace composer_v1 { } } + /** + * The policy for airflow metadata database retention. + */ + export interface Schema$AirflowMetadataRetentionPolicyConfig { + /** + * Optional. How many days data should be retained for. + */ + retentionDays?: number | null; + /** + * Optional. Retention can be either enabled or disabled. + */ + retentionMode?: string | null; + } /** * Allowed IP range with user-provided description. */ @@ -264,6 +277,10 @@ export namespace composer_v1 { * The configuration setting for Airflow database data retention mechanism. */ export interface Schema$DataRetentionConfig { + /** + * Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2 + */ + airflowMetadataRetentionConfig?: Schema$AirflowMetadataRetentionPolicyConfig; /** * Optional. The configuration settings for task logs retention */ diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 74bf8e6ef99..d2aa8909c59 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -124,6 +124,19 @@ export namespace composer_v1beta1 { } } + /** + * The policy for airflow metadata database retention. + */ + export interface Schema$AirflowMetadataRetentionPolicyConfig { + /** + * Optional. How many days data should be retained for. + */ + retentionDays?: number | null; + /** + * Optional. Retention can be either enabled or disabled. + */ + retentionMode?: string | null; + } /** * Allowed IP range with user-provided description. */ @@ -273,6 +286,14 @@ export namespace composer_v1beta1 { * The configuration setting for Airflow database data retention mechanism. */ export interface Schema$DataRetentionConfig { + /** + * Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0. + */ + airflowDatabaseRetentionDays?: number | null; + /** + * Optional. The retention policy for airflow metadata database. + */ + airflowMetadataRetentionConfig?: Schema$AirflowMetadataRetentionPolicyConfig; /** * Optional. The configuration settings for task logs retention */ From 65016d05e42a4fc68b8b61b4fc80e45a8dd3e2a7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:49 +0000 Subject: [PATCH 25/78] feat(compute)!: update the API BREAKING CHANGE: This release has breaking changes. #### compute:alpha The following keys were deleted: - schemas.BgpRouteNetworkLayerReachabilityInformation.properties.destination.deprecated - schemas.BgpRouteNetworkLayerReachabilityInformation.properties.destination.description - schemas.BgpRouteNetworkLayerReachabilityInformation.properties.destination.type The following keys were added: - schemas.GRPCTLSHealthCheck.id - schemas.GRPCTLSHealthCheck.properties.grpcServiceName.description - schemas.GRPCTLSHealthCheck.properties.grpcServiceName.type - schemas.GRPCTLSHealthCheck.properties.port.description - schemas.GRPCTLSHealthCheck.properties.port.format - schemas.GRPCTLSHealthCheck.properties.port.type - schemas.GRPCTLSHealthCheck.properties.portSpecification.description - schemas.GRPCTLSHealthCheck.properties.portSpecification.enum - schemas.GRPCTLSHealthCheck.properties.portSpecification.enumDescriptions - schemas.GRPCTLSHealthCheck.properties.portSpecification.type - schemas.GRPCTLSHealthCheck.type - schemas.HealthCheck.properties.grpcTlsHealthCheck.$ref - schemas.InstanceGroupManagerResizeRequest.properties.count.deprecated - schemas.InstanceGroupManagerResizeRequest.properties.queuingPolicy.deprecated - schemas.InstanceGroupManagerResizeRequest.properties.state.enumDeprecated - schemas.InstanceGroupManagerResizeRequestStatus.properties.queuingPolicy.deprecated - schemas.Network.properties.networkPlacement.description - schemas.Network.properties.networkPlacement.type - schemas.NetworkEndpointGroupPscData.properties.producerPort.description - schemas.NetworkEndpointGroupPscData.properties.producerPort.format - schemas.NetworkEndpointGroupPscData.properties.producerPort.type - schemas.Region.properties.quotaStatusWarning.description - schemas.Region.properties.quotaStatusWarning.properties.code.description - schemas.Region.properties.quotaStatusWarning.properties.code.enum - schemas.Region.properties.quotaStatusWarning.properties.code.enumDeprecated - schemas.Region.properties.quotaStatusWarning.properties.code.enumDescriptions - schemas.Region.properties.quotaStatusWarning.properties.code.type - schemas.Region.properties.quotaStatusWarning.properties.data.description - schemas.Region.properties.quotaStatusWarning.properties.data.items.properties.key.description - schemas.Region.properties.quotaStatusWarning.properties.data.items.properties.key.type - schemas.Region.properties.quotaStatusWarning.properties.data.items.properties.value.description - schemas.Region.properties.quotaStatusWarning.properties.data.items.properties.value.type - schemas.Region.properties.quotaStatusWarning.properties.data.items.type - schemas.Region.properties.quotaStatusWarning.properties.data.type - schemas.Region.properties.quotaStatusWarning.properties.message.description - schemas.Region.properties.quotaStatusWarning.properties.message.type - schemas.Region.properties.quotaStatusWarning.type - schemas.SubnetworksScopedWarning.id - schemas.SubnetworksScopedWarning.properties.scopeName.description - schemas.SubnetworksScopedWarning.properties.scopeName.type - schemas.SubnetworksScopedWarning.properties.warning.description - schemas.SubnetworksScopedWarning.properties.warning.properties.code.description - schemas.SubnetworksScopedWarning.properties.warning.properties.code.enum - schemas.SubnetworksScopedWarning.properties.warning.properties.code.enumDeprecated - schemas.SubnetworksScopedWarning.properties.warning.properties.code.enumDescriptions - schemas.SubnetworksScopedWarning.properties.warning.properties.code.type - schemas.SubnetworksScopedWarning.properties.warning.properties.data.description - schemas.SubnetworksScopedWarning.properties.warning.properties.data.items.properties.key.description - schemas.SubnetworksScopedWarning.properties.warning.properties.data.items.properties.key.type - schemas.SubnetworksScopedWarning.properties.warning.properties.data.items.properties.value.description - schemas.SubnetworksScopedWarning.properties.warning.properties.data.items.properties.value.type - schemas.SubnetworksScopedWarning.properties.warning.properties.data.items.type - schemas.SubnetworksScopedWarning.properties.warning.properties.data.type - schemas.SubnetworksScopedWarning.properties.warning.properties.message.description - schemas.SubnetworksScopedWarning.properties.warning.properties.message.type - schemas.SubnetworksScopedWarning.properties.warning.type - schemas.SubnetworksScopedWarning.type - schemas.UsableSubnetworksAggregatedList.properties.scoped_warnings.description - schemas.UsableSubnetworksAggregatedList.properties.scoped_warnings.items.$ref - schemas.UsableSubnetworksAggregatedList.properties.scoped_warnings.type - schemas.UsableSubnetworksAggregatedList.properties.unreachables.description - schemas.UsableSubnetworksAggregatedList.properties.unreachables.items.type - schemas.UsableSubnetworksAggregatedList.properties.unreachables.type The following keys were changed: - schemas.Commitment.properties.type.enum - schemas.Commitment.properties.type.enumDescriptions - schemas.CorsPolicy.properties.allowOriginRegexes.description - schemas.CorsPolicy.properties.disabled.description - schemas.GuestOsFeature.properties.type.description - schemas.InstanceGroupManagerResizeRequest.properties.count.description - schemas.InstanceGroupManagerResizeRequest.properties.queuingPolicy.description - schemas.InstanceGroupManagerResizeRequest.properties.state.enum - schemas.InstanceGroupManagerResizeRequest.properties.state.enumDescriptions - schemas.InstanceGroupManagerResizeRequestStatus.properties.queuingPolicy.description - schemas.InstantSnapshot.properties.status.enum - schemas.InstantSnapshot.properties.status.enumDescriptions - schemas.InterconnectRemoteLocationConstraints.properties.portPairRemoteLocation.description - schemas.Quota.properties.metric.enum - schemas.Quota.properties.metric.enumDescriptions - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.type.description #### compute:beta The following keys were deleted: - resources.futureReservations.methods.update.parameters.paths.location - resources.futureReservations.methods.update.parameters.paths.repeated - resources.futureReservations.methods.update.parameters.paths.type The following keys were added: - resources.images.methods.list.parameters.zone.description - resources.images.methods.list.parameters.zone.location - resources.images.methods.list.parameters.zone.pattern - resources.images.methods.list.parameters.zone.type - resources.storagePoolTypes.methods.aggregatedList.description - resources.storagePoolTypes.methods.aggregatedList.flatPath - resources.storagePoolTypes.methods.aggregatedList.httpMethod - resources.storagePoolTypes.methods.aggregatedList.id - resources.storagePoolTypes.methods.aggregatedList.parameterOrder - resources.storagePoolTypes.methods.aggregatedList.parameters.filter.description - resources.storagePoolTypes.methods.aggregatedList.parameters.filter.location - resources.storagePoolTypes.methods.aggregatedList.parameters.filter.type - resources.storagePoolTypes.methods.aggregatedList.parameters.includeAllScopes.description - resources.storagePoolTypes.methods.aggregatedList.parameters.includeAllScopes.location - resources.storagePoolTypes.methods.aggregatedList.parameters.includeAllScopes.type - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.default - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.description - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.format - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.location - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.minimum - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.type - resources.storagePoolTypes.methods.aggregatedList.parameters.orderBy.description - resources.storagePoolTypes.methods.aggregatedList.parameters.orderBy.location - resources.storagePoolTypes.methods.aggregatedList.parameters.orderBy.type - resources.storagePoolTypes.methods.aggregatedList.parameters.pageToken.description - resources.storagePoolTypes.methods.aggregatedList.parameters.pageToken.location - resources.storagePoolTypes.methods.aggregatedList.parameters.pageToken.type - resources.storagePoolTypes.methods.aggregatedList.parameters.project.description - resources.storagePoolTypes.methods.aggregatedList.parameters.project.location - resources.storagePoolTypes.methods.aggregatedList.parameters.project.pattern - resources.storagePoolTypes.methods.aggregatedList.parameters.project.required - resources.storagePoolTypes.methods.aggregatedList.parameters.project.type - resources.storagePoolTypes.methods.aggregatedList.parameters.returnPartialSuccess.description - resources.storagePoolTypes.methods.aggregatedList.parameters.returnPartialSuccess.location - resources.storagePoolTypes.methods.aggregatedList.parameters.returnPartialSuccess.type - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.storagePoolTypes.methods.aggregatedList.path - resources.storagePoolTypes.methods.aggregatedList.response.$ref - resources.storagePoolTypes.methods.aggregatedList.scopes - resources.storagePoolTypes.methods.get.description - resources.storagePoolTypes.methods.get.flatPath - resources.storagePoolTypes.methods.get.httpMethod - resources.storagePoolTypes.methods.get.id - resources.storagePoolTypes.methods.get.parameterOrder - resources.storagePoolTypes.methods.get.parameters.project.description - resources.storagePoolTypes.methods.get.parameters.project.location - resources.storagePoolTypes.methods.get.parameters.project.pattern - resources.storagePoolTypes.methods.get.parameters.project.required - resources.storagePoolTypes.methods.get.parameters.project.type - resources.storagePoolTypes.methods.get.parameters.storagePoolType.description - resources.storagePoolTypes.methods.get.parameters.storagePoolType.location - resources.storagePoolTypes.methods.get.parameters.storagePoolType.pattern - resources.storagePoolTypes.methods.get.parameters.storagePoolType.required - resources.storagePoolTypes.methods.get.parameters.storagePoolType.type - resources.storagePoolTypes.methods.get.parameters.zone.description - resources.storagePoolTypes.methods.get.parameters.zone.location - resources.storagePoolTypes.methods.get.parameters.zone.pattern - resources.storagePoolTypes.methods.get.parameters.zone.required - resources.storagePoolTypes.methods.get.parameters.zone.type - resources.storagePoolTypes.methods.get.path - resources.storagePoolTypes.methods.get.response.$ref - resources.storagePoolTypes.methods.get.scopes - resources.storagePoolTypes.methods.list.description - resources.storagePoolTypes.methods.list.flatPath - resources.storagePoolTypes.methods.list.httpMethod - resources.storagePoolTypes.methods.list.id - resources.storagePoolTypes.methods.list.parameterOrder - resources.storagePoolTypes.methods.list.parameters.filter.description - resources.storagePoolTypes.methods.list.parameters.filter.location - resources.storagePoolTypes.methods.list.parameters.filter.type - resources.storagePoolTypes.methods.list.parameters.maxResults.default - resources.storagePoolTypes.methods.list.parameters.maxResults.description - resources.storagePoolTypes.methods.list.parameters.maxResults.format - resources.storagePoolTypes.methods.list.parameters.maxResults.location - resources.storagePoolTypes.methods.list.parameters.maxResults.minimum - resources.storagePoolTypes.methods.list.parameters.maxResults.type - resources.storagePoolTypes.methods.list.parameters.orderBy.description - resources.storagePoolTypes.methods.list.parameters.orderBy.location - resources.storagePoolTypes.methods.list.parameters.orderBy.type - resources.storagePoolTypes.methods.list.parameters.pageToken.description - resources.storagePoolTypes.methods.list.parameters.pageToken.location - resources.storagePoolTypes.methods.list.parameters.pageToken.type - resources.storagePoolTypes.methods.list.parameters.project.description - resources.storagePoolTypes.methods.list.parameters.project.location - resources.storagePoolTypes.methods.list.parameters.project.pattern - resources.storagePoolTypes.methods.list.parameters.project.required - resources.storagePoolTypes.methods.list.parameters.project.type - resources.storagePoolTypes.methods.list.parameters.returnPartialSuccess.description - resources.storagePoolTypes.methods.list.parameters.returnPartialSuccess.location - resources.storagePoolTypes.methods.list.parameters.returnPartialSuccess.type - resources.storagePoolTypes.methods.list.parameters.zone.description - resources.storagePoolTypes.methods.list.parameters.zone.location - resources.storagePoolTypes.methods.list.parameters.zone.pattern - resources.storagePoolTypes.methods.list.parameters.zone.required - resources.storagePoolTypes.methods.list.parameters.zone.type - resources.storagePoolTypes.methods.list.path - resources.storagePoolTypes.methods.list.response.$ref - resources.storagePoolTypes.methods.list.scopes - resources.storagePools.methods.aggregatedList.description - resources.storagePools.methods.aggregatedList.flatPath - resources.storagePools.methods.aggregatedList.httpMethod - resources.storagePools.methods.aggregatedList.id - resources.storagePools.methods.aggregatedList.parameterOrder - resources.storagePools.methods.aggregatedList.parameters.filter.description - resources.storagePools.methods.aggregatedList.parameters.filter.location - resources.storagePools.methods.aggregatedList.parameters.filter.type - resources.storagePools.methods.aggregatedList.parameters.includeAllScopes.description - resources.storagePools.methods.aggregatedList.parameters.includeAllScopes.location - resources.storagePools.methods.aggregatedList.parameters.includeAllScopes.type - resources.storagePools.methods.aggregatedList.parameters.maxResults.default - resources.storagePools.methods.aggregatedList.parameters.maxResults.description - resources.storagePools.methods.aggregatedList.parameters.maxResults.format - resources.storagePools.methods.aggregatedList.parameters.maxResults.location - resources.storagePools.methods.aggregatedList.parameters.maxResults.minimum - resources.storagePools.methods.aggregatedList.parameters.maxResults.type - resources.storagePools.methods.aggregatedList.parameters.orderBy.description - resources.storagePools.methods.aggregatedList.parameters.orderBy.location - resources.storagePools.methods.aggregatedList.parameters.orderBy.type - resources.storagePools.methods.aggregatedList.parameters.pageToken.description - resources.storagePools.methods.aggregatedList.parameters.pageToken.location - resources.storagePools.methods.aggregatedList.parameters.pageToken.type - resources.storagePools.methods.aggregatedList.parameters.project.description - resources.storagePools.methods.aggregatedList.parameters.project.location - resources.storagePools.methods.aggregatedList.parameters.project.pattern - resources.storagePools.methods.aggregatedList.parameters.project.required - resources.storagePools.methods.aggregatedList.parameters.project.type - resources.storagePools.methods.aggregatedList.parameters.returnPartialSuccess.description - resources.storagePools.methods.aggregatedList.parameters.returnPartialSuccess.location - resources.storagePools.methods.aggregatedList.parameters.returnPartialSuccess.type - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.storagePools.methods.aggregatedList.path - resources.storagePools.methods.aggregatedList.response.$ref - resources.storagePools.methods.aggregatedList.scopes - resources.storagePools.methods.delete.description - resources.storagePools.methods.delete.flatPath - resources.storagePools.methods.delete.httpMethod - resources.storagePools.methods.delete.id - resources.storagePools.methods.delete.parameterOrder - resources.storagePools.methods.delete.parameters.project.description - resources.storagePools.methods.delete.parameters.project.location - resources.storagePools.methods.delete.parameters.project.pattern - resources.storagePools.methods.delete.parameters.project.required - resources.storagePools.methods.delete.parameters.project.type - resources.storagePools.methods.delete.parameters.requestId.description - resources.storagePools.methods.delete.parameters.requestId.location - resources.storagePools.methods.delete.parameters.requestId.type - resources.storagePools.methods.delete.parameters.storagePool.description - resources.storagePools.methods.delete.parameters.storagePool.location - resources.storagePools.methods.delete.parameters.storagePool.required - resources.storagePools.methods.delete.parameters.storagePool.type - resources.storagePools.methods.delete.parameters.zone.description - resources.storagePools.methods.delete.parameters.zone.location - resources.storagePools.methods.delete.parameters.zone.pattern - resources.storagePools.methods.delete.parameters.zone.required - resources.storagePools.methods.delete.parameters.zone.type - resources.storagePools.methods.delete.path - resources.storagePools.methods.delete.response.$ref - resources.storagePools.methods.delete.scopes - resources.storagePools.methods.get.description - resources.storagePools.methods.get.flatPath - resources.storagePools.methods.get.httpMethod - resources.storagePools.methods.get.id - resources.storagePools.methods.get.parameterOrder - resources.storagePools.methods.get.parameters.project.description - resources.storagePools.methods.get.parameters.project.location - resources.storagePools.methods.get.parameters.project.pattern - resources.storagePools.methods.get.parameters.project.required - resources.storagePools.methods.get.parameters.project.type - resources.storagePools.methods.get.parameters.storagePool.description - resources.storagePools.methods.get.parameters.storagePool.location - resources.storagePools.methods.get.parameters.storagePool.pattern - resources.storagePools.methods.get.parameters.storagePool.required - resources.storagePools.methods.get.parameters.storagePool.type - resources.storagePools.methods.get.parameters.zone.description - resources.storagePools.methods.get.parameters.zone.location - resources.storagePools.methods.get.parameters.zone.pattern - resources.storagePools.methods.get.parameters.zone.required - resources.storagePools.methods.get.parameters.zone.type - resources.storagePools.methods.get.path - resources.storagePools.methods.get.response.$ref - resources.storagePools.methods.get.scopes - resources.storagePools.methods.getIamPolicy.description - resources.storagePools.methods.getIamPolicy.flatPath - resources.storagePools.methods.getIamPolicy.httpMethod - resources.storagePools.methods.getIamPolicy.id - resources.storagePools.methods.getIamPolicy.parameterOrder - resources.storagePools.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.description - resources.storagePools.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.format - resources.storagePools.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.location - resources.storagePools.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.type - resources.storagePools.methods.getIamPolicy.parameters.project.description - resources.storagePools.methods.getIamPolicy.parameters.project.location - resources.storagePools.methods.getIamPolicy.parameters.project.pattern - resources.storagePools.methods.getIamPolicy.parameters.project.required - resources.storagePools.methods.getIamPolicy.parameters.project.type - resources.storagePools.methods.getIamPolicy.parameters.resource.description - resources.storagePools.methods.getIamPolicy.parameters.resource.location - resources.storagePools.methods.getIamPolicy.parameters.resource.pattern - resources.storagePools.methods.getIamPolicy.parameters.resource.required - resources.storagePools.methods.getIamPolicy.parameters.resource.type - resources.storagePools.methods.getIamPolicy.parameters.zone.description - resources.storagePools.methods.getIamPolicy.parameters.zone.location - resources.storagePools.methods.getIamPolicy.parameters.zone.pattern - resources.storagePools.methods.getIamPolicy.parameters.zone.required - resources.storagePools.methods.getIamPolicy.parameters.zone.type - resources.storagePools.methods.getIamPolicy.path - resources.storagePools.methods.getIamPolicy.response.$ref - resources.storagePools.methods.getIamPolicy.scopes - resources.storagePools.methods.insert.description - resources.storagePools.methods.insert.flatPath - resources.storagePools.methods.insert.httpMethod - resources.storagePools.methods.insert.id - resources.storagePools.methods.insert.parameterOrder - resources.storagePools.methods.insert.parameters.project.description - resources.storagePools.methods.insert.parameters.project.location - resources.storagePools.methods.insert.parameters.project.pattern - resources.storagePools.methods.insert.parameters.project.required - resources.storagePools.methods.insert.parameters.project.type - resources.storagePools.methods.insert.parameters.requestId.description - resources.storagePools.methods.insert.parameters.requestId.location - resources.storagePools.methods.insert.parameters.requestId.type - resources.storagePools.methods.insert.parameters.zone.description - resources.storagePools.methods.insert.parameters.zone.location - resources.storagePools.methods.insert.parameters.zone.pattern - resources.storagePools.methods.insert.parameters.zone.required - resources.storagePools.methods.insert.parameters.zone.type - resources.storagePools.methods.insert.path - resources.storagePools.methods.insert.request.$ref - resources.storagePools.methods.insert.response.$ref - resources.storagePools.methods.insert.scopes - resources.storagePools.methods.list.description - resources.storagePools.methods.list.flatPath - resources.storagePools.methods.list.httpMethod - resources.storagePools.methods.list.id - resources.storagePools.methods.list.parameterOrder - resources.storagePools.methods.list.parameters.filter.description - resources.storagePools.methods.list.parameters.filter.location - resources.storagePools.methods.list.parameters.filter.type - resources.storagePools.methods.list.parameters.maxResults.default - resources.storagePools.methods.list.parameters.maxResults.description - resources.storagePools.methods.list.parameters.maxResults.format - resources.storagePools.methods.list.parameters.maxResults.location - resources.storagePools.methods.list.parameters.maxResults.minimum - resources.storagePools.methods.list.parameters.maxResults.type - resources.storagePools.methods.list.parameters.orderBy.description - resources.storagePools.methods.list.parameters.orderBy.location - resources.storagePools.methods.list.parameters.orderBy.type - resources.storagePools.methods.list.parameters.pageToken.description - resources.storagePools.methods.list.parameters.pageToken.location - resources.storagePools.methods.list.parameters.pageToken.type - resources.storagePools.methods.list.parameters.project.description - resources.storagePools.methods.list.parameters.project.location - resources.storagePools.methods.list.parameters.project.pattern - resources.storagePools.methods.list.parameters.project.required - resources.storagePools.methods.list.parameters.project.type - resources.storagePools.methods.list.parameters.returnPartialSuccess.description - resources.storagePools.methods.list.parameters.returnPartialSuccess.location - resources.storagePools.methods.list.parameters.returnPartialSuccess.type - resources.storagePools.methods.list.parameters.zone.description - resources.storagePools.methods.list.parameters.zone.location - resources.storagePools.methods.list.parameters.zone.pattern - resources.storagePools.methods.list.parameters.zone.required - resources.storagePools.methods.list.parameters.zone.type - resources.storagePools.methods.list.path - resources.storagePools.methods.list.response.$ref - resources.storagePools.methods.list.scopes - resources.storagePools.methods.listDisks.description - resources.storagePools.methods.listDisks.flatPath - resources.storagePools.methods.listDisks.httpMethod - resources.storagePools.methods.listDisks.id - resources.storagePools.methods.listDisks.parameterOrder - resources.storagePools.methods.listDisks.parameters.filter.description - resources.storagePools.methods.listDisks.parameters.filter.location - resources.storagePools.methods.listDisks.parameters.filter.type - resources.storagePools.methods.listDisks.parameters.maxResults.default - resources.storagePools.methods.listDisks.parameters.maxResults.description - resources.storagePools.methods.listDisks.parameters.maxResults.format - resources.storagePools.methods.listDisks.parameters.maxResults.location - resources.storagePools.methods.listDisks.parameters.maxResults.minimum - resources.storagePools.methods.listDisks.parameters.maxResults.type - resources.storagePools.methods.listDisks.parameters.orderBy.description - resources.storagePools.methods.listDisks.parameters.orderBy.location - resources.storagePools.methods.listDisks.parameters.orderBy.type - resources.storagePools.methods.listDisks.parameters.pageToken.description - resources.storagePools.methods.listDisks.parameters.pageToken.location - resources.storagePools.methods.listDisks.parameters.pageToken.type - resources.storagePools.methods.listDisks.parameters.project.description - resources.storagePools.methods.listDisks.parameters.project.location - resources.storagePools.methods.listDisks.parameters.project.pattern - resources.storagePools.methods.listDisks.parameters.project.required - resources.storagePools.methods.listDisks.parameters.project.type - resources.storagePools.methods.listDisks.parameters.returnPartialSuccess.description - resources.storagePools.methods.listDisks.parameters.returnPartialSuccess.location - resources.storagePools.methods.listDisks.parameters.returnPartialSuccess.type - resources.storagePools.methods.listDisks.parameters.storagePool.description - resources.storagePools.methods.listDisks.parameters.storagePool.location - resources.storagePools.methods.listDisks.parameters.storagePool.pattern - resources.storagePools.methods.listDisks.parameters.storagePool.required - resources.storagePools.methods.listDisks.parameters.storagePool.type - resources.storagePools.methods.listDisks.parameters.zone.description - resources.storagePools.methods.listDisks.parameters.zone.location - resources.storagePools.methods.listDisks.parameters.zone.pattern - resources.storagePools.methods.listDisks.parameters.zone.required - resources.storagePools.methods.listDisks.parameters.zone.type - resources.storagePools.methods.listDisks.path - resources.storagePools.methods.listDisks.response.$ref - resources.storagePools.methods.listDisks.scopes - resources.storagePools.methods.setIamPolicy.description - resources.storagePools.methods.setIamPolicy.flatPath - resources.storagePools.methods.setIamPolicy.httpMethod - resources.storagePools.methods.setIamPolicy.id - resources.storagePools.methods.setIamPolicy.parameterOrder - resources.storagePools.methods.setIamPolicy.parameters.project.description - resources.storagePools.methods.setIamPolicy.parameters.project.location - resources.storagePools.methods.setIamPolicy.parameters.project.pattern - resources.storagePools.methods.setIamPolicy.parameters.project.required - resources.storagePools.methods.setIamPolicy.parameters.project.type - resources.storagePools.methods.setIamPolicy.parameters.resource.description - resources.storagePools.methods.setIamPolicy.parameters.resource.location - resources.storagePools.methods.setIamPolicy.parameters.resource.pattern - resources.storagePools.methods.setIamPolicy.parameters.resource.required - resources.storagePools.methods.setIamPolicy.parameters.resource.type - resources.storagePools.methods.setIamPolicy.parameters.zone.description - resources.storagePools.methods.setIamPolicy.parameters.zone.location - resources.storagePools.methods.setIamPolicy.parameters.zone.pattern - resources.storagePools.methods.setIamPolicy.parameters.zone.required - resources.storagePools.methods.setIamPolicy.parameters.zone.type - resources.storagePools.methods.setIamPolicy.path - resources.storagePools.methods.setIamPolicy.request.$ref - resources.storagePools.methods.setIamPolicy.response.$ref - resources.storagePools.methods.setIamPolicy.scopes - resources.storagePools.methods.testIamPermissions.description - resources.storagePools.methods.testIamPermissions.flatPath - resources.storagePools.methods.testIamPermissions.httpMethod - resources.storagePools.methods.testIamPermissions.id - resources.storagePools.methods.testIamPermissions.parameterOrder - resources.storagePools.methods.testIamPermissions.parameters.project.description - resources.storagePools.methods.testIamPermissions.parameters.project.location - resources.storagePools.methods.testIamPermissions.parameters.project.pattern - resources.storagePools.methods.testIamPermissions.parameters.project.required - resources.storagePools.methods.testIamPermissions.parameters.project.type - resources.storagePools.methods.testIamPermissions.parameters.resource.description - resources.storagePools.methods.testIamPermissions.parameters.resource.location - resources.storagePools.methods.testIamPermissions.parameters.resource.pattern - resources.storagePools.methods.testIamPermissions.parameters.resource.required - resources.storagePools.methods.testIamPermissions.parameters.resource.type - resources.storagePools.methods.testIamPermissions.parameters.zone.description - resources.storagePools.methods.testIamPermissions.parameters.zone.location - resources.storagePools.methods.testIamPermissions.parameters.zone.pattern - resources.storagePools.methods.testIamPermissions.parameters.zone.required - resources.storagePools.methods.testIamPermissions.parameters.zone.type - resources.storagePools.methods.testIamPermissions.path - resources.storagePools.methods.testIamPermissions.request.$ref - resources.storagePools.methods.testIamPermissions.response.$ref - resources.storagePools.methods.testIamPermissions.scopes - resources.storagePools.methods.update.description - resources.storagePools.methods.update.flatPath - resources.storagePools.methods.update.httpMethod - resources.storagePools.methods.update.id - resources.storagePools.methods.update.parameterOrder - resources.storagePools.methods.update.parameters.project.description - resources.storagePools.methods.update.parameters.project.location - resources.storagePools.methods.update.parameters.project.pattern - resources.storagePools.methods.update.parameters.project.required - resources.storagePools.methods.update.parameters.project.type - resources.storagePools.methods.update.parameters.requestId.description - resources.storagePools.methods.update.parameters.requestId.location - resources.storagePools.methods.update.parameters.requestId.type - resources.storagePools.methods.update.parameters.storagePool.description - resources.storagePools.methods.update.parameters.storagePool.location - resources.storagePools.methods.update.parameters.storagePool.pattern - resources.storagePools.methods.update.parameters.storagePool.required - resources.storagePools.methods.update.parameters.storagePool.type - resources.storagePools.methods.update.parameters.updateMask.description - resources.storagePools.methods.update.parameters.updateMask.format - resources.storagePools.methods.update.parameters.updateMask.location - resources.storagePools.methods.update.parameters.updateMask.type - resources.storagePools.methods.update.parameters.zone.description - resources.storagePools.methods.update.parameters.zone.location - resources.storagePools.methods.update.parameters.zone.pattern - resources.storagePools.methods.update.parameters.zone.required - resources.storagePools.methods.update.parameters.zone.type - resources.storagePools.methods.update.path - resources.storagePools.methods.update.request.$ref - resources.storagePools.methods.update.response.$ref - resources.storagePools.methods.update.scopes - schemas.AttachedDiskInitializeParams.properties.storagePool.description - schemas.AttachedDiskInitializeParams.properties.storagePool.type - schemas.Disk.properties.storagePool.description - schemas.Disk.properties.storagePool.type - schemas.HealthCheck.properties.sourceRegions.description - schemas.HealthCheck.properties.sourceRegions.items.type - schemas.HealthCheck.properties.sourceRegions.type - schemas.InstanceGroupManager.properties.params.$ref - schemas.InstanceGroupManager.properties.params.description - schemas.InstanceGroupManagerParams.description - schemas.InstanceGroupManagerParams.id - schemas.InstanceGroupManagerParams.properties.resourceManagerTags.additionalProperties.type - schemas.InstanceGroupManagerParams.properties.resourceManagerTags.description - schemas.InstanceGroupManagerParams.properties.resourceManagerTags.type - schemas.InstanceGroupManagerParams.type - schemas.InstanceGroupManagerResizeRequest.properties.count.deprecated - schemas.InstanceGroupManagerResizeRequest.properties.state.enumDeprecated - schemas.ServiceAttachment.properties.propagatedConnectionLimit.description - schemas.ServiceAttachment.properties.propagatedConnectionLimit.format - schemas.ServiceAttachment.properties.propagatedConnectionLimit.type - schemas.ServiceAttachmentConnectedEndpoint.properties.propagatedConnectionCount.description - schemas.ServiceAttachmentConnectedEndpoint.properties.propagatedConnectionCount.format - schemas.ServiceAttachmentConnectedEndpoint.properties.propagatedConnectionCount.type - schemas.StoragePool.description - schemas.StoragePool.id - schemas.StoragePool.properties.capacityProvisioningType.description - schemas.StoragePool.properties.capacityProvisioningType.enum - schemas.StoragePool.properties.capacityProvisioningType.enumDescriptions - schemas.StoragePool.properties.capacityProvisioningType.type - schemas.StoragePool.properties.creationTimestamp.description - schemas.StoragePool.properties.creationTimestamp.type - schemas.StoragePool.properties.description.description - schemas.StoragePool.properties.description.type - schemas.StoragePool.properties.id.description - schemas.StoragePool.properties.id.format - schemas.StoragePool.properties.id.type - schemas.StoragePool.properties.kind.default - schemas.StoragePool.properties.kind.description - schemas.StoragePool.properties.kind.type - schemas.StoragePool.properties.labelFingerprint.description - schemas.StoragePool.properties.labelFingerprint.format - schemas.StoragePool.properties.labelFingerprint.type - schemas.StoragePool.properties.labels.additionalProperties.type - schemas.StoragePool.properties.labels.description - schemas.StoragePool.properties.labels.type - schemas.StoragePool.properties.name.annotations.required - schemas.StoragePool.properties.name.description - schemas.StoragePool.properties.name.pattern - schemas.StoragePool.properties.name.type - schemas.StoragePool.properties.performanceProvisioningType.description - schemas.StoragePool.properties.performanceProvisioningType.enum - schemas.StoragePool.properties.performanceProvisioningType.enumDescriptions - schemas.StoragePool.properties.performanceProvisioningType.type - schemas.StoragePool.properties.poolProvisionedCapacityGb.description - schemas.StoragePool.properties.poolProvisionedCapacityGb.format - schemas.StoragePool.properties.poolProvisionedCapacityGb.type - schemas.StoragePool.properties.poolProvisionedIops.description - schemas.StoragePool.properties.poolProvisionedIops.format - schemas.StoragePool.properties.poolProvisionedIops.type - schemas.StoragePool.properties.poolProvisionedThroughput.description - schemas.StoragePool.properties.poolProvisionedThroughput.format - schemas.StoragePool.properties.poolProvisionedThroughput.type - schemas.StoragePool.properties.resourceStatus.$ref - schemas.StoragePool.properties.resourceStatus.description - schemas.StoragePool.properties.selfLink.description - schemas.StoragePool.properties.selfLink.type - schemas.StoragePool.properties.selfLinkWithId.description - schemas.StoragePool.properties.selfLinkWithId.type - schemas.StoragePool.properties.state.description - schemas.StoragePool.properties.state.enum - schemas.StoragePool.properties.state.enumDescriptions - schemas.StoragePool.properties.state.type - schemas.StoragePool.properties.status.$ref - schemas.StoragePool.properties.status.description - schemas.StoragePool.properties.storagePoolType.description - schemas.StoragePool.properties.storagePoolType.type - schemas.StoragePool.properties.zone.description - schemas.StoragePool.properties.zone.type - schemas.StoragePool.type - schemas.StoragePoolAggregatedList.id - schemas.StoragePoolAggregatedList.properties.etag.type - schemas.StoragePoolAggregatedList.properties.id.description - schemas.StoragePoolAggregatedList.properties.id.type - schemas.StoragePoolAggregatedList.properties.items.additionalProperties.$ref - schemas.StoragePoolAggregatedList.properties.items.additionalProperties.description - schemas.StoragePoolAggregatedList.properties.items.description - schemas.StoragePoolAggregatedList.properties.items.type - schemas.StoragePoolAggregatedList.properties.kind.default - schemas.StoragePoolAggregatedList.properties.kind.description - schemas.StoragePoolAggregatedList.properties.kind.type - schemas.StoragePoolAggregatedList.properties.nextPageToken.description - schemas.StoragePoolAggregatedList.properties.nextPageToken.type - schemas.StoragePoolAggregatedList.properties.selfLink.description - schemas.StoragePoolAggregatedList.properties.selfLink.type - schemas.StoragePoolAggregatedList.properties.unreachables.description - schemas.StoragePoolAggregatedList.properties.unreachables.items.type - schemas.StoragePoolAggregatedList.properties.unreachables.type - schemas.StoragePoolAggregatedList.properties.warning.description - schemas.StoragePoolAggregatedList.properties.warning.properties.code.description - schemas.StoragePoolAggregatedList.properties.warning.properties.code.enum - schemas.StoragePoolAggregatedList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolAggregatedList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolAggregatedList.properties.warning.properties.code.type - schemas.StoragePoolAggregatedList.properties.warning.properties.data.description - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.type - schemas.StoragePoolAggregatedList.properties.warning.properties.data.type - schemas.StoragePoolAggregatedList.properties.warning.properties.message.description - schemas.StoragePoolAggregatedList.properties.warning.properties.message.type - schemas.StoragePoolAggregatedList.properties.warning.type - schemas.StoragePoolAggregatedList.type - schemas.StoragePoolDisk.id - schemas.StoragePoolDisk.properties.attachedInstances.description - schemas.StoragePoolDisk.properties.attachedInstances.items.type - schemas.StoragePoolDisk.properties.attachedInstances.type - schemas.StoragePoolDisk.properties.creationTimestamp.description - schemas.StoragePoolDisk.properties.creationTimestamp.type - schemas.StoragePoolDisk.properties.disk.description - schemas.StoragePoolDisk.properties.disk.type - schemas.StoragePoolDisk.properties.name.description - schemas.StoragePoolDisk.properties.name.type - schemas.StoragePoolDisk.properties.provisionedIops.description - schemas.StoragePoolDisk.properties.provisionedIops.format - schemas.StoragePoolDisk.properties.provisionedIops.type - schemas.StoragePoolDisk.properties.provisionedThroughput.description - schemas.StoragePoolDisk.properties.provisionedThroughput.format - schemas.StoragePoolDisk.properties.provisionedThroughput.type - schemas.StoragePoolDisk.properties.resourcePolicies.description - schemas.StoragePoolDisk.properties.resourcePolicies.items.type - schemas.StoragePoolDisk.properties.resourcePolicies.type - schemas.StoragePoolDisk.properties.sizeGb.description - schemas.StoragePoolDisk.properties.sizeGb.format - schemas.StoragePoolDisk.properties.sizeGb.type - schemas.StoragePoolDisk.properties.status.description - schemas.StoragePoolDisk.properties.status.enum - schemas.StoragePoolDisk.properties.status.enumDescriptions - schemas.StoragePoolDisk.properties.status.type - schemas.StoragePoolDisk.properties.type.description - schemas.StoragePoolDisk.properties.type.type - schemas.StoragePoolDisk.properties.usedBytes.description - schemas.StoragePoolDisk.properties.usedBytes.format - schemas.StoragePoolDisk.properties.usedBytes.type - schemas.StoragePoolDisk.type - schemas.StoragePoolList.description - schemas.StoragePoolList.id - schemas.StoragePoolList.properties.etag.type - schemas.StoragePoolList.properties.id.description - schemas.StoragePoolList.properties.id.type - schemas.StoragePoolList.properties.items.description - schemas.StoragePoolList.properties.items.items.$ref - schemas.StoragePoolList.properties.items.type - schemas.StoragePoolList.properties.kind.default - schemas.StoragePoolList.properties.kind.description - schemas.StoragePoolList.properties.kind.type - schemas.StoragePoolList.properties.nextPageToken.description - schemas.StoragePoolList.properties.nextPageToken.type - schemas.StoragePoolList.properties.selfLink.description - schemas.StoragePoolList.properties.selfLink.type - schemas.StoragePoolList.properties.unreachables.description - schemas.StoragePoolList.properties.unreachables.items.type - schemas.StoragePoolList.properties.unreachables.type - schemas.StoragePoolList.properties.warning.description - schemas.StoragePoolList.properties.warning.properties.code.description - schemas.StoragePoolList.properties.warning.properties.code.enum - schemas.StoragePoolList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolList.properties.warning.properties.code.type - schemas.StoragePoolList.properties.warning.properties.data.description - schemas.StoragePoolList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolList.properties.warning.properties.data.items.type - schemas.StoragePoolList.properties.warning.properties.data.type - schemas.StoragePoolList.properties.warning.properties.message.description - schemas.StoragePoolList.properties.warning.properties.message.type - schemas.StoragePoolList.properties.warning.type - schemas.StoragePoolList.type - schemas.StoragePoolListDisks.id - schemas.StoragePoolListDisks.properties.etag.type - schemas.StoragePoolListDisks.properties.id.description - schemas.StoragePoolListDisks.properties.id.type - schemas.StoragePoolListDisks.properties.items.description - schemas.StoragePoolListDisks.properties.items.items.$ref - schemas.StoragePoolListDisks.properties.items.type - schemas.StoragePoolListDisks.properties.kind.default - schemas.StoragePoolListDisks.properties.kind.description - schemas.StoragePoolListDisks.properties.kind.type - schemas.StoragePoolListDisks.properties.nextPageToken.description - schemas.StoragePoolListDisks.properties.nextPageToken.type - schemas.StoragePoolListDisks.properties.selfLink.description - schemas.StoragePoolListDisks.properties.selfLink.type - schemas.StoragePoolListDisks.properties.unreachables.description - schemas.StoragePoolListDisks.properties.unreachables.items.type - schemas.StoragePoolListDisks.properties.unreachables.type - schemas.StoragePoolListDisks.properties.warning.description - schemas.StoragePoolListDisks.properties.warning.properties.code.description - schemas.StoragePoolListDisks.properties.warning.properties.code.enum - schemas.StoragePoolListDisks.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolListDisks.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolListDisks.properties.warning.properties.code.type - schemas.StoragePoolListDisks.properties.warning.properties.data.description - schemas.StoragePoolListDisks.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolListDisks.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolListDisks.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolListDisks.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolListDisks.properties.warning.properties.data.items.type - schemas.StoragePoolListDisks.properties.warning.properties.data.type - schemas.StoragePoolListDisks.properties.warning.properties.message.description - schemas.StoragePoolListDisks.properties.warning.properties.message.type - schemas.StoragePoolListDisks.properties.warning.type - schemas.StoragePoolListDisks.type - schemas.StoragePoolResourceStatus.description - schemas.StoragePoolResourceStatus.id - schemas.StoragePoolResourceStatus.properties.diskCount.description - schemas.StoragePoolResourceStatus.properties.diskCount.format - schemas.StoragePoolResourceStatus.properties.diskCount.type - schemas.StoragePoolResourceStatus.properties.lastResizeTimestamp.description - schemas.StoragePoolResourceStatus.properties.lastResizeTimestamp.type - schemas.StoragePoolResourceStatus.properties.maxTotalProvisionedDiskCapacityGb.description - schemas.StoragePoolResourceStatus.properties.maxTotalProvisionedDiskCapacityGb.format - schemas.StoragePoolResourceStatus.properties.maxTotalProvisionedDiskCapacityGb.type - schemas.StoragePoolResourceStatus.properties.poolUsedCapacityBytes.description - schemas.StoragePoolResourceStatus.properties.poolUsedCapacityBytes.format - schemas.StoragePoolResourceStatus.properties.poolUsedCapacityBytes.type - schemas.StoragePoolResourceStatus.properties.poolUsedIops.description - schemas.StoragePoolResourceStatus.properties.poolUsedIops.format - schemas.StoragePoolResourceStatus.properties.poolUsedIops.type - schemas.StoragePoolResourceStatus.properties.poolUsedThroughput.description - schemas.StoragePoolResourceStatus.properties.poolUsedThroughput.format - schemas.StoragePoolResourceStatus.properties.poolUsedThroughput.type - schemas.StoragePoolResourceStatus.properties.poolUserWrittenBytes.description - schemas.StoragePoolResourceStatus.properties.poolUserWrittenBytes.format - schemas.StoragePoolResourceStatus.properties.poolUserWrittenBytes.type - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskCapacityGb.description - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskCapacityGb.format - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskCapacityGb.type - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskIops.description - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskIops.format - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskIops.type - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskThroughput.description - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskThroughput.format - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskThroughput.type - schemas.StoragePoolResourceStatus.type - schemas.StoragePoolType.id - schemas.StoragePoolType.properties.creationTimestamp.description - schemas.StoragePoolType.properties.creationTimestamp.type - schemas.StoragePoolType.properties.deprecated.$ref - schemas.StoragePoolType.properties.deprecated.description - schemas.StoragePoolType.properties.description.description - schemas.StoragePoolType.properties.description.type - schemas.StoragePoolType.properties.id.description - schemas.StoragePoolType.properties.id.format - schemas.StoragePoolType.properties.id.type - schemas.StoragePoolType.properties.kind.default - schemas.StoragePoolType.properties.kind.description - schemas.StoragePoolType.properties.kind.type - schemas.StoragePoolType.properties.maxPoolProvisionedCapacityGb.description - schemas.StoragePoolType.properties.maxPoolProvisionedCapacityGb.format - schemas.StoragePoolType.properties.maxPoolProvisionedCapacityGb.type - schemas.StoragePoolType.properties.maxPoolProvisionedIops.description - schemas.StoragePoolType.properties.maxPoolProvisionedIops.format - schemas.StoragePoolType.properties.maxPoolProvisionedIops.type - schemas.StoragePoolType.properties.maxPoolProvisionedThroughput.description - schemas.StoragePoolType.properties.maxPoolProvisionedThroughput.format - schemas.StoragePoolType.properties.maxPoolProvisionedThroughput.type - schemas.StoragePoolType.properties.minPoolProvisionedCapacityGb.description - schemas.StoragePoolType.properties.minPoolProvisionedCapacityGb.format - schemas.StoragePoolType.properties.minPoolProvisionedCapacityGb.type - schemas.StoragePoolType.properties.minPoolProvisionedIops.description - schemas.StoragePoolType.properties.minPoolProvisionedIops.format - schemas.StoragePoolType.properties.minPoolProvisionedIops.type - schemas.StoragePoolType.properties.minPoolProvisionedThroughput.description - schemas.StoragePoolType.properties.minPoolProvisionedThroughput.format - schemas.StoragePoolType.properties.minPoolProvisionedThroughput.type - schemas.StoragePoolType.properties.minSizeGb.description - schemas.StoragePoolType.properties.minSizeGb.format - schemas.StoragePoolType.properties.minSizeGb.type - schemas.StoragePoolType.properties.name.description - schemas.StoragePoolType.properties.name.pattern - schemas.StoragePoolType.properties.name.type - schemas.StoragePoolType.properties.selfLink.description - schemas.StoragePoolType.properties.selfLink.type - schemas.StoragePoolType.properties.selfLinkWithId.description - schemas.StoragePoolType.properties.selfLinkWithId.type - schemas.StoragePoolType.properties.supportedDiskTypes.description - schemas.StoragePoolType.properties.supportedDiskTypes.items.type - schemas.StoragePoolType.properties.supportedDiskTypes.type - schemas.StoragePoolType.properties.zone.description - schemas.StoragePoolType.properties.zone.type - schemas.StoragePoolType.type - schemas.StoragePoolTypeAggregatedList.id - schemas.StoragePoolTypeAggregatedList.properties.id.description - schemas.StoragePoolTypeAggregatedList.properties.id.type - schemas.StoragePoolTypeAggregatedList.properties.items.additionalProperties.$ref - schemas.StoragePoolTypeAggregatedList.properties.items.additionalProperties.description - schemas.StoragePoolTypeAggregatedList.properties.items.description - schemas.StoragePoolTypeAggregatedList.properties.items.type - schemas.StoragePoolTypeAggregatedList.properties.kind.default - schemas.StoragePoolTypeAggregatedList.properties.kind.description - schemas.StoragePoolTypeAggregatedList.properties.kind.type - schemas.StoragePoolTypeAggregatedList.properties.nextPageToken.description - schemas.StoragePoolTypeAggregatedList.properties.nextPageToken.type - schemas.StoragePoolTypeAggregatedList.properties.selfLink.description - schemas.StoragePoolTypeAggregatedList.properties.selfLink.type - schemas.StoragePoolTypeAggregatedList.properties.warning.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.enum - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.message.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.message.type - schemas.StoragePoolTypeAggregatedList.properties.warning.type - schemas.StoragePoolTypeAggregatedList.type - schemas.StoragePoolTypeList.description - schemas.StoragePoolTypeList.id - schemas.StoragePoolTypeList.properties.id.description - schemas.StoragePoolTypeList.properties.id.type - schemas.StoragePoolTypeList.properties.items.description - schemas.StoragePoolTypeList.properties.items.items.$ref - schemas.StoragePoolTypeList.properties.items.type - schemas.StoragePoolTypeList.properties.kind.default - schemas.StoragePoolTypeList.properties.kind.description - schemas.StoragePoolTypeList.properties.kind.type - schemas.StoragePoolTypeList.properties.nextPageToken.description - schemas.StoragePoolTypeList.properties.nextPageToken.type - schemas.StoragePoolTypeList.properties.selfLink.description - schemas.StoragePoolTypeList.properties.selfLink.type - schemas.StoragePoolTypeList.properties.warning.description - schemas.StoragePoolTypeList.properties.warning.properties.code.description - schemas.StoragePoolTypeList.properties.warning.properties.code.enum - schemas.StoragePoolTypeList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolTypeList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolTypeList.properties.warning.properties.code.type - schemas.StoragePoolTypeList.properties.warning.properties.data.description - schemas.StoragePoolTypeList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolTypeList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolTypeList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolTypeList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolTypeList.properties.warning.properties.data.items.type - schemas.StoragePoolTypeList.properties.warning.properties.data.type - schemas.StoragePoolTypeList.properties.warning.properties.message.description - schemas.StoragePoolTypeList.properties.warning.properties.message.type - schemas.StoragePoolTypeList.properties.warning.type - schemas.StoragePoolTypeList.type - schemas.StoragePoolTypesScopedList.id - schemas.StoragePoolTypesScopedList.properties.storagePoolTypes.description - schemas.StoragePoolTypesScopedList.properties.storagePoolTypes.items.$ref - schemas.StoragePoolTypesScopedList.properties.storagePoolTypes.type - schemas.StoragePoolTypesScopedList.properties.warning.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.enum - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.message.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.message.type - schemas.StoragePoolTypesScopedList.properties.warning.type - schemas.StoragePoolTypesScopedList.type - schemas.StoragePoolsScopedList.id - schemas.StoragePoolsScopedList.properties.storagePools.description - schemas.StoragePoolsScopedList.properties.storagePools.items.$ref - schemas.StoragePoolsScopedList.properties.storagePools.type - schemas.StoragePoolsScopedList.properties.warning.description - schemas.StoragePoolsScopedList.properties.warning.properties.code.description - schemas.StoragePoolsScopedList.properties.warning.properties.code.enum - schemas.StoragePoolsScopedList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolsScopedList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolsScopedList.properties.warning.properties.code.type - schemas.StoragePoolsScopedList.properties.warning.properties.data.description - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.type - schemas.StoragePoolsScopedList.properties.warning.properties.data.type - schemas.StoragePoolsScopedList.properties.warning.properties.message.description - schemas.StoragePoolsScopedList.properties.warning.properties.message.type - schemas.StoragePoolsScopedList.properties.warning.type - schemas.StoragePoolsScopedList.type The following keys were changed: - schemas.Commitment.properties.type.enum - schemas.Commitment.properties.type.enumDescriptions - schemas.CorsPolicy.properties.allowOriginRegexes.description - schemas.CorsPolicy.properties.disabled.description - schemas.Disk.properties.status.enum - schemas.Disk.properties.status.enumDescriptions - schemas.GuestOsFeature.properties.type.description - schemas.InstanceGroupManagerResizeRequest.properties.count.description - schemas.InstanceGroupManagerResizeRequest.properties.state.enum - schemas.InstanceGroupManagerResizeRequest.properties.state.enumDescriptions - schemas.InstantSnapshot.properties.status.enum - schemas.InstantSnapshot.properties.status.enumDescriptions - schemas.InterconnectRemoteLocationConstraints.properties.portPairRemoteLocation.description - schemas.Quota.properties.metric.enum - schemas.Quota.properties.metric.enumDescriptions - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.type.description #### compute:v1 The following keys were added: - resources.instanceGroupManagerResizeRequests.methods.cancel.description - resources.instanceGroupManagerResizeRequests.methods.cancel.flatPath - resources.instanceGroupManagerResizeRequests.methods.cancel.httpMethod - resources.instanceGroupManagerResizeRequests.methods.cancel.id - resources.instanceGroupManagerResizeRequests.methods.cancel.parameterOrder - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.instanceGroupManager.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.instanceGroupManager.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.instanceGroupManager.required - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.instanceGroupManager.type - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.pattern - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.required - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.type - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.requestId.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.requestId.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.requestId.type - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.resizeRequest.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.resizeRequest.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.resizeRequest.required - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.resizeRequest.type - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.zone.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.zone.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.zone.required - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.zone.type - resources.instanceGroupManagerResizeRequests.methods.cancel.path - resources.instanceGroupManagerResizeRequests.methods.cancel.response.$ref - resources.instanceGroupManagerResizeRequests.methods.cancel.scopes - resources.instanceGroupManagerResizeRequests.methods.delete.description - resources.instanceGroupManagerResizeRequests.methods.delete.flatPath - resources.instanceGroupManagerResizeRequests.methods.delete.httpMethod - resources.instanceGroupManagerResizeRequests.methods.delete.id - resources.instanceGroupManagerResizeRequests.methods.delete.parameterOrder - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.instanceGroupManager.description - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.instanceGroupManager.location - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.instanceGroupManager.required - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.instanceGroupManager.type - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.project.description - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.project.location - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.project.pattern - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.project.required - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.project.type - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.requestId.description - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.requestId.location - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.requestId.type - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.resizeRequest.description - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.resizeRequest.location - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.resizeRequest.required - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.resizeRequest.type - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.zone.description - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.zone.location - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.zone.required - resources.instanceGroupManagerResizeRequests.methods.delete.parameters.zone.type - resources.instanceGroupManagerResizeRequests.methods.delete.path - resources.instanceGroupManagerResizeRequests.methods.delete.response.$ref - resources.instanceGroupManagerResizeRequests.methods.delete.scopes - resources.instanceGroupManagerResizeRequests.methods.get.description - resources.instanceGroupManagerResizeRequests.methods.get.flatPath - resources.instanceGroupManagerResizeRequests.methods.get.httpMethod - resources.instanceGroupManagerResizeRequests.methods.get.id - resources.instanceGroupManagerResizeRequests.methods.get.parameterOrder - resources.instanceGroupManagerResizeRequests.methods.get.parameters.instanceGroupManager.description - resources.instanceGroupManagerResizeRequests.methods.get.parameters.instanceGroupManager.location - resources.instanceGroupManagerResizeRequests.methods.get.parameters.instanceGroupManager.required - resources.instanceGroupManagerResizeRequests.methods.get.parameters.instanceGroupManager.type - resources.instanceGroupManagerResizeRequests.methods.get.parameters.project.description - resources.instanceGroupManagerResizeRequests.methods.get.parameters.project.location - resources.instanceGroupManagerResizeRequests.methods.get.parameters.project.pattern - resources.instanceGroupManagerResizeRequests.methods.get.parameters.project.required - resources.instanceGroupManagerResizeRequests.methods.get.parameters.project.type - resources.instanceGroupManagerResizeRequests.methods.get.parameters.resizeRequest.description - resources.instanceGroupManagerResizeRequests.methods.get.parameters.resizeRequest.location - resources.instanceGroupManagerResizeRequests.methods.get.parameters.resizeRequest.required - resources.instanceGroupManagerResizeRequests.methods.get.parameters.resizeRequest.type - resources.instanceGroupManagerResizeRequests.methods.get.parameters.zone.description - resources.instanceGroupManagerResizeRequests.methods.get.parameters.zone.location - resources.instanceGroupManagerResizeRequests.methods.get.parameters.zone.required - resources.instanceGroupManagerResizeRequests.methods.get.parameters.zone.type - resources.instanceGroupManagerResizeRequests.methods.get.path - resources.instanceGroupManagerResizeRequests.methods.get.response.$ref - resources.instanceGroupManagerResizeRequests.methods.get.scopes - resources.instanceGroupManagerResizeRequests.methods.insert.description - resources.instanceGroupManagerResizeRequests.methods.insert.flatPath - resources.instanceGroupManagerResizeRequests.methods.insert.httpMethod - resources.instanceGroupManagerResizeRequests.methods.insert.id - resources.instanceGroupManagerResizeRequests.methods.insert.parameterOrder - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.instanceGroupManager.description - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.instanceGroupManager.location - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.instanceGroupManager.required - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.instanceGroupManager.type - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.project.description - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.project.location - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.project.pattern - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.project.required - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.project.type - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.requestId.description - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.requestId.location - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.requestId.type - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.zone.description - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.zone.location - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.zone.required - resources.instanceGroupManagerResizeRequests.methods.insert.parameters.zone.type - resources.instanceGroupManagerResizeRequests.methods.insert.path - resources.instanceGroupManagerResizeRequests.methods.insert.request.$ref - resources.instanceGroupManagerResizeRequests.methods.insert.response.$ref - resources.instanceGroupManagerResizeRequests.methods.insert.scopes - resources.instanceGroupManagerResizeRequests.methods.list.description - resources.instanceGroupManagerResizeRequests.methods.list.flatPath - resources.instanceGroupManagerResizeRequests.methods.list.httpMethod - resources.instanceGroupManagerResizeRequests.methods.list.id - resources.instanceGroupManagerResizeRequests.methods.list.parameterOrder - resources.instanceGroupManagerResizeRequests.methods.list.parameters.filter.description - resources.instanceGroupManagerResizeRequests.methods.list.parameters.filter.location - resources.instanceGroupManagerResizeRequests.methods.list.parameters.filter.type - resources.instanceGroupManagerResizeRequests.methods.list.parameters.instanceGroupManager.description - resources.instanceGroupManagerResizeRequests.methods.list.parameters.instanceGroupManager.location - resources.instanceGroupManagerResizeRequests.methods.list.parameters.instanceGroupManager.required - resources.instanceGroupManagerResizeRequests.methods.list.parameters.instanceGroupManager.type - resources.instanceGroupManagerResizeRequests.methods.list.parameters.maxResults.default - resources.instanceGroupManagerResizeRequests.methods.list.parameters.maxResults.description - resources.instanceGroupManagerResizeRequests.methods.list.parameters.maxResults.format - resources.instanceGroupManagerResizeRequests.methods.list.parameters.maxResults.location - resources.instanceGroupManagerResizeRequests.methods.list.parameters.maxResults.minimum - resources.instanceGroupManagerResizeRequests.methods.list.parameters.maxResults.type - resources.instanceGroupManagerResizeRequests.methods.list.parameters.orderBy.description - resources.instanceGroupManagerResizeRequests.methods.list.parameters.orderBy.location - resources.instanceGroupManagerResizeRequests.methods.list.parameters.orderBy.type - resources.instanceGroupManagerResizeRequests.methods.list.parameters.pageToken.description - resources.instanceGroupManagerResizeRequests.methods.list.parameters.pageToken.location - resources.instanceGroupManagerResizeRequests.methods.list.parameters.pageToken.type - resources.instanceGroupManagerResizeRequests.methods.list.parameters.project.description - resources.instanceGroupManagerResizeRequests.methods.list.parameters.project.location - resources.instanceGroupManagerResizeRequests.methods.list.parameters.project.pattern - resources.instanceGroupManagerResizeRequests.methods.list.parameters.project.required - resources.instanceGroupManagerResizeRequests.methods.list.parameters.project.type - resources.instanceGroupManagerResizeRequests.methods.list.parameters.returnPartialSuccess.description - resources.instanceGroupManagerResizeRequests.methods.list.parameters.returnPartialSuccess.location - resources.instanceGroupManagerResizeRequests.methods.list.parameters.returnPartialSuccess.type - resources.instanceGroupManagerResizeRequests.methods.list.parameters.zone.description - resources.instanceGroupManagerResizeRequests.methods.list.parameters.zone.location - resources.instanceGroupManagerResizeRequests.methods.list.parameters.zone.required - resources.instanceGroupManagerResizeRequests.methods.list.parameters.zone.type - resources.instanceGroupManagerResizeRequests.methods.list.path - resources.instanceGroupManagerResizeRequests.methods.list.response.$ref - resources.instanceGroupManagerResizeRequests.methods.list.scopes - resources.storagePoolTypes.methods.aggregatedList.description - resources.storagePoolTypes.methods.aggregatedList.flatPath - resources.storagePoolTypes.methods.aggregatedList.httpMethod - resources.storagePoolTypes.methods.aggregatedList.id - resources.storagePoolTypes.methods.aggregatedList.parameterOrder - resources.storagePoolTypes.methods.aggregatedList.parameters.filter.description - resources.storagePoolTypes.methods.aggregatedList.parameters.filter.location - resources.storagePoolTypes.methods.aggregatedList.parameters.filter.type - resources.storagePoolTypes.methods.aggregatedList.parameters.includeAllScopes.description - resources.storagePoolTypes.methods.aggregatedList.parameters.includeAllScopes.location - resources.storagePoolTypes.methods.aggregatedList.parameters.includeAllScopes.type - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.default - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.description - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.format - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.location - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.minimum - resources.storagePoolTypes.methods.aggregatedList.parameters.maxResults.type - resources.storagePoolTypes.methods.aggregatedList.parameters.orderBy.description - resources.storagePoolTypes.methods.aggregatedList.parameters.orderBy.location - resources.storagePoolTypes.methods.aggregatedList.parameters.orderBy.type - resources.storagePoolTypes.methods.aggregatedList.parameters.pageToken.description - resources.storagePoolTypes.methods.aggregatedList.parameters.pageToken.location - resources.storagePoolTypes.methods.aggregatedList.parameters.pageToken.type - resources.storagePoolTypes.methods.aggregatedList.parameters.project.description - resources.storagePoolTypes.methods.aggregatedList.parameters.project.location - resources.storagePoolTypes.methods.aggregatedList.parameters.project.pattern - resources.storagePoolTypes.methods.aggregatedList.parameters.project.required - resources.storagePoolTypes.methods.aggregatedList.parameters.project.type - resources.storagePoolTypes.methods.aggregatedList.parameters.returnPartialSuccess.description - resources.storagePoolTypes.methods.aggregatedList.parameters.returnPartialSuccess.location - resources.storagePoolTypes.methods.aggregatedList.parameters.returnPartialSuccess.type - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.storagePoolTypes.methods.aggregatedList.path - resources.storagePoolTypes.methods.aggregatedList.response.$ref - resources.storagePoolTypes.methods.aggregatedList.scopes - resources.storagePoolTypes.methods.get.description - resources.storagePoolTypes.methods.get.flatPath - resources.storagePoolTypes.methods.get.httpMethod - resources.storagePoolTypes.methods.get.id - resources.storagePoolTypes.methods.get.parameterOrder - resources.storagePoolTypes.methods.get.parameters.project.description - resources.storagePoolTypes.methods.get.parameters.project.location - resources.storagePoolTypes.methods.get.parameters.project.pattern - resources.storagePoolTypes.methods.get.parameters.project.required - resources.storagePoolTypes.methods.get.parameters.project.type - resources.storagePoolTypes.methods.get.parameters.storagePoolType.description - resources.storagePoolTypes.methods.get.parameters.storagePoolType.location - resources.storagePoolTypes.methods.get.parameters.storagePoolType.pattern - resources.storagePoolTypes.methods.get.parameters.storagePoolType.required - resources.storagePoolTypes.methods.get.parameters.storagePoolType.type - resources.storagePoolTypes.methods.get.parameters.zone.description - resources.storagePoolTypes.methods.get.parameters.zone.location - resources.storagePoolTypes.methods.get.parameters.zone.pattern - resources.storagePoolTypes.methods.get.parameters.zone.required - resources.storagePoolTypes.methods.get.parameters.zone.type - resources.storagePoolTypes.methods.get.path - resources.storagePoolTypes.methods.get.response.$ref - resources.storagePoolTypes.methods.get.scopes - resources.storagePoolTypes.methods.list.description - resources.storagePoolTypes.methods.list.flatPath - resources.storagePoolTypes.methods.list.httpMethod - resources.storagePoolTypes.methods.list.id - resources.storagePoolTypes.methods.list.parameterOrder - resources.storagePoolTypes.methods.list.parameters.filter.description - resources.storagePoolTypes.methods.list.parameters.filter.location - resources.storagePoolTypes.methods.list.parameters.filter.type - resources.storagePoolTypes.methods.list.parameters.maxResults.default - resources.storagePoolTypes.methods.list.parameters.maxResults.description - resources.storagePoolTypes.methods.list.parameters.maxResults.format - resources.storagePoolTypes.methods.list.parameters.maxResults.location - resources.storagePoolTypes.methods.list.parameters.maxResults.minimum - resources.storagePoolTypes.methods.list.parameters.maxResults.type - resources.storagePoolTypes.methods.list.parameters.orderBy.description - resources.storagePoolTypes.methods.list.parameters.orderBy.location - resources.storagePoolTypes.methods.list.parameters.orderBy.type - resources.storagePoolTypes.methods.list.parameters.pageToken.description - resources.storagePoolTypes.methods.list.parameters.pageToken.location - resources.storagePoolTypes.methods.list.parameters.pageToken.type - resources.storagePoolTypes.methods.list.parameters.project.description - resources.storagePoolTypes.methods.list.parameters.project.location - resources.storagePoolTypes.methods.list.parameters.project.pattern - resources.storagePoolTypes.methods.list.parameters.project.required - resources.storagePoolTypes.methods.list.parameters.project.type - resources.storagePoolTypes.methods.list.parameters.returnPartialSuccess.description - resources.storagePoolTypes.methods.list.parameters.returnPartialSuccess.location - resources.storagePoolTypes.methods.list.parameters.returnPartialSuccess.type - resources.storagePoolTypes.methods.list.parameters.zone.description - resources.storagePoolTypes.methods.list.parameters.zone.location - resources.storagePoolTypes.methods.list.parameters.zone.pattern - resources.storagePoolTypes.methods.list.parameters.zone.required - resources.storagePoolTypes.methods.list.parameters.zone.type - resources.storagePoolTypes.methods.list.path - resources.storagePoolTypes.methods.list.response.$ref - resources.storagePoolTypes.methods.list.scopes - resources.storagePools.methods.aggregatedList.description - resources.storagePools.methods.aggregatedList.flatPath - resources.storagePools.methods.aggregatedList.httpMethod - resources.storagePools.methods.aggregatedList.id - resources.storagePools.methods.aggregatedList.parameterOrder - resources.storagePools.methods.aggregatedList.parameters.filter.description - resources.storagePools.methods.aggregatedList.parameters.filter.location - resources.storagePools.methods.aggregatedList.parameters.filter.type - resources.storagePools.methods.aggregatedList.parameters.includeAllScopes.description - resources.storagePools.methods.aggregatedList.parameters.includeAllScopes.location - resources.storagePools.methods.aggregatedList.parameters.includeAllScopes.type - resources.storagePools.methods.aggregatedList.parameters.maxResults.default - resources.storagePools.methods.aggregatedList.parameters.maxResults.description - resources.storagePools.methods.aggregatedList.parameters.maxResults.format - resources.storagePools.methods.aggregatedList.parameters.maxResults.location - resources.storagePools.methods.aggregatedList.parameters.maxResults.minimum - resources.storagePools.methods.aggregatedList.parameters.maxResults.type - resources.storagePools.methods.aggregatedList.parameters.orderBy.description - resources.storagePools.methods.aggregatedList.parameters.orderBy.location - resources.storagePools.methods.aggregatedList.parameters.orderBy.type - resources.storagePools.methods.aggregatedList.parameters.pageToken.description - resources.storagePools.methods.aggregatedList.parameters.pageToken.location - resources.storagePools.methods.aggregatedList.parameters.pageToken.type - resources.storagePools.methods.aggregatedList.parameters.project.description - resources.storagePools.methods.aggregatedList.parameters.project.location - resources.storagePools.methods.aggregatedList.parameters.project.pattern - resources.storagePools.methods.aggregatedList.parameters.project.required - resources.storagePools.methods.aggregatedList.parameters.project.type - resources.storagePools.methods.aggregatedList.parameters.returnPartialSuccess.description - resources.storagePools.methods.aggregatedList.parameters.returnPartialSuccess.location - resources.storagePools.methods.aggregatedList.parameters.returnPartialSuccess.type - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.storagePools.methods.aggregatedList.path - resources.storagePools.methods.aggregatedList.response.$ref - resources.storagePools.methods.aggregatedList.scopes - resources.storagePools.methods.delete.description - resources.storagePools.methods.delete.flatPath - resources.storagePools.methods.delete.httpMethod - resources.storagePools.methods.delete.id - resources.storagePools.methods.delete.parameterOrder - resources.storagePools.methods.delete.parameters.project.description - resources.storagePools.methods.delete.parameters.project.location - resources.storagePools.methods.delete.parameters.project.pattern - resources.storagePools.methods.delete.parameters.project.required - resources.storagePools.methods.delete.parameters.project.type - resources.storagePools.methods.delete.parameters.requestId.description - resources.storagePools.methods.delete.parameters.requestId.location - resources.storagePools.methods.delete.parameters.requestId.type - resources.storagePools.methods.delete.parameters.storagePool.description - resources.storagePools.methods.delete.parameters.storagePool.location - resources.storagePools.methods.delete.parameters.storagePool.required - resources.storagePools.methods.delete.parameters.storagePool.type - resources.storagePools.methods.delete.parameters.zone.description - resources.storagePools.methods.delete.parameters.zone.location - resources.storagePools.methods.delete.parameters.zone.pattern - resources.storagePools.methods.delete.parameters.zone.required - resources.storagePools.methods.delete.parameters.zone.type - resources.storagePools.methods.delete.path - resources.storagePools.methods.delete.response.$ref - resources.storagePools.methods.delete.scopes - resources.storagePools.methods.get.description - resources.storagePools.methods.get.flatPath - resources.storagePools.methods.get.httpMethod - resources.storagePools.methods.get.id - resources.storagePools.methods.get.parameterOrder - resources.storagePools.methods.get.parameters.project.description - resources.storagePools.methods.get.parameters.project.location - resources.storagePools.methods.get.parameters.project.pattern - resources.storagePools.methods.get.parameters.project.required - resources.storagePools.methods.get.parameters.project.type - resources.storagePools.methods.get.parameters.storagePool.description - resources.storagePools.methods.get.parameters.storagePool.location - resources.storagePools.methods.get.parameters.storagePool.pattern - resources.storagePools.methods.get.parameters.storagePool.required - resources.storagePools.methods.get.parameters.storagePool.type - resources.storagePools.methods.get.parameters.zone.description - resources.storagePools.methods.get.parameters.zone.location - resources.storagePools.methods.get.parameters.zone.pattern - resources.storagePools.methods.get.parameters.zone.required - resources.storagePools.methods.get.parameters.zone.type - resources.storagePools.methods.get.path - resources.storagePools.methods.get.response.$ref - resources.storagePools.methods.get.scopes - resources.storagePools.methods.getIamPolicy.description - resources.storagePools.methods.getIamPolicy.flatPath - resources.storagePools.methods.getIamPolicy.httpMethod - resources.storagePools.methods.getIamPolicy.id - resources.storagePools.methods.getIamPolicy.parameterOrder - resources.storagePools.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.description - resources.storagePools.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.format - resources.storagePools.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.location - resources.storagePools.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.type - resources.storagePools.methods.getIamPolicy.parameters.project.description - resources.storagePools.methods.getIamPolicy.parameters.project.location - resources.storagePools.methods.getIamPolicy.parameters.project.pattern - resources.storagePools.methods.getIamPolicy.parameters.project.required - resources.storagePools.methods.getIamPolicy.parameters.project.type - resources.storagePools.methods.getIamPolicy.parameters.resource.description - resources.storagePools.methods.getIamPolicy.parameters.resource.location - resources.storagePools.methods.getIamPolicy.parameters.resource.pattern - resources.storagePools.methods.getIamPolicy.parameters.resource.required - resources.storagePools.methods.getIamPolicy.parameters.resource.type - resources.storagePools.methods.getIamPolicy.parameters.zone.description - resources.storagePools.methods.getIamPolicy.parameters.zone.location - resources.storagePools.methods.getIamPolicy.parameters.zone.pattern - resources.storagePools.methods.getIamPolicy.parameters.zone.required - resources.storagePools.methods.getIamPolicy.parameters.zone.type - resources.storagePools.methods.getIamPolicy.path - resources.storagePools.methods.getIamPolicy.response.$ref - resources.storagePools.methods.getIamPolicy.scopes - resources.storagePools.methods.insert.description - resources.storagePools.methods.insert.flatPath - resources.storagePools.methods.insert.httpMethod - resources.storagePools.methods.insert.id - resources.storagePools.methods.insert.parameterOrder - resources.storagePools.methods.insert.parameters.project.description - resources.storagePools.methods.insert.parameters.project.location - resources.storagePools.methods.insert.parameters.project.pattern - resources.storagePools.methods.insert.parameters.project.required - resources.storagePools.methods.insert.parameters.project.type - resources.storagePools.methods.insert.parameters.requestId.description - resources.storagePools.methods.insert.parameters.requestId.location - resources.storagePools.methods.insert.parameters.requestId.type - resources.storagePools.methods.insert.parameters.zone.description - resources.storagePools.methods.insert.parameters.zone.location - resources.storagePools.methods.insert.parameters.zone.pattern - resources.storagePools.methods.insert.parameters.zone.required - resources.storagePools.methods.insert.parameters.zone.type - resources.storagePools.methods.insert.path - resources.storagePools.methods.insert.request.$ref - resources.storagePools.methods.insert.response.$ref - resources.storagePools.methods.insert.scopes - resources.storagePools.methods.list.description - resources.storagePools.methods.list.flatPath - resources.storagePools.methods.list.httpMethod - resources.storagePools.methods.list.id - resources.storagePools.methods.list.parameterOrder - resources.storagePools.methods.list.parameters.filter.description - resources.storagePools.methods.list.parameters.filter.location - resources.storagePools.methods.list.parameters.filter.type - resources.storagePools.methods.list.parameters.maxResults.default - resources.storagePools.methods.list.parameters.maxResults.description - resources.storagePools.methods.list.parameters.maxResults.format - resources.storagePools.methods.list.parameters.maxResults.location - resources.storagePools.methods.list.parameters.maxResults.minimum - resources.storagePools.methods.list.parameters.maxResults.type - resources.storagePools.methods.list.parameters.orderBy.description - resources.storagePools.methods.list.parameters.orderBy.location - resources.storagePools.methods.list.parameters.orderBy.type - resources.storagePools.methods.list.parameters.pageToken.description - resources.storagePools.methods.list.parameters.pageToken.location - resources.storagePools.methods.list.parameters.pageToken.type - resources.storagePools.methods.list.parameters.project.description - resources.storagePools.methods.list.parameters.project.location - resources.storagePools.methods.list.parameters.project.pattern - resources.storagePools.methods.list.parameters.project.required - resources.storagePools.methods.list.parameters.project.type - resources.storagePools.methods.list.parameters.returnPartialSuccess.description - resources.storagePools.methods.list.parameters.returnPartialSuccess.location - resources.storagePools.methods.list.parameters.returnPartialSuccess.type - resources.storagePools.methods.list.parameters.zone.description - resources.storagePools.methods.list.parameters.zone.location - resources.storagePools.methods.list.parameters.zone.pattern - resources.storagePools.methods.list.parameters.zone.required - resources.storagePools.methods.list.parameters.zone.type - resources.storagePools.methods.list.path - resources.storagePools.methods.list.response.$ref - resources.storagePools.methods.list.scopes - resources.storagePools.methods.listDisks.description - resources.storagePools.methods.listDisks.flatPath - resources.storagePools.methods.listDisks.httpMethod - resources.storagePools.methods.listDisks.id - resources.storagePools.methods.listDisks.parameterOrder - resources.storagePools.methods.listDisks.parameters.filter.description - resources.storagePools.methods.listDisks.parameters.filter.location - resources.storagePools.methods.listDisks.parameters.filter.type - resources.storagePools.methods.listDisks.parameters.maxResults.default - resources.storagePools.methods.listDisks.parameters.maxResults.description - resources.storagePools.methods.listDisks.parameters.maxResults.format - resources.storagePools.methods.listDisks.parameters.maxResults.location - resources.storagePools.methods.listDisks.parameters.maxResults.minimum - resources.storagePools.methods.listDisks.parameters.maxResults.type - resources.storagePools.methods.listDisks.parameters.orderBy.description - resources.storagePools.methods.listDisks.parameters.orderBy.location - resources.storagePools.methods.listDisks.parameters.orderBy.type - resources.storagePools.methods.listDisks.parameters.pageToken.description - resources.storagePools.methods.listDisks.parameters.pageToken.location - resources.storagePools.methods.listDisks.parameters.pageToken.type - resources.storagePools.methods.listDisks.parameters.project.description - resources.storagePools.methods.listDisks.parameters.project.location - resources.storagePools.methods.listDisks.parameters.project.pattern - resources.storagePools.methods.listDisks.parameters.project.required - resources.storagePools.methods.listDisks.parameters.project.type - resources.storagePools.methods.listDisks.parameters.returnPartialSuccess.description - resources.storagePools.methods.listDisks.parameters.returnPartialSuccess.location - resources.storagePools.methods.listDisks.parameters.returnPartialSuccess.type - resources.storagePools.methods.listDisks.parameters.storagePool.description - resources.storagePools.methods.listDisks.parameters.storagePool.location - resources.storagePools.methods.listDisks.parameters.storagePool.pattern - resources.storagePools.methods.listDisks.parameters.storagePool.required - resources.storagePools.methods.listDisks.parameters.storagePool.type - resources.storagePools.methods.listDisks.parameters.zone.description - resources.storagePools.methods.listDisks.parameters.zone.location - resources.storagePools.methods.listDisks.parameters.zone.pattern - resources.storagePools.methods.listDisks.parameters.zone.required - resources.storagePools.methods.listDisks.parameters.zone.type - resources.storagePools.methods.listDisks.path - resources.storagePools.methods.listDisks.response.$ref - resources.storagePools.methods.listDisks.scopes - resources.storagePools.methods.setIamPolicy.description - resources.storagePools.methods.setIamPolicy.flatPath - resources.storagePools.methods.setIamPolicy.httpMethod - resources.storagePools.methods.setIamPolicy.id - resources.storagePools.methods.setIamPolicy.parameterOrder - resources.storagePools.methods.setIamPolicy.parameters.project.description - resources.storagePools.methods.setIamPolicy.parameters.project.location - resources.storagePools.methods.setIamPolicy.parameters.project.pattern - resources.storagePools.methods.setIamPolicy.parameters.project.required - resources.storagePools.methods.setIamPolicy.parameters.project.type - resources.storagePools.methods.setIamPolicy.parameters.resource.description - resources.storagePools.methods.setIamPolicy.parameters.resource.location - resources.storagePools.methods.setIamPolicy.parameters.resource.pattern - resources.storagePools.methods.setIamPolicy.parameters.resource.required - resources.storagePools.methods.setIamPolicy.parameters.resource.type - resources.storagePools.methods.setIamPolicy.parameters.zone.description - resources.storagePools.methods.setIamPolicy.parameters.zone.location - resources.storagePools.methods.setIamPolicy.parameters.zone.pattern - resources.storagePools.methods.setIamPolicy.parameters.zone.required - resources.storagePools.methods.setIamPolicy.parameters.zone.type - resources.storagePools.methods.setIamPolicy.path - resources.storagePools.methods.setIamPolicy.request.$ref - resources.storagePools.methods.setIamPolicy.response.$ref - resources.storagePools.methods.setIamPolicy.scopes - resources.storagePools.methods.testIamPermissions.description - resources.storagePools.methods.testIamPermissions.flatPath - resources.storagePools.methods.testIamPermissions.httpMethod - resources.storagePools.methods.testIamPermissions.id - resources.storagePools.methods.testIamPermissions.parameterOrder - resources.storagePools.methods.testIamPermissions.parameters.project.description - resources.storagePools.methods.testIamPermissions.parameters.project.location - resources.storagePools.methods.testIamPermissions.parameters.project.pattern - resources.storagePools.methods.testIamPermissions.parameters.project.required - resources.storagePools.methods.testIamPermissions.parameters.project.type - resources.storagePools.methods.testIamPermissions.parameters.resource.description - resources.storagePools.methods.testIamPermissions.parameters.resource.location - resources.storagePools.methods.testIamPermissions.parameters.resource.pattern - resources.storagePools.methods.testIamPermissions.parameters.resource.required - resources.storagePools.methods.testIamPermissions.parameters.resource.type - resources.storagePools.methods.testIamPermissions.parameters.zone.description - resources.storagePools.methods.testIamPermissions.parameters.zone.location - resources.storagePools.methods.testIamPermissions.parameters.zone.pattern - resources.storagePools.methods.testIamPermissions.parameters.zone.required - resources.storagePools.methods.testIamPermissions.parameters.zone.type - resources.storagePools.methods.testIamPermissions.path - resources.storagePools.methods.testIamPermissions.request.$ref - resources.storagePools.methods.testIamPermissions.response.$ref - resources.storagePools.methods.testIamPermissions.scopes - resources.storagePools.methods.update.description - resources.storagePools.methods.update.flatPath - resources.storagePools.methods.update.httpMethod - resources.storagePools.methods.update.id - resources.storagePools.methods.update.parameterOrder - resources.storagePools.methods.update.parameters.project.description - resources.storagePools.methods.update.parameters.project.location - resources.storagePools.methods.update.parameters.project.pattern - resources.storagePools.methods.update.parameters.project.required - resources.storagePools.methods.update.parameters.project.type - resources.storagePools.methods.update.parameters.requestId.description - resources.storagePools.methods.update.parameters.requestId.location - resources.storagePools.methods.update.parameters.requestId.type - resources.storagePools.methods.update.parameters.storagePool.description - resources.storagePools.methods.update.parameters.storagePool.location - resources.storagePools.methods.update.parameters.storagePool.pattern - resources.storagePools.methods.update.parameters.storagePool.required - resources.storagePools.methods.update.parameters.storagePool.type - resources.storagePools.methods.update.parameters.updateMask.description - resources.storagePools.methods.update.parameters.updateMask.format - resources.storagePools.methods.update.parameters.updateMask.location - resources.storagePools.methods.update.parameters.updateMask.type - resources.storagePools.methods.update.parameters.zone.description - resources.storagePools.methods.update.parameters.zone.location - resources.storagePools.methods.update.parameters.zone.pattern - resources.storagePools.methods.update.parameters.zone.required - resources.storagePools.methods.update.parameters.zone.type - resources.storagePools.methods.update.path - resources.storagePools.methods.update.request.$ref - resources.storagePools.methods.update.response.$ref - resources.storagePools.methods.update.scopes - schemas.AttachedDiskInitializeParams.properties.storagePool.description - schemas.AttachedDiskInitializeParams.properties.storagePool.type - schemas.Disk.properties.storagePool.description - schemas.Disk.properties.storagePool.type - schemas.InstanceGroupManagerResizeRequest.description - schemas.InstanceGroupManagerResizeRequest.id - schemas.InstanceGroupManagerResizeRequest.properties.creationTimestamp.description - schemas.InstanceGroupManagerResizeRequest.properties.creationTimestamp.type - schemas.InstanceGroupManagerResizeRequest.properties.description.description - schemas.InstanceGroupManagerResizeRequest.properties.description.type - schemas.InstanceGroupManagerResizeRequest.properties.id.description - schemas.InstanceGroupManagerResizeRequest.properties.id.format - schemas.InstanceGroupManagerResizeRequest.properties.id.type - schemas.InstanceGroupManagerResizeRequest.properties.kind.default - schemas.InstanceGroupManagerResizeRequest.properties.kind.description - schemas.InstanceGroupManagerResizeRequest.properties.kind.type - schemas.InstanceGroupManagerResizeRequest.properties.name.annotations.required - schemas.InstanceGroupManagerResizeRequest.properties.name.description - schemas.InstanceGroupManagerResizeRequest.properties.name.pattern - schemas.InstanceGroupManagerResizeRequest.properties.name.type - schemas.InstanceGroupManagerResizeRequest.properties.requestedRunDuration.$ref - schemas.InstanceGroupManagerResizeRequest.properties.requestedRunDuration.description - schemas.InstanceGroupManagerResizeRequest.properties.resizeBy.description - schemas.InstanceGroupManagerResizeRequest.properties.resizeBy.format - schemas.InstanceGroupManagerResizeRequest.properties.resizeBy.type - schemas.InstanceGroupManagerResizeRequest.properties.selfLink.description - schemas.InstanceGroupManagerResizeRequest.properties.selfLink.type - schemas.InstanceGroupManagerResizeRequest.properties.selfLinkWithId.description - schemas.InstanceGroupManagerResizeRequest.properties.selfLinkWithId.type - schemas.InstanceGroupManagerResizeRequest.properties.state.description - schemas.InstanceGroupManagerResizeRequest.properties.state.enum - schemas.InstanceGroupManagerResizeRequest.properties.state.enumDescriptions - schemas.InstanceGroupManagerResizeRequest.properties.state.type - schemas.InstanceGroupManagerResizeRequest.properties.status.$ref - schemas.InstanceGroupManagerResizeRequest.properties.status.description - schemas.InstanceGroupManagerResizeRequest.properties.zone.description - schemas.InstanceGroupManagerResizeRequest.properties.zone.type - schemas.InstanceGroupManagerResizeRequest.type - schemas.InstanceGroupManagerResizeRequestStatus.id - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.description - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.description - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.code.description - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.code.type - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.errorDetails.description - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.errorDetails.items.properties.errorInfo.$ref - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.errorDetails.items.properties.help.$ref - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.errorDetails.items.properties.localizedMessage.$ref - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.errorDetails.items.properties.quotaInfo.$ref - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.errorDetails.items.type - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.errorDetails.type - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.location.description - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.location.type - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.message.description - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.properties.message.type - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.items.type - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.properties.errors.type - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.type - schemas.InstanceGroupManagerResizeRequestStatus.properties.lastAttempt.$ref - schemas.InstanceGroupManagerResizeRequestStatus.properties.lastAttempt.description - schemas.InstanceGroupManagerResizeRequestStatus.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.id - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.description - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.description - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.code.description - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.code.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.errorDetails.description - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.errorDetails.items.properties.errorInfo.$ref - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.errorDetails.items.properties.help.$ref - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.errorDetails.items.properties.localizedMessage.$ref - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.errorDetails.items.properties.quotaInfo.$ref - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.errorDetails.items.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.errorDetails.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.location.description - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.location.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.message.description - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.properties.message.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.items.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.properties.errors.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.properties.error.type - schemas.InstanceGroupManagerResizeRequestStatusLastAttempt.type - schemas.InstanceGroupManagerResizeRequestsListResponse.description - schemas.InstanceGroupManagerResizeRequestsListResponse.id - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.id.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.id.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.items.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.items.items.$ref - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.items.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.kind.default - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.kind.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.kind.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.nextPageToken.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.nextPageToken.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.selfLink.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.selfLink.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.code.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.code.enum - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.code.enumDeprecated - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.code.enumDescriptions - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.code.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.data.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.data.items.properties.key.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.data.items.properties.key.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.data.items.properties.value.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.data.items.properties.value.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.data.items.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.data.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.message.description - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.properties.message.type - schemas.InstanceGroupManagerResizeRequestsListResponse.properties.warning.type - schemas.InstanceGroupManagerResizeRequestsListResponse.type - schemas.StoragePool.description - schemas.StoragePool.id - schemas.StoragePool.properties.capacityProvisioningType.description - schemas.StoragePool.properties.capacityProvisioningType.enum - schemas.StoragePool.properties.capacityProvisioningType.enumDescriptions - schemas.StoragePool.properties.capacityProvisioningType.type - schemas.StoragePool.properties.creationTimestamp.description - schemas.StoragePool.properties.creationTimestamp.type - schemas.StoragePool.properties.description.description - schemas.StoragePool.properties.description.type - schemas.StoragePool.properties.id.description - schemas.StoragePool.properties.id.format - schemas.StoragePool.properties.id.type - schemas.StoragePool.properties.kind.default - schemas.StoragePool.properties.kind.description - schemas.StoragePool.properties.kind.type - schemas.StoragePool.properties.labelFingerprint.description - schemas.StoragePool.properties.labelFingerprint.format - schemas.StoragePool.properties.labelFingerprint.type - schemas.StoragePool.properties.labels.additionalProperties.type - schemas.StoragePool.properties.labels.description - schemas.StoragePool.properties.labels.type - schemas.StoragePool.properties.name.annotations.required - schemas.StoragePool.properties.name.description - schemas.StoragePool.properties.name.pattern - schemas.StoragePool.properties.name.type - schemas.StoragePool.properties.performanceProvisioningType.description - schemas.StoragePool.properties.performanceProvisioningType.enum - schemas.StoragePool.properties.performanceProvisioningType.enumDescriptions - schemas.StoragePool.properties.performanceProvisioningType.type - schemas.StoragePool.properties.poolProvisionedCapacityGb.description - schemas.StoragePool.properties.poolProvisionedCapacityGb.format - schemas.StoragePool.properties.poolProvisionedCapacityGb.type - schemas.StoragePool.properties.poolProvisionedIops.description - schemas.StoragePool.properties.poolProvisionedIops.format - schemas.StoragePool.properties.poolProvisionedIops.type - schemas.StoragePool.properties.poolProvisionedThroughput.description - schemas.StoragePool.properties.poolProvisionedThroughput.format - schemas.StoragePool.properties.poolProvisionedThroughput.type - schemas.StoragePool.properties.resourceStatus.$ref - schemas.StoragePool.properties.resourceStatus.description - schemas.StoragePool.properties.selfLink.description - schemas.StoragePool.properties.selfLink.type - schemas.StoragePool.properties.selfLinkWithId.description - schemas.StoragePool.properties.selfLinkWithId.type - schemas.StoragePool.properties.state.description - schemas.StoragePool.properties.state.enum - schemas.StoragePool.properties.state.enumDescriptions - schemas.StoragePool.properties.state.type - schemas.StoragePool.properties.status.$ref - schemas.StoragePool.properties.status.description - schemas.StoragePool.properties.storagePoolType.description - schemas.StoragePool.properties.storagePoolType.type - schemas.StoragePool.properties.zone.description - schemas.StoragePool.properties.zone.type - schemas.StoragePool.type - schemas.StoragePoolAggregatedList.id - schemas.StoragePoolAggregatedList.properties.etag.type - schemas.StoragePoolAggregatedList.properties.id.description - schemas.StoragePoolAggregatedList.properties.id.type - schemas.StoragePoolAggregatedList.properties.items.additionalProperties.$ref - schemas.StoragePoolAggregatedList.properties.items.additionalProperties.description - schemas.StoragePoolAggregatedList.properties.items.description - schemas.StoragePoolAggregatedList.properties.items.type - schemas.StoragePoolAggregatedList.properties.kind.default - schemas.StoragePoolAggregatedList.properties.kind.description - schemas.StoragePoolAggregatedList.properties.kind.type - schemas.StoragePoolAggregatedList.properties.nextPageToken.description - schemas.StoragePoolAggregatedList.properties.nextPageToken.type - schemas.StoragePoolAggregatedList.properties.selfLink.description - schemas.StoragePoolAggregatedList.properties.selfLink.type - schemas.StoragePoolAggregatedList.properties.unreachables.description - schemas.StoragePoolAggregatedList.properties.unreachables.items.type - schemas.StoragePoolAggregatedList.properties.unreachables.type - schemas.StoragePoolAggregatedList.properties.warning.description - schemas.StoragePoolAggregatedList.properties.warning.properties.code.description - schemas.StoragePoolAggregatedList.properties.warning.properties.code.enum - schemas.StoragePoolAggregatedList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolAggregatedList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolAggregatedList.properties.warning.properties.code.type - schemas.StoragePoolAggregatedList.properties.warning.properties.data.description - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolAggregatedList.properties.warning.properties.data.items.type - schemas.StoragePoolAggregatedList.properties.warning.properties.data.type - schemas.StoragePoolAggregatedList.properties.warning.properties.message.description - schemas.StoragePoolAggregatedList.properties.warning.properties.message.type - schemas.StoragePoolAggregatedList.properties.warning.type - schemas.StoragePoolAggregatedList.type - schemas.StoragePoolDisk.id - schemas.StoragePoolDisk.properties.attachedInstances.description - schemas.StoragePoolDisk.properties.attachedInstances.items.type - schemas.StoragePoolDisk.properties.attachedInstances.type - schemas.StoragePoolDisk.properties.creationTimestamp.description - schemas.StoragePoolDisk.properties.creationTimestamp.type - schemas.StoragePoolDisk.properties.disk.description - schemas.StoragePoolDisk.properties.disk.type - schemas.StoragePoolDisk.properties.name.description - schemas.StoragePoolDisk.properties.name.type - schemas.StoragePoolDisk.properties.provisionedIops.description - schemas.StoragePoolDisk.properties.provisionedIops.format - schemas.StoragePoolDisk.properties.provisionedIops.type - schemas.StoragePoolDisk.properties.provisionedThroughput.description - schemas.StoragePoolDisk.properties.provisionedThroughput.format - schemas.StoragePoolDisk.properties.provisionedThroughput.type - schemas.StoragePoolDisk.properties.resourcePolicies.description - schemas.StoragePoolDisk.properties.resourcePolicies.items.type - schemas.StoragePoolDisk.properties.resourcePolicies.type - schemas.StoragePoolDisk.properties.sizeGb.description - schemas.StoragePoolDisk.properties.sizeGb.format - schemas.StoragePoolDisk.properties.sizeGb.type - schemas.StoragePoolDisk.properties.status.description - schemas.StoragePoolDisk.properties.status.enum - schemas.StoragePoolDisk.properties.status.enumDescriptions - schemas.StoragePoolDisk.properties.status.type - schemas.StoragePoolDisk.properties.type.description - schemas.StoragePoolDisk.properties.type.type - schemas.StoragePoolDisk.properties.usedBytes.description - schemas.StoragePoolDisk.properties.usedBytes.format - schemas.StoragePoolDisk.properties.usedBytes.type - schemas.StoragePoolDisk.type - schemas.StoragePoolList.description - schemas.StoragePoolList.id - schemas.StoragePoolList.properties.etag.type - schemas.StoragePoolList.properties.id.description - schemas.StoragePoolList.properties.id.type - schemas.StoragePoolList.properties.items.description - schemas.StoragePoolList.properties.items.items.$ref - schemas.StoragePoolList.properties.items.type - schemas.StoragePoolList.properties.kind.default - schemas.StoragePoolList.properties.kind.description - schemas.StoragePoolList.properties.kind.type - schemas.StoragePoolList.properties.nextPageToken.description - schemas.StoragePoolList.properties.nextPageToken.type - schemas.StoragePoolList.properties.selfLink.description - schemas.StoragePoolList.properties.selfLink.type - schemas.StoragePoolList.properties.unreachables.description - schemas.StoragePoolList.properties.unreachables.items.type - schemas.StoragePoolList.properties.unreachables.type - schemas.StoragePoolList.properties.warning.description - schemas.StoragePoolList.properties.warning.properties.code.description - schemas.StoragePoolList.properties.warning.properties.code.enum - schemas.StoragePoolList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolList.properties.warning.properties.code.type - schemas.StoragePoolList.properties.warning.properties.data.description - schemas.StoragePoolList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolList.properties.warning.properties.data.items.type - schemas.StoragePoolList.properties.warning.properties.data.type - schemas.StoragePoolList.properties.warning.properties.message.description - schemas.StoragePoolList.properties.warning.properties.message.type - schemas.StoragePoolList.properties.warning.type - schemas.StoragePoolList.type - schemas.StoragePoolListDisks.id - schemas.StoragePoolListDisks.properties.etag.type - schemas.StoragePoolListDisks.properties.id.description - schemas.StoragePoolListDisks.properties.id.type - schemas.StoragePoolListDisks.properties.items.description - schemas.StoragePoolListDisks.properties.items.items.$ref - schemas.StoragePoolListDisks.properties.items.type - schemas.StoragePoolListDisks.properties.kind.default - schemas.StoragePoolListDisks.properties.kind.description - schemas.StoragePoolListDisks.properties.kind.type - schemas.StoragePoolListDisks.properties.nextPageToken.description - schemas.StoragePoolListDisks.properties.nextPageToken.type - schemas.StoragePoolListDisks.properties.selfLink.description - schemas.StoragePoolListDisks.properties.selfLink.type - schemas.StoragePoolListDisks.properties.unreachables.description - schemas.StoragePoolListDisks.properties.unreachables.items.type - schemas.StoragePoolListDisks.properties.unreachables.type - schemas.StoragePoolListDisks.properties.warning.description - schemas.StoragePoolListDisks.properties.warning.properties.code.description - schemas.StoragePoolListDisks.properties.warning.properties.code.enum - schemas.StoragePoolListDisks.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolListDisks.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolListDisks.properties.warning.properties.code.type - schemas.StoragePoolListDisks.properties.warning.properties.data.description - schemas.StoragePoolListDisks.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolListDisks.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolListDisks.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolListDisks.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolListDisks.properties.warning.properties.data.items.type - schemas.StoragePoolListDisks.properties.warning.properties.data.type - schemas.StoragePoolListDisks.properties.warning.properties.message.description - schemas.StoragePoolListDisks.properties.warning.properties.message.type - schemas.StoragePoolListDisks.properties.warning.type - schemas.StoragePoolListDisks.type - schemas.StoragePoolResourceStatus.description - schemas.StoragePoolResourceStatus.id - schemas.StoragePoolResourceStatus.properties.diskCount.description - schemas.StoragePoolResourceStatus.properties.diskCount.format - schemas.StoragePoolResourceStatus.properties.diskCount.type - schemas.StoragePoolResourceStatus.properties.lastResizeTimestamp.description - schemas.StoragePoolResourceStatus.properties.lastResizeTimestamp.type - schemas.StoragePoolResourceStatus.properties.maxTotalProvisionedDiskCapacityGb.description - schemas.StoragePoolResourceStatus.properties.maxTotalProvisionedDiskCapacityGb.format - schemas.StoragePoolResourceStatus.properties.maxTotalProvisionedDiskCapacityGb.type - schemas.StoragePoolResourceStatus.properties.poolUsedCapacityBytes.description - schemas.StoragePoolResourceStatus.properties.poolUsedCapacityBytes.format - schemas.StoragePoolResourceStatus.properties.poolUsedCapacityBytes.type - schemas.StoragePoolResourceStatus.properties.poolUsedIops.description - schemas.StoragePoolResourceStatus.properties.poolUsedIops.format - schemas.StoragePoolResourceStatus.properties.poolUsedIops.type - schemas.StoragePoolResourceStatus.properties.poolUsedThroughput.description - schemas.StoragePoolResourceStatus.properties.poolUsedThroughput.format - schemas.StoragePoolResourceStatus.properties.poolUsedThroughput.type - schemas.StoragePoolResourceStatus.properties.poolUserWrittenBytes.description - schemas.StoragePoolResourceStatus.properties.poolUserWrittenBytes.format - schemas.StoragePoolResourceStatus.properties.poolUserWrittenBytes.type - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskCapacityGb.description - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskCapacityGb.format - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskCapacityGb.type - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskIops.description - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskIops.format - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskIops.type - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskThroughput.description - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskThroughput.format - schemas.StoragePoolResourceStatus.properties.totalProvisionedDiskThroughput.type - schemas.StoragePoolResourceStatus.type - schemas.StoragePoolType.id - schemas.StoragePoolType.properties.creationTimestamp.description - schemas.StoragePoolType.properties.creationTimestamp.type - schemas.StoragePoolType.properties.deprecated.$ref - schemas.StoragePoolType.properties.deprecated.description - schemas.StoragePoolType.properties.description.description - schemas.StoragePoolType.properties.description.type - schemas.StoragePoolType.properties.id.description - schemas.StoragePoolType.properties.id.format - schemas.StoragePoolType.properties.id.type - schemas.StoragePoolType.properties.kind.default - schemas.StoragePoolType.properties.kind.description - schemas.StoragePoolType.properties.kind.type - schemas.StoragePoolType.properties.maxPoolProvisionedCapacityGb.description - schemas.StoragePoolType.properties.maxPoolProvisionedCapacityGb.format - schemas.StoragePoolType.properties.maxPoolProvisionedCapacityGb.type - schemas.StoragePoolType.properties.maxPoolProvisionedIops.description - schemas.StoragePoolType.properties.maxPoolProvisionedIops.format - schemas.StoragePoolType.properties.maxPoolProvisionedIops.type - schemas.StoragePoolType.properties.maxPoolProvisionedThroughput.description - schemas.StoragePoolType.properties.maxPoolProvisionedThroughput.format - schemas.StoragePoolType.properties.maxPoolProvisionedThroughput.type - schemas.StoragePoolType.properties.minPoolProvisionedCapacityGb.description - schemas.StoragePoolType.properties.minPoolProvisionedCapacityGb.format - schemas.StoragePoolType.properties.minPoolProvisionedCapacityGb.type - schemas.StoragePoolType.properties.minPoolProvisionedIops.description - schemas.StoragePoolType.properties.minPoolProvisionedIops.format - schemas.StoragePoolType.properties.minPoolProvisionedIops.type - schemas.StoragePoolType.properties.minPoolProvisionedThroughput.description - schemas.StoragePoolType.properties.minPoolProvisionedThroughput.format - schemas.StoragePoolType.properties.minPoolProvisionedThroughput.type - schemas.StoragePoolType.properties.minSizeGb.description - schemas.StoragePoolType.properties.minSizeGb.format - schemas.StoragePoolType.properties.minSizeGb.type - schemas.StoragePoolType.properties.name.description - schemas.StoragePoolType.properties.name.pattern - schemas.StoragePoolType.properties.name.type - schemas.StoragePoolType.properties.selfLink.description - schemas.StoragePoolType.properties.selfLink.type - schemas.StoragePoolType.properties.selfLinkWithId.description - schemas.StoragePoolType.properties.selfLinkWithId.type - schemas.StoragePoolType.properties.supportedDiskTypes.description - schemas.StoragePoolType.properties.supportedDiskTypes.items.type - schemas.StoragePoolType.properties.supportedDiskTypes.type - schemas.StoragePoolType.properties.zone.description - schemas.StoragePoolType.properties.zone.type - schemas.StoragePoolType.type - schemas.StoragePoolTypeAggregatedList.id - schemas.StoragePoolTypeAggregatedList.properties.id.description - schemas.StoragePoolTypeAggregatedList.properties.id.type - schemas.StoragePoolTypeAggregatedList.properties.items.additionalProperties.$ref - schemas.StoragePoolTypeAggregatedList.properties.items.additionalProperties.description - schemas.StoragePoolTypeAggregatedList.properties.items.description - schemas.StoragePoolTypeAggregatedList.properties.items.type - schemas.StoragePoolTypeAggregatedList.properties.kind.default - schemas.StoragePoolTypeAggregatedList.properties.kind.description - schemas.StoragePoolTypeAggregatedList.properties.kind.type - schemas.StoragePoolTypeAggregatedList.properties.nextPageToken.description - schemas.StoragePoolTypeAggregatedList.properties.nextPageToken.type - schemas.StoragePoolTypeAggregatedList.properties.selfLink.description - schemas.StoragePoolTypeAggregatedList.properties.selfLink.type - schemas.StoragePoolTypeAggregatedList.properties.warning.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.enum - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.code.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.items.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.data.type - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.message.description - schemas.StoragePoolTypeAggregatedList.properties.warning.properties.message.type - schemas.StoragePoolTypeAggregatedList.properties.warning.type - schemas.StoragePoolTypeAggregatedList.type - schemas.StoragePoolTypeList.description - schemas.StoragePoolTypeList.id - schemas.StoragePoolTypeList.properties.id.description - schemas.StoragePoolTypeList.properties.id.type - schemas.StoragePoolTypeList.properties.items.description - schemas.StoragePoolTypeList.properties.items.items.$ref - schemas.StoragePoolTypeList.properties.items.type - schemas.StoragePoolTypeList.properties.kind.default - schemas.StoragePoolTypeList.properties.kind.description - schemas.StoragePoolTypeList.properties.kind.type - schemas.StoragePoolTypeList.properties.nextPageToken.description - schemas.StoragePoolTypeList.properties.nextPageToken.type - schemas.StoragePoolTypeList.properties.selfLink.description - schemas.StoragePoolTypeList.properties.selfLink.type - schemas.StoragePoolTypeList.properties.warning.description - schemas.StoragePoolTypeList.properties.warning.properties.code.description - schemas.StoragePoolTypeList.properties.warning.properties.code.enum - schemas.StoragePoolTypeList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolTypeList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolTypeList.properties.warning.properties.code.type - schemas.StoragePoolTypeList.properties.warning.properties.data.description - schemas.StoragePoolTypeList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolTypeList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolTypeList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolTypeList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolTypeList.properties.warning.properties.data.items.type - schemas.StoragePoolTypeList.properties.warning.properties.data.type - schemas.StoragePoolTypeList.properties.warning.properties.message.description - schemas.StoragePoolTypeList.properties.warning.properties.message.type - schemas.StoragePoolTypeList.properties.warning.type - schemas.StoragePoolTypeList.type - schemas.StoragePoolTypesScopedList.id - schemas.StoragePoolTypesScopedList.properties.storagePoolTypes.description - schemas.StoragePoolTypesScopedList.properties.storagePoolTypes.items.$ref - schemas.StoragePoolTypesScopedList.properties.storagePoolTypes.type - schemas.StoragePoolTypesScopedList.properties.warning.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.enum - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolTypesScopedList.properties.warning.properties.code.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.items.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.data.type - schemas.StoragePoolTypesScopedList.properties.warning.properties.message.description - schemas.StoragePoolTypesScopedList.properties.warning.properties.message.type - schemas.StoragePoolTypesScopedList.properties.warning.type - schemas.StoragePoolTypesScopedList.type - schemas.StoragePoolsScopedList.id - schemas.StoragePoolsScopedList.properties.storagePools.description - schemas.StoragePoolsScopedList.properties.storagePools.items.$ref - schemas.StoragePoolsScopedList.properties.storagePools.type - schemas.StoragePoolsScopedList.properties.warning.description - schemas.StoragePoolsScopedList.properties.warning.properties.code.description - schemas.StoragePoolsScopedList.properties.warning.properties.code.enum - schemas.StoragePoolsScopedList.properties.warning.properties.code.enumDeprecated - schemas.StoragePoolsScopedList.properties.warning.properties.code.enumDescriptions - schemas.StoragePoolsScopedList.properties.warning.properties.code.type - schemas.StoragePoolsScopedList.properties.warning.properties.data.description - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.properties.key.description - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.properties.key.type - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.properties.value.description - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.properties.value.type - schemas.StoragePoolsScopedList.properties.warning.properties.data.items.type - schemas.StoragePoolsScopedList.properties.warning.properties.data.type - schemas.StoragePoolsScopedList.properties.warning.properties.message.description - schemas.StoragePoolsScopedList.properties.warning.properties.message.type - schemas.StoragePoolsScopedList.properties.warning.type - schemas.StoragePoolsScopedList.type The following keys were changed: - schemas.Commitment.properties.type.enum - schemas.Commitment.properties.type.enumDescriptions - schemas.CorsPolicy.properties.allowOriginRegexes.description - schemas.CorsPolicy.properties.disabled.description - schemas.Disk.properties.status.enum - schemas.Disk.properties.status.enumDescriptions - schemas.GuestOsFeature.properties.type.description - schemas.InstantSnapshot.properties.status.enum - schemas.InstantSnapshot.properties.status.enumDescriptions - schemas.InterconnectRemoteLocationConstraints.properties.portPairRemoteLocation.description - schemas.Quota.properties.metric.enum - schemas.Quota.properties.metric.enumDescriptions - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.type.description --- discovery/compute-alpha.json | 367 +- discovery/compute-beta.json | 5537 ++++++++---- discovery/compute-v1.json | 14932 +++++++++++++++++++-------------- src/apis/compute/alpha.ts | 73 +- src/apis/compute/beta.ts | 1999 ++++- src/apis/compute/v1.ts | 2710 +++++- 6 files changed, 17805 insertions(+), 7813 deletions(-) diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index 8d148687cdc..d7d6ef28772 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -43897,7 +43897,7 @@ } } }, - "revision": "20240220", + "revision": "20240305", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48777,11 +48777,6 @@ "description": "Network Layer Reachability Information (NLRI) for a route.", "id": "BgpRouteNetworkLayerReachabilityInformation", "properties": { - "destination": { - "deprecated": true, - "description": "Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16. Deprecated in favor of prefix.", - "type": "string" - }, "pathId": { "description": "If the BGP session supports multiple paths (RFC 7911), the path identifier for this route.", "format": "uint32", @@ -49286,6 +49281,7 @@ "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", + "GENERAL_PURPOSE_N4", "GENERAL_PURPOSE_T2D", "GRAPHICS_OPTIMIZED", "MEMORY_OPTIMIZED", @@ -49310,6 +49306,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49980,7 +49977,7 @@ "type": "array" }, "allowOriginRegexes": { - "description": "Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", + "description": "Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", "items": { "type": "string" }, @@ -49994,7 +49991,7 @@ "type": "array" }, "disabled": { - "description": "If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.", + "description": "If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.", "type": "boolean" }, "exposeHeaders": { @@ -54636,6 +54633,35 @@ }, "type": "object" }, + "GRPCTLSHealthCheck": { + "id": "GRPCTLSHealthCheck", + "properties": { + "grpcServiceName": { + "description": "The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII.", + "type": "string" + }, + "port": { + "description": "The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.", + "format": "int32", + "type": "integer" + }, + "portSpecification": { + "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", + "enum": [ + "USE_FIXED_PORT", + "USE_NAMED_PORT", + "USE_SERVING_PORT" + ], + "enumDescriptions": [ + "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", + "Not supported.", + "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." + ], + "type": "string" + } + }, + "type": "object" + }, "GetOwnerInstanceResponse": { "id": "GetOwnerInstanceResponse", "properties": { @@ -54836,7 +54862,7 @@ "id": "GuestOsFeature", "properties": { "type": { - "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", + "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", "enum": [ "BARE_METAL_LINUX_COMPATIBLE", "FEATURE_TYPE_UNSPECIFIED", @@ -55095,6 +55121,9 @@ "grpcHealthCheck": { "$ref": "GRPCHealthCheck" }, + "grpcTlsHealthCheck": { + "$ref": "GRPCTLSHealthCheck" + }, "healthyThreshold": { "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", "format": "int32", @@ -59342,7 +59371,8 @@ "id": "InstanceGroupManagerResizeRequest", "properties": { "count": { - "description": "The count of instances to create as part of this resize request.", + "deprecated": true, + "description": "This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.", "format": "int32", "type": "integer" }, @@ -59376,7 +59406,8 @@ }, "queuingPolicy": { "$ref": "QueuingPolicy", - "description": "When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible." + "deprecated": true, + "description": "This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible." }, "requestedRunDuration": { "$ref": "Duration", @@ -59404,15 +59435,27 @@ "DELETING", "FAILED", "PROVISIONING", + "STATE_UNSPECIFIED", "SUCCEEDED" ], + "enumDeprecated": [ + false, + false, + false, + true, + false, + true, + false, + false + ], "enumDescriptions": [ "The request was created successfully and was accepted for provisioning when the capacity becomes available.", "The request is cancelled.", - "resize request is being created and may still fail creation.", - "The request is being deleted.", + "Resize request is being created and may still fail creation.", + "The value is deprecated. ResizeRequests would not change state while being deleted. The request is being deleted.", "The request failed before or during provisioning. If the request fails during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.", - "The target resource(s) are being provisioned.", + "The value is deprecated. ResizeRequests would stay in the ACCEPTED state during provisioning attempts. The target resource(s) are being provisioned.", + "Default value. This value should never be returned.", "The request succeeded." ], "type": "string" @@ -59485,7 +59528,8 @@ }, "queuingPolicy": { "$ref": "QueuingPolicy", - "description": "Constraints for the time when the instances start provisioning. Always exposed as absolute time." + "deprecated": true, + "description": "This field is deprecated, setting queueing policy is no longer supported. Constraints for the time when the instances start provisioning. Always exposed as absolute time." } }, "type": "object" @@ -62557,13 +62601,15 @@ "CREATING", "DELETING", "FAILED", - "READY" + "READY", + "UNAVAILABLE" ], "enumDescriptions": [ "InstantSnapshot creation is in progress.", "InstantSnapshot is currently being deleted.", "InstantSnapshot creation failed.", - "InstantSnapshot has been created successfully." + "InstantSnapshot has been created successfully.", + "InstantSnapshot is currently unavailable and cannot be used for Disk restoration" ], "type": "string" }, @@ -65014,7 +65060,7 @@ "id": "InterconnectRemoteLocationConstraints", "properties": { "portPairRemoteLocation": { - "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. GCP's API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", + "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", "enum": [ "PORT_PAIR_MATCHING_REMOTE_LOCATION", "PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION" @@ -67664,6 +67710,10 @@ ], "type": "string" }, + "networkPlacement": { + "description": "A full or partial URL of the network placement to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/alpha/projects/{project_id}/global/networkPlacements/{network_placement_name} - projects/{project_id}/global/networkPlacements/{network_placement_name} ", + "type": "string" + }, "peerings": { "description": "[Output Only] A list of network peerings for the resource.", "items": { @@ -69216,6 +69266,11 @@ "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", "type": "string" }, + "producerPort": { + "description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", + "format": "int32", + "type": "integer" + }, "pscConnectionId": { "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", "format": "uint64", @@ -76622,6 +76677,9 @@ "GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES", "GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES", "GPUS_ALL_REGIONS", + "HDB_TOTAL_GB", + "HDB_TOTAL_IOPS", + "HDB_TOTAL_THROUGHPUT", "HEALTH_CHECKS", "IMAGES", "INSTANCES", @@ -76699,6 +76757,7 @@ "REGIONAL_INSTANCE_GROUP_MANAGERS", "REGIONAL_INTERNAL_LB_BACKEND_SERVICES", "REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES", + "REGIONAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES", "RESERVATIONS", "RESOURCE_POLICIES", "ROUTERS", @@ -76876,6 +76935,10 @@ "", "", "", + "", + "", + "", + "", "The total number of snapshots allowed for a single project.", "", "", @@ -77037,6 +77100,127 @@ "description": "[Output Only] Name of the resource.", "type": "string" }, + "quotaStatusWarning": { + "description": "[Output Only] Warning of fetching the `quotas` field for this region. This field is populated only if fetching of the `quotas` field fails.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + }, "quotas": { "description": "[Output Only] Quotas assigned to this region.", "items": { @@ -78625,7 +78809,7 @@ "type": "array" }, "type": { - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", "enum": [ "HIERARCHY", "NETWORK", @@ -90731,6 +90915,137 @@ }, "type": "object" }, + "SubnetworksScopedWarning": { + "id": "SubnetworksScopedWarning", + "properties": { + "scopeName": { + "description": "Name of the scope containing this set of Subnetworks.", + "type": "string" + }, + "warning": { + "description": "An informational warning about unreachable scope", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "SubnetworksSetPrivateIpGoogleAccessRequest": { "id": "SubnetworksSetPrivateIpGoogleAccessRequest", "properties": { @@ -95722,10 +96037,24 @@ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. In special cases listUsable may return 0 subnetworks and nextPageToken which still should be used to get the next page of results.", "type": "string" }, + "scoped_warnings": { + "description": "[Output Only] Informational warning messages for failures encountered from scopes.", + "items": { + "$ref": "SubnetworksScopedWarning" + }, + "type": "array" + }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index fcf8a445b39..90478d83355 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -5309,11 +5309,6 @@ "required": true, "type": "string" }, - "paths": { - "location": "query", - "repeated": true, - "type": "string" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -8080,6 +8075,12 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "zone": { + "description": "The zone query parameter.", + "location": "query", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" } }, "path": "projects/{project}/global/images", @@ -34964,13 +34965,13 @@ } } }, - "subnetworks": { + "storagePoolTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/subnetworks", + "description": "Retrieves an aggregated list of storage pool types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/storagePoolTypes", "httpMethod": "GET", - "id": "compute.subnetworks.aggregatedList", + "id": "compute.storagePoolTypes.aggregatedList", "parameterOrder": [ "project" ], @@ -35022,9 +35023,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/subnetworks", + "path": "projects/{project}/aggregated/storagePoolTypes", "response": { - "$ref": "SubnetworkAggregatedList" + "$ref": "StoragePoolTypeAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35032,15 +35033,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "delete": { - "description": "Deletes the specified subnetwork.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "httpMethod": "DELETE", - "id": "compute.subnetworks.delete", + "get": { + "description": "Returns the specified storage pool type.", + "flatPath": "projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}", + "httpMethod": "GET", + "id": "compute.storagePoolTypes.get", "parameterOrder": [ "project", - "region", - "subnetwork" + "zone", + "storagePoolType" ], "parameters": { "project": { @@ -35050,46 +35051,135 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "storagePoolType": { + "description": "Name of the storage pool type to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}", + "response": { + "$ref": "StoragePoolType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves a list of storage pool types available to the specified project.", + "flatPath": "projects/{project}/zones/{zone}/storagePoolTypes", + "httpMethod": "GET", + "id": "compute.storagePoolTypes.list", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, - "subnetwork": { - "description": "Name of the Subnetwork resource to delete.", + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "path": "projects/{project}/zones/{zone}/storagePoolTypes", "response": { - "$ref": "Operation" + "$ref": "StoragePoolTypeList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - }, - "expandIpCidrRange": { - "description": "Expands the IP CIDR range of the subnetwork to a specified value.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", - "httpMethod": "POST", - "id": "compute.subnetworks.expandIpCidrRange", + } + } + }, + "storagePools": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/storagePools", + "httpMethod": "GET", + "id": "compute.storagePools.aggregatedList", "parameterOrder": [ - "project", - "region", - "subnetwork" + "project" ], "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -35097,10 +35187,43 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/storagePools", + "response": { + "$ref": "StoragePoolAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified storage pool. Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", + "httpMethod": "DELETE", + "id": "compute.storagePools.delete", + "parameterOrder": [ + "project", + "zone", + "storagePool" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, @@ -35109,18 +35232,21 @@ "location": "query", "type": "string" }, - "subnetwork": { - "description": "Name of the Subnetwork resource to update.", + "storagePool": { + "description": "Name of the storage pool to delete.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", - "request": { - "$ref": "SubnetworksExpandIpCidrRangeRequest" - }, + "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "response": { "$ref": "Operation" }, @@ -35130,14 +35256,14 @@ ] }, "get": { - "description": "Returns the specified subnetwork.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "description": "Returns a specified storage pool. Gets a list of available storage pools by making a list() request.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "httpMethod": "GET", - "id": "compute.subnetworks.get", + "id": "compute.storagePools.get", "parameterOrder": [ "project", - "region", - "subnetwork" + "zone", + "storagePool" ], "parameters": { "project": { @@ -35147,24 +35273,24 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "storagePool": { + "description": "Name of the storage pool to return.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, - "subnetwork": { - "description": "Name of the Subnetwork resource to return.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "response": { - "$ref": "Subnetwork" + "$ref": "StoragePool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35174,12 +35300,12 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy", "httpMethod": "GET", - "id": "compute.subnetworks.getIamPolicy", + "id": "compute.storagePools.getIamPolicy", "parameterOrder": [ "project", - "region", + "zone", "resource" ], "parameters": { @@ -35196,22 +35322,22 @@ "required": true, "type": "string" }, - "region": { - "description": "The name of the region for this request.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", + "path": "projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -35222,13 +35348,13 @@ ] }, "insert": { - "description": "Creates a subnetwork in the specified project using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/subnetworks", + "description": "Creates a storage pool in the specified project using the data in the request.", + "flatPath": "projects/{project}/zones/{zone}/storagePools", "httpMethod": "POST", - "id": "compute.subnetworks.insert", + "id": "compute.storagePools.insert", "parameterOrder": [ "project", - "region" + "zone" ], "parameters": { "project": { @@ -35238,22 +35364,22 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks", + "path": "projects/{project}/zones/{zone}/storagePools", "request": { - "$ref": "Subnetwork" + "$ref": "StoragePool" }, "response": { "$ref": "Operation" @@ -35264,13 +35390,13 @@ ] }, "list": { - "description": "Retrieves a list of subnetworks available to the specified project.", - "flatPath": "projects/{project}/regions/{region}/subnetworks", + "description": "Retrieves a list of storage pools contained within the specified zone.", + "flatPath": "projects/{project}/zones/{zone}/storagePools", "httpMethod": "GET", - "id": "compute.subnetworks.list", + "id": "compute.storagePools.list", "parameterOrder": [ "project", - "region" + "zone" ], "parameters": { "filter": { @@ -35303,22 +35429,22 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks", + "path": "projects/{project}/zones/{zone}/storagePools", "response": { - "$ref": "SubnetworkList" + "$ref": "StoragePoolList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35326,13 +35452,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "listUsable": { - "description": "Retrieves an aggregated list of all usable subnetworks in the project.", - "flatPath": "projects/{project}/aggregated/subnetworks/listUsable", + "listDisks": { + "description": "Lists the disks in a specified storage pool.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks", "httpMethod": "GET", - "id": "compute.subnetworks.listUsable", + "id": "compute.storagePools.listDisks", "parameterOrder": [ - "project" + "project", + "zone", + "storagePool" ], "parameters": { "filter": { @@ -35370,86 +35498,39 @@ "location": "query", "type": "boolean" }, - "serviceProject": { - "description": "The project id or project number in which the subnetwork is intended to be used. Only applied for Shared VPC. See [Shared VPC documentation](https://cloud.google.com/vpc/docs/shared-vpc/)", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/aggregated/subnetworks/listUsable", - "response": { - "$ref": "UsableSubnetworksAggregatedList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "patch": { - "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "httpMethod": "PATCH", - "id": "compute.subnetworks.patch", - "parameterOrder": [ - "project", - "region", - "subnetwork" - ], - "parameters": { - "drainTimeoutSeconds": { - "description": "The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "project": { - "description": "Project ID for this request.", + "storagePool": { + "description": "Name of the storage pool to list disks of.", "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "subnetwork": { - "description": "Name of the Subnetwork resource to patch.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "request": { - "$ref": "Subnetwork" - }, + "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks", "response": { - "$ref": "Operation" + "$ref": "StoragePoolListDisks" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy", "httpMethod": "POST", - "id": "compute.subnetworks.setIamPolicy", + "id": "compute.storagePools.setIamPolicy", "parameterOrder": [ "project", - "region", + "zone", "resource" ], "parameters": { @@ -35460,77 +35541,27 @@ "required": true, "type": "string" }, - "region": { - "description": "The name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "resource": { "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", - "request": { - "$ref": "RegionSetPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "setPrivateIpGoogleAccess": { - "description": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", - "httpMethod": "POST", - "id": "compute.subnetworks.setPrivateIpGoogleAccess", - "parameterOrder": [ - "project", - "region", - "subnetwork" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "subnetwork": { - "description": "Name of the Subnetwork resource.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", + "path": "projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy", "request": { - "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest" + "$ref": "ZoneSetPolicyRequest" }, "response": { - "$ref": "Operation" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35539,12 +35570,12 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.subnetworks.testIamPermissions", + "id": "compute.storagePools.testIamPermissions", "parameterOrder": [ "project", - "region", + "zone", "resource" ], "parameters": { @@ -35555,22 +35586,22 @@ "required": true, "type": "string" }, - "region": { - "description": "The name of the region for this request.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", + "path": "projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -35582,19 +35613,16 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "targetGrpcProxies": { - "methods": { - "delete": { - "description": "Deletes the specified TargetGrpcProxy in the given scope", - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "httpMethod": "DELETE", - "id": "compute.targetGrpcProxies.delete", + }, + "update": { + "description": "Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: size_tb and provisioned_iops.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", + "httpMethod": "PATCH", + "id": "compute.storagePools.update", "parameterOrder": [ "project", - "targetGrpcProxy" + "zone", + "storagePool" ], "parameters": { "project": { @@ -35609,83 +35637,30 @@ "location": "query", "type": "string" }, - "targetGrpcProxy": { - "description": "Name of the TargetGrpcProxy resource to delete.", + "storagePool": { + "description": "The storagePool name for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - } - }, - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "description": "Returns the specified TargetGrpcProxy resource in the given scope.", - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "httpMethod": "GET", - "id": "compute.targetGrpcProxies.get", - "parameterOrder": [ - "project", - "targetGrpcProxy" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" }, - "targetGrpcProxy": { - "description": "Name of the TargetGrpcProxy resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, + "updateMask": { + "description": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "location": "query", "type": "string" - } - }, - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "response": { - "$ref": "TargetGrpcProxy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "insert": { - "description": "Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.", - "flatPath": "projects/{project}/global/targetGrpcProxies", - "httpMethod": "POST", - "id": "compute.targetGrpcProxies.insert", - "parameterOrder": [ - "project" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", + }, + "zone": { + "description": "The name of the zone for this request.", "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" } }, - "path": "projects/{project}/global/targetGrpcProxies", + "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "request": { - "$ref": "TargetGrpcProxy" + "$ref": "StoragePool" }, "response": { "$ref": "Operation" @@ -35694,12 +35669,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "list": { - "description": "Lists the TargetGrpcProxies for a project in the given scope.", - "flatPath": "projects/{project}/global/targetGrpcProxies", + } + } + }, + "subnetworks": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/subnetworks", "httpMethod": "GET", - "id": "compute.targetGrpcProxies.list", + "id": "compute.subnetworks.aggregatedList", "parameterOrder": [ "project" ], @@ -35709,6 +35688,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -35738,11 +35722,17 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/global/targetGrpcProxies", + "path": "projects/{project}/aggregated/subnetworks", "response": { - "$ref": "TargetGrpcProxyList" + "$ref": "SubnetworkAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35750,14 +35740,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "httpMethod": "PATCH", - "id": "compute.targetGrpcProxies.patch", + "delete": { + "description": "Deletes the specified subnetwork.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "httpMethod": "DELETE", + "id": "compute.subnetworks.delete", "parameterOrder": [ "project", - "targetGrpcProxy" + "region", + "subnetwork" ], "parameters": { "project": { @@ -35767,23 +35758,27 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetGrpcProxy": { - "description": "Name of the TargetGrpcProxy resource to patch.", + "subnetwork": { + "description": "Name of the Subnetwork resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "request": { - "$ref": "TargetGrpcProxy" - }, + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "response": { "$ref": "Operation" }, @@ -35792,14 +35787,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/global/targetGrpcProxies/{resource}/testIamPermissions", + "expandIpCidrRange": { + "description": "Expands the IP CIDR range of the subnetwork to a specified value.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", "httpMethod": "POST", - "id": "compute.targetGrpcProxies.testIamPermissions", + "id": "compute.subnetworks.expandIpCidrRange", "parameterOrder": [ "project", - "resource" + "region", + "subnetwork" ], "parameters": { "project": { @@ -35809,105 +35805,47 @@ "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "region": { + "description": "Name of the region scoping this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - } - }, - "path": "projects/{project}/global/targetGrpcProxies/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, - "response": { - "$ref": "TestPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - } - } - }, - "targetHttpProxies": { - "methods": { - "aggregatedList": { - "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetHttpProxies", - "httpMethod": "GET", - "id": "compute.targetHttpProxies.aggregatedList", - "parameterOrder": [ - "project" - ], - "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "project": { - "description": "Name of the project scoping this request.", + "subnetwork": { + "description": "Name of the Subnetwork resource to update.", "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", - "location": "query", - "type": "string" } }, - "path": "projects/{project}/aggregated/targetHttpProxies", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", + "request": { + "$ref": "SubnetworksExpandIpCidrRangeRequest" + }, "response": { - "$ref": "TargetHttpProxyAggregatedList" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, - "delete": { - "description": "Deletes the specified TargetHttpProxy resource.", - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "httpMethod": "DELETE", - "id": "compute.targetHttpProxies.delete", + "get": { + "description": "Returns the specified subnetwork.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "httpMethod": "GET", + "id": "compute.subnetworks.get", "parameterOrder": [ "project", - "targetHttpProxy" + "region", + "subnetwork" ], "parameters": { "project": { @@ -35917,38 +35855,48 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy resource to delete.", + "subnetwork": { + "description": "Name of the Subnetwork resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "response": { - "$ref": "Operation" + "$ref": "Subnetwork" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "get": { - "description": "Returns the specified TargetHttpProxy resource.", - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", "httpMethod": "GET", - "id": "compute.targetHttpProxies.get", + "id": "compute.subnetworks.getIamPolicy", "parameterOrder": [ "project", - "targetHttpProxy" + "region", + "resource" ], "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -35956,17 +35904,24 @@ "required": true, "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy resource to return.", + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", "response": { - "$ref": "TargetHttpProxy" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35975,12 +35930,13 @@ ] }, "insert": { - "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/targetHttpProxies", + "description": "Creates a subnetwork in the specified project using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/subnetworks", "httpMethod": "POST", - "id": "compute.targetHttpProxies.insert", + "id": "compute.subnetworks.insert", "parameterOrder": [ - "project" + "project", + "region" ], "parameters": { "project": { @@ -35990,15 +35946,22 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies", + "path": "projects/{project}/regions/{region}/subnetworks", "request": { - "$ref": "TargetHttpProxy" + "$ref": "Subnetwork" }, "response": { "$ref": "Operation" @@ -36009,12 +35972,13 @@ ] }, "list": { - "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.", - "flatPath": "projects/{project}/global/targetHttpProxies", + "description": "Retrieves a list of subnetworks available to the specified project.", + "flatPath": "projects/{project}/regions/{region}/subnetworks", "httpMethod": "GET", - "id": "compute.targetHttpProxies.list", + "id": "compute.subnetworks.list", "parameterOrder": [ - "project" + "project", + "region" ], "parameters": { "filter": { @@ -36047,15 +36011,22 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, - "path": "projects/{project}/global/targetHttpProxies", + "path": "projects/{project}/regions/{region}/subnetworks", "response": { - "$ref": "TargetHttpProxyList" + "$ref": "SubnetworkList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36063,58 +36034,83 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "httpMethod": "PATCH", - "id": "compute.targetHttpProxies.patch", + "listUsable": { + "description": "Retrieves an aggregated list of all usable subnetworks in the project.", + "flatPath": "projects/{project}/aggregated/subnetworks/listUsable", + "httpMethod": "GET", + "id": "compute.subnetworks.listUsable", "parameterOrder": [ - "project", - "targetHttpProxy" + "project" ], "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy resource to patch.", + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProject": { + "description": "The project id or project number in which the subnetwork is intended to be used. Only applied for Shared VPC. See [Shared VPC documentation](https://cloud.google.com/vpc/docs/shared-vpc/)", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "request": { - "$ref": "TargetHttpProxy" - }, + "path": "projects/{project}/aggregated/subnetworks/listUsable", "response": { - "$ref": "Operation" + "$ref": "UsableSubnetworksAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "setUrlMap": { - "description": "Changes the URL map for TargetHttpProxy.", - "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", - "httpMethod": "POST", - "id": "compute.targetHttpProxies.setUrlMap", + "patch": { + "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "httpMethod": "PATCH", + "id": "compute.subnetworks.patch", "parameterOrder": [ "project", - "targetHttpProxy" + "region", + "subnetwork" ], "parameters": { + "drainTimeoutSeconds": { + "description": "The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36122,22 +36118,29 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy to set a URL map for.", + "subnetwork": { + "description": "Name of the Subnetwork resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "request": { - "$ref": "UrlMapReference" + "$ref": "Subnetwork" }, "response": { "$ref": "Operation" @@ -36147,13 +36150,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/global/targetHttpProxies/{resource}/testIamPermissions", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", "httpMethod": "POST", - "id": "compute.targetHttpProxies.testIamPermissions", + "id": "compute.subnetworks.setIamPolicy", "parameterOrder": [ "project", + "region", "resource" ], "parameters": { @@ -36164,105 +36168,141 @@ "required": true, "type": "string" }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "resource": { "description": "Name or id of the resource for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", "request": { - "$ref": "TestPermissionsRequest" + "$ref": "RegionSetPolicyRequest" }, "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] - } - } - }, - "targetHttpsProxies": { - "methods": { - "aggregatedList": { - "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetHttpsProxies", - "httpMethod": "GET", - "id": "compute.targetHttpsProxies.aggregatedList", + }, + "setPrivateIpGoogleAccess": { + "description": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", + "httpMethod": "POST", + "id": "compute.subnetworks.setPrivateIpGoogleAccess", "parameterOrder": [ - "project" + "project", + "region", + "subnetwork" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, "type": "string" }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, + "subnetwork": { + "description": "Name of the Subnetwork resource.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", + "request": { + "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.subnetworks.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { "project": { - "description": "Name of the project scoping this request.", + "description": "Project ID for this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", - "location": "query", + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, "type": "string" } }, - "path": "projects/{project}/aggregated/targetHttpsProxies", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, "response": { - "$ref": "TargetHttpsProxyAggregatedList" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, + } + } + }, + "targetGrpcProxies": { + "methods": { "delete": { - "description": "Deletes the specified TargetHttpsProxy resource.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "description": "Deletes the specified TargetGrpcProxy in the given scope", + "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "httpMethod": "DELETE", - "id": "compute.targetHttpsProxies.delete", + "id": "compute.targetGrpcProxies.delete", "parameterOrder": [ "project", - "targetHttpsProxy" + "targetGrpcProxy" ], "parameters": { "project": { @@ -36277,15 +36317,15 @@ "location": "query", "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to delete.", + "targetGrpcProxy": { + "description": "Name of the TargetGrpcProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "response": { "$ref": "Operation" }, @@ -36295,13 +36335,13 @@ ] }, "get": { - "description": "Returns the specified TargetHttpsProxy resource.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "description": "Returns the specified TargetGrpcProxy resource in the given scope.", + "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "httpMethod": "GET", - "id": "compute.targetHttpsProxies.get", + "id": "compute.targetGrpcProxies.get", "parameterOrder": [ "project", - "targetHttpsProxy" + "targetGrpcProxy" ], "parameters": { "project": { @@ -36311,17 +36351,17 @@ "required": true, "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to return.", + "targetGrpcProxy": { + "description": "Name of the TargetGrpcProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "response": { - "$ref": "TargetHttpsProxy" + "$ref": "TargetGrpcProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36330,10 +36370,10 @@ ] }, "insert": { - "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/targetHttpsProxies", + "description": "Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.", + "flatPath": "projects/{project}/global/targetGrpcProxies", "httpMethod": "POST", - "id": "compute.targetHttpsProxies.insert", + "id": "compute.targetGrpcProxies.insert", "parameterOrder": [ "project" ], @@ -36351,9 +36391,9 @@ "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies", + "path": "projects/{project}/global/targetGrpcProxies", "request": { - "$ref": "TargetHttpsProxy" + "$ref": "TargetGrpcProxy" }, "response": { "$ref": "Operation" @@ -36364,10 +36404,10 @@ ] }, "list": { - "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.", - "flatPath": "projects/{project}/global/targetHttpsProxies", + "description": "Lists the TargetGrpcProxies for a project in the given scope.", + "flatPath": "projects/{project}/global/targetGrpcProxies", "httpMethod": "GET", - "id": "compute.targetHttpsProxies.list", + "id": "compute.targetGrpcProxies.list", "parameterOrder": [ "project" ], @@ -36408,9 +36448,9 @@ "type": "boolean" } }, - "path": "projects/{project}/global/targetHttpsProxies", + "path": "projects/{project}/global/targetGrpcProxies", "response": { - "$ref": "TargetHttpsProxyList" + "$ref": "TargetGrpcProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36419,13 +36459,13 @@ ] }, "patch": { - "description": "Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "description": "Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "httpMethod": "PATCH", - "id": "compute.targetHttpsProxies.patch", + "id": "compute.targetGrpcProxies.patch", "parameterOrder": [ "project", - "targetHttpsProxy" + "targetGrpcProxy" ], "parameters": { "project": { @@ -36440,17 +36480,17 @@ "location": "query", "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to patch.", + "targetGrpcProxy": { + "description": "Name of the TargetGrpcProxy resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "request": { - "$ref": "TargetHttpsProxy" + "$ref": "TargetGrpcProxy" }, "response": { "$ref": "Operation" @@ -36460,14 +36500,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "setCertificateMap": { - "description": "Changes the Certificate Map for TargetHttpsProxy.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/global/targetGrpcProxies/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setCertificateMap", + "id": "compute.targetGrpcProxies.testIamPermissions", "parameterOrder": [ "project", - "targetHttpsProxy" + "resource" ], "parameters": { "project": { @@ -36477,79 +36517,105 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", + "path": "projects/{project}/global/targetGrpcProxies/{resource}/testIamPermissions", "request": { - "$ref": "TargetHttpsProxiesSetCertificateMapRequest" + "$ref": "TestPermissionsRequest" }, "response": { - "$ref": "Operation" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - }, - "setQuicOverride": { - "description": "Sets the QUIC override policy for TargetHttpsProxy.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", - "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setQuicOverride", + } + } + }, + "targetHttpProxies": { + "methods": { + "aggregatedList": { + "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetHttpProxies", + "httpMethod": "GET", + "id": "compute.targetHttpProxies.aggregatedList", "parameterOrder": [ - "project", - "targetHttpsProxy" + "project" ], "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, "project": { - "description": "Project ID for this request.", + "description": "Name of the project scoping this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", - "type": "string" + "type": "boolean" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.", - "location": "path", - "required": true, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", - "request": { - "$ref": "TargetHttpsProxiesSetQuicOverrideRequest" - }, + "path": "projects/{project}/aggregated/targetHttpProxies", "response": { - "$ref": "Operation" + "$ref": "TargetHttpProxyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "setSslCertificates": { - "description": "Replaces SslCertificates for TargetHttpsProxy.", - "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", - "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setSslCertificates", + "delete": { + "description": "Deletes the specified TargetHttpProxy resource.", + "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "httpMethod": "DELETE", + "id": "compute.targetHttpProxies.delete", "parameterOrder": [ "project", - "targetHttpsProxy" + "targetHttpProxy" ], "parameters": { "project": { @@ -36564,18 +36630,15 @@ "location": "query", "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", - "request": { - "$ref": "TargetHttpsProxiesSetSslCertificatesRequest" - }, + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "response": { "$ref": "Operation" }, @@ -36584,14 +36647,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "setSslPolicy": { - "description": "Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", - "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setSslPolicy", + "get": { + "description": "Returns the specified TargetHttpProxy resource.", + "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "httpMethod": "GET", + "id": "compute.targetHttpProxies.get", "parameterOrder": [ "project", - "targetHttpsProxy" + "targetHttpProxy" ], "parameters": { "project": { @@ -36601,38 +36664,31 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.", + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy resource to return.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", - "request": { - "$ref": "SslPolicyReference" - }, + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "response": { - "$ref": "Operation" + "$ref": "TargetHttpProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "setUrlMap": { - "description": "Changes the URL map for TargetHttpsProxy.", - "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", + "insert": { + "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/targetHttpProxies", "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setUrlMap", + "id": "compute.targetHttpProxies.insert", "parameterOrder": [ - "project", - "targetHttpsProxy" + "project" ], "parameters": { "project": { @@ -36646,18 +36702,11 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", + "path": "projects/{project}/global/targetHttpProxies", "request": { - "$ref": "UrlMapReference" + "$ref": "TargetHttpProxy" }, "response": { "$ref": "Operation" @@ -36667,16 +36716,38 @@ "https://www.googleapis.com/auth/compute" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.targetHttpsProxies.testIamPermissions", + "list": { + "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.", + "flatPath": "projects/{project}/global/targetHttpProxies", + "httpMethod": "GET", + "id": "compute.targetHttpProxies.list", "parameterOrder": [ - "project", - "resource" + "project" ], "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36684,17 +36755,134 @@ "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/global/targetHttpsProxies/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" + "path": "projects/{project}/global/targetHttpProxies", + "response": { + "$ref": "TargetHttpProxyList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "httpMethod": "PATCH", + "id": "compute.targetHttpProxies.patch", + "parameterOrder": [ + "project", + "targetHttpProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy resource to patch.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "request": { + "$ref": "TargetHttpProxy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setUrlMap": { + "description": "Changes the URL map for TargetHttpProxy.", + "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "httpMethod": "POST", + "id": "compute.targetHttpProxies.setUrlMap", + "parameterOrder": [ + "project", + "targetHttpProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy to set a URL map for.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "request": { + "$ref": "UrlMapReference" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/global/targetHttpProxies/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.targetHttpProxies.testIamPermissions", + "parameterOrder": [ + "project", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/targetHttpProxies/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" }, "response": { "$ref": "TestPermissionsResponse" @@ -36707,13 +36895,13 @@ } } }, - "targetInstances": { + "targetHttpsProxies": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetInstances", + "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetHttpsProxies", "httpMethod": "GET", - "id": "compute.targetInstances.aggregatedList", + "id": "compute.targetHttpsProxies.aggregatedList", "parameterOrder": [ "project" ], @@ -36747,7 +36935,7 @@ "type": "string" }, "project": { - "description": "Project ID for this request.", + "description": "Name of the project scoping this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, @@ -36765,9 +36953,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/targetInstances", + "path": "projects/{project}/aggregated/targetHttpsProxies", "response": { - "$ref": "TargetInstanceAggregatedList" + "$ref": "TargetHttpsProxyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36776,14 +36964,13 @@ ] }, "delete": { - "description": "Deletes the specified TargetInstance resource.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "description": "Deletes the specified TargetHttpsProxy resource.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "DELETE", - "id": "compute.targetInstances.delete", + "id": "compute.targetHttpsProxies.delete", "parameterOrder": [ "project", - "zone", - "targetInstance" + "targetHttpsProxy" ], "parameters": { "project": { @@ -36798,22 +36985,15 @@ "location": "query", "type": "string" }, - "targetInstance": { - "description": "Name of the TargetInstance resource to delete.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - }, - "zone": { - "description": "Name of the zone scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "Operation" }, @@ -36823,14 +37003,13 @@ ] }, "get": { - "description": "Returns the specified TargetInstance resource.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "description": "Returns the specified TargetHttpsProxy resource.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "GET", - "id": "compute.targetInstances.get", + "id": "compute.targetHttpsProxies.get", "parameterOrder": [ "project", - "zone", - "targetInstance" + "targetHttpsProxy" ], "parameters": { "project": { @@ -36840,24 +37019,17 @@ "required": true, "type": "string" }, - "targetInstance": { - "description": "Name of the TargetInstance resource to return.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - }, - "zone": { - "description": "Name of the zone scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "response": { - "$ref": "TargetInstance" + "$ref": "TargetHttpsProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36866,13 +37038,12 @@ ] }, "insert": { - "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances", + "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/targetHttpsProxies", "httpMethod": "POST", - "id": "compute.targetInstances.insert", + "id": "compute.targetHttpsProxies.insert", "parameterOrder": [ - "project", - "zone" + "project" ], "parameters": { "project": { @@ -36886,18 +37057,11 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "zone": { - "description": "Name of the zone scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances", + "path": "projects/{project}/global/targetHttpsProxies", "request": { - "$ref": "TargetInstance" + "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" @@ -36908,13 +37072,12 @@ ] }, "list": { - "description": "Retrieves a list of TargetInstance resources available to the specified project and zone.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances", + "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.", + "flatPath": "projects/{project}/global/targetHttpsProxies", "httpMethod": "GET", - "id": "compute.targetInstances.list", + "id": "compute.targetHttpsProxies.list", "parameterOrder": [ - "project", - "zone" + "project" ], "parameters": { "filter": { @@ -36951,18 +37114,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" - }, - "zone": { - "description": "Name of the zone scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances", + "path": "projects/{project}/global/targetHttpsProxies", "response": { - "$ref": "TargetInstanceList" + "$ref": "TargetHttpsProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36970,15 +37126,14 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setSecurityPolicy": { - "description": "Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview", - "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", - "httpMethod": "POST", - "id": "compute.targetInstances.setSecurityPolicy", + "patch": { + "description": "Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "httpMethod": "PATCH", + "id": "compute.targetHttpsProxies.patch", "parameterOrder": [ "project", - "zone", - "targetInstance" + "targetHttpsProxy" ], "parameters": { "project": { @@ -36993,23 +37148,17 @@ "location": "query", "type": "string" }, - "targetInstance": { - "description": "Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.", - "location": "path", - "required": true, - "type": "string" - }, - "zone": { - "description": "Name of the zone scoping this request.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to patch.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "request": { - "$ref": "SecurityPolicyReference" + "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" @@ -37019,15 +37168,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions", + "setCertificateMap": { + "description": "Changes the Certificate Map for TargetHttpsProxy.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", "httpMethod": "POST", - "id": "compute.targetInstances.testIamPermissions", + "id": "compute.targetHttpsProxies.setCertificateMap", "parameterOrder": [ "project", - "zone", - "resource" + "targetHttpsProxy" ], "parameters": { "project": { @@ -37037,47 +37185,38 @@ "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", "type": "string" }, - "zone": { - "description": "The name of the zone for this request.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", "request": { - "$ref": "TestPermissionsRequest" + "$ref": "TargetHttpsProxiesSetCertificateMapRequest" }, "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] - } - } - }, - "targetPools": { - "methods": { - "addHealthCheck": { - "description": "Adds health check URLs to a target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", + }, + "setQuicOverride": { + "description": "Sets the QUIC override policy for TargetHttpsProxy.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", "httpMethod": "POST", - "id": "compute.targetPools.addHealthCheck", + "id": "compute.targetHttpsProxies.setQuicOverride", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpsProxy" ], "parameters": { "project": { @@ -37087,10 +37226,44 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", + "request": { + "$ref": "TargetHttpsProxiesSetQuicOverrideRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setSslCertificates": { + "description": "Replaces SslCertificates for TargetHttpsProxy.", + "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", + "httpMethod": "POST", + "id": "compute.targetHttpsProxies.setSslCertificates", + "parameterOrder": [ + "project", + "targetHttpsProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, @@ -37099,17 +37272,17 @@ "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the target pool to add a health check to.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", + "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "request": { - "$ref": "TargetPoolsAddHealthCheckRequest" + "$ref": "TargetHttpsProxiesSetSslCertificatesRequest" }, "response": { "$ref": "Operation" @@ -37119,15 +37292,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "addInstance": { - "description": "Adds an instance to a target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", + "setSslPolicy": { + "description": "Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", "httpMethod": "POST", - "id": "compute.targetPools.addInstance", + "id": "compute.targetHttpsProxies.setSslPolicy", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpsProxy" ], "parameters": { "project": { @@ -37137,10 +37309,44 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", + "request": { + "$ref": "SslPolicyReference" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setUrlMap": { + "description": "Changes the URL map for TargetHttpsProxy.", + "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", + "httpMethod": "POST", + "id": "compute.targetHttpsProxies.setUrlMap", + "parameterOrder": [ + "project", + "targetHttpsProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, @@ -37149,17 +37355,17 @@ "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the TargetPool resource to add instances to.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", + "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "request": { - "$ref": "TargetPoolsAddInstanceRequest" + "$ref": "UrlMapReference" }, "response": { "$ref": "Operation" @@ -37169,11 +37375,53 @@ "https://www.googleapis.com/auth/compute" ] }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.targetHttpsProxies.testIamPermissions", + "parameterOrder": [ + "project", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/targetHttpsProxies/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "targetInstances": { + "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetPools", + "description": "Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetInstances", "httpMethod": "GET", - "id": "compute.targetPools.aggregatedList", + "id": "compute.targetInstances.aggregatedList", "parameterOrder": [ "project" ], @@ -37225,9 +37473,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/targetPools", + "path": "projects/{project}/aggregated/targetInstances", "response": { - "$ref": "TargetPoolAggregatedList" + "$ref": "TargetInstanceAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -37236,14 +37484,14 @@ ] }, "delete": { - "description": "Deletes the specified target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "description": "Deletes the specified TargetInstance resource.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "httpMethod": "DELETE", - "id": "compute.targetPools.delete", + "id": "compute.targetInstances.delete", "parameterOrder": [ "project", - "region", - "targetPool" + "zone", + "targetInstance" ], "parameters": { "project": { @@ -37253,27 +37501,27 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the TargetPool resource to delete.", + "targetInstance": { + "description": "Name of the TargetInstance resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "zone": { + "description": "Name of the zone scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "response": { "$ref": "Operation" }, @@ -37283,14 +37531,14 @@ ] }, "get": { - "description": "Returns the specified target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "description": "Returns the specified TargetInstance resource.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "httpMethod": "GET", - "id": "compute.targetPools.get", + "id": "compute.targetInstances.get", "parameterOrder": [ "project", - "region", - "targetPool" + "zone", + "targetInstance" ], "parameters": { "project": { @@ -37300,17 +37548,477 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "targetInstance": { + "description": "Name of the TargetInstance resource to return.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, - "targetPool": { - "description": "Name of the TargetPool resource to return.", + "zone": { + "description": "Name of the zone scoping this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "response": { + "$ref": "TargetInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances", + "httpMethod": "POST", + "id": "compute.targetInstances.insert", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "Name of the zone scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/targetInstances", + "request": { + "$ref": "TargetInstance" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves a list of TargetInstance resources available to the specified project and zone.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances", + "httpMethod": "GET", + "id": "compute.targetInstances.list", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "Name of the zone scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/targetInstances", + "response": { + "$ref": "TargetInstanceList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "setSecurityPolicy": { + "description": "Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", + "httpMethod": "POST", + "id": "compute.targetInstances.setSecurityPolicy", + "parameterOrder": [ + "project", + "zone", + "targetInstance" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetInstance": { + "description": "Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", + "request": { + "$ref": "SecurityPolicyReference" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.targetInstances.testIamPermissions", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "targetPools": { + "methods": { + "addHealthCheck": { + "description": "Adds health check URLs to a target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", + "httpMethod": "POST", + "id": "compute.targetPools.addHealthCheck", + "parameterOrder": [ + "project", + "region", + "targetPool" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetPool": { + "description": "Name of the target pool to add a health check to.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", + "request": { + "$ref": "TargetPoolsAddHealthCheckRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "addInstance": { + "description": "Adds an instance to a target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", + "httpMethod": "POST", + "id": "compute.targetPools.addInstance", + "parameterOrder": [ + "project", + "region", + "targetPool" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetPool": { + "description": "Name of the TargetPool resource to add instances to.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", + "request": { + "$ref": "TargetPoolsAddInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "aggregatedList": { + "description": "Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetPools", + "httpMethod": "GET", + "id": "compute.targetPools.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/targetPools", + "response": { + "$ref": "TargetPoolAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "httpMethod": "DELETE", + "id": "compute.targetPools.delete", + "parameterOrder": [ + "project", + "region", + "targetPool" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetPool": { + "description": "Name of the TargetPool resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "httpMethod": "GET", + "id": "compute.targetPools.get", + "parameterOrder": [ + "project", + "region", + "targetPool" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "targetPool": { + "description": "Name of the TargetPool resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } @@ -40344,7 +41052,7 @@ } } }, - "revision": "20240218", + "revision": "20240305", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -42075,6 +42783,10 @@ "sourceSnapshotEncryptionKey": { "$ref": "CustomerEncryptionKey", "description": "The customer-supplied encryption key of the source snapshot." + }, + "storagePool": { + "description": "The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool ", + "type": "string" } }, "type": "object" @@ -45273,6 +45985,7 @@ "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", + "GENERAL_PURPOSE_N4", "GENERAL_PURPOSE_T2D", "GRAPHICS_OPTIMIZED", "MEMORY_OPTIMIZED", @@ -45297,6 +46010,7 @@ "", "", "", + "", "" ], "type": "string" @@ -45930,7 +46644,7 @@ "type": "array" }, "allowOriginRegexes": { - "description": "Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", + "description": "Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", "items": { "type": "string" }, @@ -45944,7 +46658,7 @@ "type": "array" }, "disabled": { - "description": "If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.", + "description": "If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.", "type": "boolean" }, "exposeHeaders": { @@ -46346,17 +47060,23 @@ "DELETING", "FAILED", "READY", - "RESTORING" + "RESTORING", + "UNAVAILABLE" ], "enumDescriptions": [ "Disk is provisioning", "Disk is deleting.", "Disk creation failed.", "Disk is ready for use.", - "Source data is being copied into the disk." + "Source data is being copied into the disk.", + "Disk is currently unavailable and cannot be accessed, attached or detached." ], "type": "string" }, + "storagePool": { + "description": "The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool ", + "type": "string" + }, "storageType": { "description": "[Deprecated] Storage type of the persistent disk.", "enum": [ @@ -50627,7 +51347,7 @@ "id": "GuestOsFeature", "properties": { "type": { - "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", + "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", "enum": [ "FEATURE_TYPE_UNSPECIFIED", "GVNIC", @@ -50883,6 +51603,13 @@ "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, + "sourceRegions": { + "description": "The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of GCP regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. ", + "items": { + "type": "string" + }, + "type": "array" + }, "sslHealthCheck": { "$ref": "SSLHealthCheck" }, @@ -54066,6 +54793,10 @@ }, "type": "array" }, + "params": { + "$ref": "InstanceGroupManagerParams", + "description": "Input only. Additional params passed with the request, but not persisted as part of resource payload." + }, "region": { "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", "type": "string" @@ -54613,12 +55344,27 @@ }, "type": "object" }, + "InstanceGroupManagerParams": { + "description": "Input only additional params for instance group manager creation.", + "id": "InstanceGroupManagerParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the instance group manager. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/123`, and values are in the format `tagValues/456`. The field is allowed for INSERT only.", + "type": "object" + } + }, + "type": "object" + }, "InstanceGroupManagerResizeRequest": { "description": "InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.", "id": "InstanceGroupManagerResizeRequest", "properties": { "count": { - "description": "The count of instances to create as part of this resize request.", + "deprecated": true, + "description": "This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.", "format": "int32", "type": "integer" }, @@ -54675,14 +55421,25 @@ "CREATING", "FAILED", "PROVISIONING", + "STATE_UNSPECIFIED", "SUCCEEDED" ], + "enumDeprecated": [ + false, + false, + false, + false, + true, + false, + false + ], "enumDescriptions": [ "The request was created successfully and was accepted for provisioning when the capacity becomes available.", "The request is cancelled.", - "resize request is being created and may still fail creation.", + "Resize request is being created and may still fail creation.", "The request failed before or during provisioning. If the request fails during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.", - "The target resource(s) are being provisioned.", + "The value is deprecated. ResizeRequests would stay in the ACCEPTED state during provisioning attempts. The target resource(s) are being provisioned.", + "Default value. This value should never be returned.", "The request succeeded." ], "type": "string" @@ -57755,13 +58512,15 @@ "CREATING", "DELETING", "FAILED", - "READY" + "READY", + "UNAVAILABLE" ], "enumDescriptions": [ "InstantSnapshot creation is in progress.", "InstantSnapshot is currently being deleted.", "InstantSnapshot creation failed.", - "InstantSnapshot has been created successfully." + "InstantSnapshot has been created successfully.", + "InstantSnapshot is currently unavailable and cannot be used for Disk restoration" ], "type": "string" }, @@ -60192,7 +60951,7 @@ "id": "InterconnectRemoteLocationConstraints", "properties": { "portPairRemoteLocation": { - "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. GCP's API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", + "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", "enum": [ "PORT_PAIR_MATCHING_REMOTE_LOCATION", "PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION" @@ -69868,6 +70627,9 @@ "GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES", "GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES", "GPUS_ALL_REGIONS", + "HDB_TOTAL_GB", + "HDB_TOTAL_IOPS", + "HDB_TOTAL_THROUGHPUT", "HEALTH_CHECKS", "IMAGES", "INSTANCES", @@ -69942,6 +70704,7 @@ "REGIONAL_INSTANCE_GROUP_MANAGERS", "REGIONAL_INTERNAL_LB_BACKEND_SERVICES", "REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES", + "REGIONAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES", "RESERVATIONS", "RESOURCE_POLICIES", "ROUTERS", @@ -70114,6 +70877,10 @@ "", "", "", + "", + "", + "", + "", "The total number of snapshots allowed for a single project.", "", "", @@ -71813,7 +72580,7 @@ "type": "array" }, "type": { - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", "enum": [ "HIERARCHY", "NETWORK", @@ -77412,6 +78179,11 @@ "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.", "type": "string" }, + "propagatedConnectionLimit": { + "description": "The number of consumer Network Connectivity Center spokes that connected Private Service Connect endpoints can be propagated to. This limit lets a service producer indirectly limit how many propagated Private Service Connect connections can be established to the producer's service attachment. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250.", + "format": "uint32", + "type": "integer" + }, "pscServiceAttachmentId": { "$ref": "Uint128", "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment." @@ -77611,6 +78383,11 @@ "description": "The url of a connected endpoint.", "type": "string" }, + "propagatedConnectionCount": { + "description": "The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to.", + "format": "uint32", + "type": "integer" + }, "pscConnectionId": { "description": "The PSC connection id of the connected endpoint.", "format": "uint64", @@ -78233,19 +79010,1949 @@ "Machines with architecture ARM64", "Machines with architecture X86_64" ], - "type": "string" - }, - "autoCreated": { - "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.", - "type": "boolean" - }, - "chainName": { - "description": "Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.", - "type": "string" - }, - "creationSizeBytes": { - "description": "[Output Only] Size in bytes of the snapshot at creation time.", - "format": "int64", + "type": "string" + }, + "autoCreated": { + "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.", + "type": "boolean" + }, + "chainName": { + "description": "Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.", + "type": "string" + }, + "creationSizeBytes": { + "description": "[Output Only] Size in bytes of the snapshot at creation time.", + "format": "int64", + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "diskSizeGb": { + "description": "[Output Only] Size of the source disk, specified in GB.", + "format": "int64", + "type": "string" + }, + "downloadBytes": { + "description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk.", + "format": "int64", + "type": "string" + }, + "enableConfidentialCompute": { + "description": "Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", + "type": "boolean" + }, + "guestFlush": { + "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.", + "type": "boolean" + }, + "guestOsFeatures": { + "description": "[Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", + "items": { + "$ref": "GuestOsFeature" + }, + "type": "array" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#snapshot", + "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.", + "type": "string" + }, + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.", + "type": "object" + }, + "licenseCodes": { + "description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "licenses": { + "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).", + "items": { + "type": "string" + }, + "type": "array" + }, + "locationHint": { + "description": "An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.disks.createSnapshot", + "compute.snapshots.insert" + ] + }, + "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "snapshotEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later." + }, + "snapshotType": { + "description": "Indicates the type of the snapshot.", + "enum": [ + "ARCHIVE", + "STANDARD" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "sourceDisk": { + "description": "The source disk used to create this snapshot.", + "type": "string" + }, + "sourceDiskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." + }, + "sourceDiskForRecoveryCheckpoint": { + "description": "The source disk whose recovery checkpoint will be used to create this snapshot.", + "type": "string" + }, + "sourceDiskId": { + "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.", + "type": "string" + }, + "sourceInstantSnapshot": { + "description": "The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot ", + "type": "string" + }, + "sourceInstantSnapshotEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." + }, + "sourceInstantSnapshotId": { + "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", + "type": "string" + }, + "sourceSnapshotSchedulePolicy": { + "description": "[Output Only] URL of the resource policy which created this scheduled snapshot.", + "type": "string" + }, + "sourceSnapshotSchedulePolicyId": { + "description": "[Output Only] ID of the resource policy which created this scheduled snapshot.", + "type": "string" + }, + "status": { + "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.", + "enum": [ + "CREATING", + "DELETING", + "FAILED", + "READY", + "UPLOADING" + ], + "enumDescriptions": [ + "Snapshot creation is in progress.", + "Snapshot is currently being deleted.", + "Snapshot creation failed.", + "Snapshot has been created successfully.", + "Snapshot is being uploaded." + ], + "type": "string" + }, + "storageBytes": { + "description": "[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.", + "format": "int64", + "type": "string" + }, + "storageBytesStatus": { + "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", + "enum": [ + "UPDATING", + "UP_TO_DATE" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "storageLocations": { + "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).", + "items": { + "type": "string" + }, + "type": "array" + }, + "userLicenses": { + "description": "[Output Only] A list of user provided licenses represented by a list of URLs to the license resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SnapshotList": { + "description": "Contains a list of Snapshot resources.", + "id": "SnapshotList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of Snapshot resources.", + "items": { + "$ref": "Snapshot" + }, + "type": "array" + }, + "kind": { + "default": "compute#snapshotList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SnapshotSettings": { + "id": "SnapshotSettings", + "properties": { + "storageLocation": { + "$ref": "SnapshotSettingsStorageLocationSettings", + "description": "Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out." + } + }, + "type": "object" + }, + "SnapshotSettingsStorageLocationSettings": { + "id": "SnapshotSettingsStorageLocationSettings", + "properties": { + "locations": { + "additionalProperties": { + "$ref": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference" + }, + "description": "When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are GCS bucket locations.", + "type": "object" + }, + "policy": { + "description": "The chosen location policy.", + "enum": [ + "LOCAL_REGION", + "NEAREST_MULTI_REGION", + "SPECIFIC_LOCATIONS", + "STORAGE_LOCATION_POLICY_UNSPECIFIED" + ], + "enumDescriptions": [ + "Store snapshot in the same region as with the originating disk. No additional parameters are needed.", + "Store snapshot to the nearest multi region GCS bucket, relative to the originating disk. No additional parameters are needed.", + "Store snapshot in the specific locations, as specified by the user. The list of regions to store must be defined under the `locations` field.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "SnapshotSettingsStorageLocationSettingsStorageLocationPreference": { + "description": "A structure for specifying storage locations.", + "id": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference", + "properties": { + "name": { + "description": "Name of the location. It should be one of the GCS buckets.", + "type": "string" + } + }, + "type": "object" + }, + "SourceDiskEncryptionKey": { + "id": "SourceDiskEncryptionKey", + "properties": { + "diskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." + }, + "sourceDisk": { + "description": "URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ", + "type": "string" + } + }, + "type": "object" + }, + "SourceInstanceParams": { + "description": "A specification of the parameters to use when creating the instance template from a source instance.", + "id": "SourceInstanceParams", + "properties": { + "diskConfigs": { + "description": "Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.", + "items": { + "$ref": "DiskInstantiationConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "SourceInstanceProperties": { + "description": "DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.", + "id": "SourceInstanceProperties", + "properties": { + "canIpForward": { + "description": "Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", + "type": "boolean" + }, + "deletionProtection": { + "description": "Whether the instance created from this machine image should be protected against deletion.", + "type": "boolean" + }, + "description": { + "description": "An optional text description for the instances that are created from this machine image.", + "type": "string" + }, + "disks": { + "description": "An array of disks that are associated with the instances that are created from this machine image.", + "items": { + "$ref": "SavedAttachedDisk" + }, + "type": "array" + }, + "guestAccelerators": { + "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image.", + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" + }, + "keyRevocationActionType": { + "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", + "enum": [ + "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "NONE", + "STOP" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Indicates user chose no operation.", + "Indicates user chose to opt for VM shutdown on key revocation." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to instances that are created from this machine image.", + "type": "object" + }, + "machineType": { + "description": "The machine type to use for instances that are created from this machine image.", + "type": "string" + }, + "metadata": { + "$ref": "Metadata", + "description": "The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information." + }, + "minCpuPlatform": { + "description": "Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.", + "type": "string" + }, + "networkInterfaces": { + "description": "An array of network access configurations for this interface.", + "items": { + "$ref": "NetworkInterface" + }, + "type": "array" + }, + "postKeyRevocationActionType": { + "description": "PostKeyRevocationActionType of the instance.", + "enum": [ + "NOOP", + "POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "SHUTDOWN" + ], + "enumDescriptions": [ + "Indicates user chose no operation.", + "Default value. This value is unused.", + "Indicates user chose to opt for VM shutdown on key revocation." + ], + "type": "string" + }, + "scheduling": { + "$ref": "Scheduling", + "description": "Specifies the scheduling options for the instances that are created from this machine image." + }, + "serviceAccounts": { + "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.", + "items": { + "$ref": "ServiceAccount" + }, + "type": "array" + }, + "tags": { + "$ref": "Tags", + "description": "A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035." + } + }, + "type": "object" + }, + "SslCertificate": { + "description": "Represents an SSL certificate resource. Google Compute Engine has two SSL certificate resources: * [Global](/compute/docs/reference/rest/beta/sslCertificates) * [Regional](/compute/docs/reference/rest/beta/regionSslCertificates) The global SSL certificates (sslCertificates) are used by: - Global external Application Load Balancers - Classic Application Load Balancers - Proxy Network Load Balancers (with target SSL proxies) The regional SSL certificates (regionSslCertificates) are used by: - Regional external Application Load Balancers - Regional internal Application Load Balancers Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.", + "id": "SslCertificate", + "properties": { + "certificate": { + "description": "A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "expireTime": { + "description": "[Output Only] Expire time of the certificate. RFC3339", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#sslCertificate", + "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.", + "type": "string" + }, + "managed": { + "$ref": "SslCertificateManagedSslCertificate", + "description": "Configuration and status of a managed SSL certificate." + }, + "name": { + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "privateKey": { + "description": "A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.", + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.", + "type": "string" + }, + "selfLink": { + "description": "[Output only] Server-defined URL for the resource.", + "type": "string" + }, + "selfManaged": { + "$ref": "SslCertificateSelfManagedSslCertificate", + "description": "Configuration and status of a self-managed SSL certificate." + }, + "subjectAlternativeNames": { + "description": "[Output Only] Domains associated with the certificate via Subject Alternative Name.", + "items": { + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "(Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or \"MANAGED\". If not specified, the certificate is self-managed and the fields certificate and private_key are used.", + "enum": [ + "MANAGED", + "SELF_MANAGED", + "TYPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "Google-managed SSLCertificate.", + "Certificate uploaded by user.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "SslCertificateAggregatedList": { + "id": "SslCertificateAggregatedList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "SslCertificatesScopedList", + "description": "Name of the scope containing this set of SslCertificates." + }, + "description": "A list of SslCertificatesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#sslCertificateAggregatedList", + "description": "[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SslCertificateList": { + "description": "Contains a list of SslCertificate resources.", + "id": "SslCertificateList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of SslCertificate resources.", + "items": { + "$ref": "SslCertificate" + }, + "type": "array" + }, + "kind": { + "default": "compute#sslCertificateList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SslCertificateManagedSslCertificate": { + "description": "Configuration and status of a managed SSL certificate.", + "id": "SslCertificateManagedSslCertificate", + "properties": { + "domainStatus": { + "additionalProperties": { + "enum": [ + "ACTIVE", + "DOMAIN_STATUS_UNSPECIFIED", + "FAILED_CAA_CHECKING", + "FAILED_CAA_FORBIDDEN", + "FAILED_NOT_VISIBLE", + "FAILED_RATE_LIMITED", + "PROVISIONING" + ], + "enumDescriptions": [ + "A managed certificate can be provisioned, no issues for this domain.", + "", + "Failed to check CAA records for the domain.", + "Certificate issuance forbidden by an explicit CAA record for the domain.", + "There seems to be problem with the user's DNS or load balancer configuration for this domain.", + "Reached rate-limit for certificates per top-level private domain.", + "Certificate provisioning for this domain is under way. GCP will attempt to provision the first certificate." + ], + "type": "string" + }, + "description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.", + "type": "object" + }, + "domains": { + "description": "The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).", + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "[Output only] Status of the managed certificate resource.", + "enum": [ + "ACTIVE", + "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED", + "PROVISIONING", + "PROVISIONING_FAILED", + "PROVISIONING_FAILED_PERMANENTLY", + "RENEWAL_FAILED" + ], + "enumDescriptions": [ + "The certificate management is working, and a certificate has been provisioned.", + "", + "The certificate management is working. GCP will attempt to provision the first certificate.", + "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.", + "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won't be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.", + "Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field." + ], + "type": "string" + } + }, + "type": "object" + }, + "SslCertificateSelfManagedSslCertificate": { + "description": "Configuration and status of a self-managed SSL certificate.", + "id": "SslCertificateSelfManagedSslCertificate", + "properties": { + "certificate": { + "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", + "type": "string" + }, + "privateKey": { + "description": "A write-only private key in PEM format. Only insert requests will include this field.", + "type": "string" + } + }, + "type": "object" + }, + "SslCertificatesScopedList": { + "id": "SslCertificatesScopedList", + "properties": { + "sslCertificates": { + "description": "List of SslCertificates contained in this scope.", + "items": { + "$ref": "SslCertificate" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of backend services when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SslPoliciesAggregatedList": { + "id": "SslPoliciesAggregatedList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "SslPoliciesScopedList", + "description": "Name of the scope containing this set of SSL policies." + }, + "description": "A list of SslPoliciesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#sslPoliciesAggregatedList", + "description": "[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SslPoliciesList": { + "id": "SslPoliciesList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of SslPolicy resources.", + "items": { + "$ref": "SslPolicy" + }, + "type": "array" + }, + "kind": { + "default": "compute#sslPoliciesList", + "description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SslPoliciesListAvailableFeaturesResponse": { + "id": "SslPoliciesListAvailableFeaturesResponse", + "properties": { + "features": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SslPoliciesScopedList": { + "id": "SslPoliciesScopedList", + "properties": { + "sslPolicies": { + "description": "A list of SslPolicies contained in this scope.", + "items": { + "$ref": "SslPolicy" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of SSL policies when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SslPolicy": { + "description": "Represents an SSL Policy resource. Use SSL policies to control SSL features, such as versions and cipher suites, that are offered by Application Load Balancers and proxy Network Load Balancers. For more information, read SSL policies overview.", + "id": "SslPolicy", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "customFeatures": { + "description": "A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "enabledFeatures": { + "description": "[Output Only] The list of features enabled in the SSL policy.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fingerprint": { + "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.", + "format": "byte", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#sslPolicy", + "description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.", + "type": "string" + }, + "minTlsVersion": { + "description": "The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.", + "enum": [ + "TLS_1_0", + "TLS_1_1", + "TLS_1_2" + ], + "enumDescriptions": [ + "TLS 1.0", + "TLS 1.1", + "TLS 1.2" + ], + "type": "string" + }, + "name": { + "description": "Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "profile": { + "description": "Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.", + "enum": [ + "COMPATIBLE", + "CUSTOM", + "MODERN", + "RESTRICTED" + ], + "enumDescriptions": [ + "Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.", + "Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.", + "Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.", + "Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements." + ], + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "warnings": { + "description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.", + "items": { + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "SslPolicyReference": { + "id": "SslPolicyReference", + "properties": { + "sslPolicy": { + "description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.", + "type": "string" + } + }, + "type": "object" + }, + "StatefulPolicy": { + "id": "StatefulPolicy", + "properties": { + "preservedState": { + "$ref": "StatefulPolicyPreservedState" + } + }, + "type": "object" + }, + "StatefulPolicyPreservedState": { + "description": "Configuration of preserved resources.", + "id": "StatefulPolicyPreservedState", + "properties": { + "disks": { + "additionalProperties": { + "$ref": "StatefulPolicyPreservedStateDiskDevice" + }, + "description": "Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.", + "type": "object" + }, + "externalIPs": { + "additionalProperties": { + "$ref": "StatefulPolicyPreservedStateNetworkIp" + }, + "description": "External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", + "type": "object" + }, + "internalIPs": { + "additionalProperties": { + "$ref": "StatefulPolicyPreservedStateNetworkIp" + }, + "description": "Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", + "type": "object" + } + }, + "type": "object" + }, + "StatefulPolicyPreservedStateDiskDevice": { + "id": "StatefulPolicyPreservedStateDiskDevice", + "properties": { + "autoDelete": { + "description": "These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", + "enum": [ + "NEVER", + "ON_PERMANENT_INSTANCE_DELETION" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "StatefulPolicyPreservedStateNetworkIp": { + "id": "StatefulPolicyPreservedStateNetworkIp", + "properties": { + "autoDelete": { + "description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", + "enum": [ + "NEVER", + "ON_PERMANENT_INSTANCE_DELETION" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "StoragePool": { + "description": "Represents a zonal storage pool resource.", + "id": "StoragePool", + "properties": { + "capacityProvisioningType": { + "description": "Provisioning type of the byte capacity of the pool.", + "enum": [ + "ADVANCED", + "STANDARD", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Advanced provisioning \"thinly\" allocates the related resource.", + "Standard provisioning allocates the related resource for the pool disks' exclusive use.", + "" + ], "type": "string" }, "creationTimestamp": { @@ -78256,43 +80963,18 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "diskSizeGb": { - "description": "[Output Only] Size of the source disk, specified in GB.", - "format": "int64", - "type": "string" - }, - "downloadBytes": { - "description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk.", - "format": "int64", - "type": "string" - }, - "enableConfidentialCompute": { - "description": "Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", - "type": "boolean" - }, - "guestFlush": { - "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.", - "type": "boolean" - }, - "guestOsFeatures": { - "description": "[Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", - "items": { - "$ref": "GuestOsFeature" - }, - "type": "array" - }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", "type": "string" }, "kind": { - "default": "compute#snapshot", - "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.", + "default": "compute#storagePool", + "description": "[Output Only] Type of the resource. Always compute#storagePool for storage pools.", "type": "string" }, "labelFingerprint": { - "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.", + "description": "A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.", "format": "byte", "type": "string" }, @@ -78300,174 +80982,112 @@ "additionalProperties": { "type": "string" }, - "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.", + "description": "Labels to apply to this storage pool. These can be later modified by the setLabels method.", "type": "object" }, - "licenseCodes": { - "description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.", - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - }, - "licenses": { - "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).", - "items": { - "type": "string" - }, - "type": "array" - }, - "locationHint": { - "description": "An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.", - "type": "string" - }, "name": { "annotations": { "required": [ - "compute.disks.createSnapshot", - "compute.snapshots.insert" + "compute.storagePools.insert" ] }, - "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "snapshotEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later." - }, - "snapshotType": { - "description": "Indicates the type of the snapshot.", + "performanceProvisioningType": { + "description": "Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.", "enum": [ - "ARCHIVE", - "STANDARD" + "ADVANCED", + "STANDARD", + "UNSPECIFIED" ], "enumDescriptions": [ - "", + "Advanced provisioning \"thinly\" allocates the related resource.", + "Standard provisioning allocates the related resource for the pool disks' exclusive use.", "" ], "type": "string" }, - "sourceDisk": { - "description": "The source disk used to create this snapshot.", - "type": "string" - }, - "sourceDiskEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." - }, - "sourceDiskForRecoveryCheckpoint": { - "description": "The source disk whose recovery checkpoint will be used to create this snapshot.", + "poolProvisionedCapacityGb": { + "description": "Size, in GiB, of the storage pool.", + "format": "int64", "type": "string" }, - "sourceDiskId": { - "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.", + "poolProvisionedIops": { + "description": "Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.", + "format": "int64", "type": "string" }, - "sourceInstantSnapshot": { - "description": "The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot ", + "poolProvisionedThroughput": { + "description": "Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.", + "format": "int64", "type": "string" }, - "sourceInstantSnapshotEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." - }, - "sourceInstantSnapshotId": { - "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", - "type": "string" + "resourceStatus": { + "$ref": "StoragePoolResourceStatus", + "description": "[Output Only] Status information for the storage pool resource." }, - "sourceSnapshotSchedulePolicy": { - "description": "[Output Only] URL of the resource policy which created this scheduled snapshot.", + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" }, - "sourceSnapshotSchedulePolicyId": { - "description": "[Output Only] ID of the resource policy which created this scheduled snapshot.", + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", "type": "string" }, - "status": { - "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.", + "state": { + "description": "[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. ", "enum": [ "CREATING", "DELETING", "FAILED", - "READY", - "UPLOADING" + "READY" ], "enumDescriptions": [ - "Snapshot creation is in progress.", - "Snapshot is currently being deleted.", - "Snapshot creation failed.", - "Snapshot has been created successfully.", - "Snapshot is being uploaded." + "StoragePool is provisioning", + "StoragePool is deleting.", + "StoragePool creation failed.", + "StoragePool is ready for use." ], "type": "string" }, - "storageBytes": { - "description": "[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.", - "format": "int64", - "type": "string" + "status": { + "$ref": "StoragePoolResourceStatus", + "description": "[Output Only] Status information for the storage pool resource." }, - "storageBytesStatus": { - "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", - "enum": [ - "UPDATING", - "UP_TO_DATE" - ], - "enumDescriptions": [ - "", - "" - ], + "storagePoolType": { + "description": "Type of the storage pool.", "type": "string" }, - "storageLocations": { - "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).", - "items": { - "type": "string" - }, - "type": "array" - }, - "userLicenses": { - "description": "[Output Only] A list of user provided licenses represented by a list of URLs to the license resource.", - "items": { - "type": "string" - }, - "type": "array" + "zone": { + "description": "[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" } }, "type": "object" }, - "SnapshotList": { - "description": "Contains a list of Snapshot resources.", - "id": "SnapshotList", + "StoragePoolAggregatedList": { + "id": "StoragePoolAggregatedList", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of Snapshot resources.", - "items": { - "$ref": "Snapshot" + "additionalProperties": { + "$ref": "StoragePoolsScopedList", + "description": "[Output Only] Name of the scope containing this set of storage pool." }, - "type": "array" + "description": "A list of StoragePoolsScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#snapshotList", - "description": "Type of resource.", + "default": "compute#storagePoolAggregatedList", + "description": "[Output Only] Type of resource. Always compute#storagePoolAggregatedList for aggregated lists of storage pools.", "type": "string" }, "nextPageToken": { @@ -78478,6 +81098,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -78602,283 +81229,103 @@ }, "type": "object" }, - "SnapshotSettings": { - "id": "SnapshotSettings", - "properties": { - "storageLocation": { - "$ref": "SnapshotSettingsStorageLocationSettings", - "description": "Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out." - } - }, - "type": "object" - }, - "SnapshotSettingsStorageLocationSettings": { - "id": "SnapshotSettingsStorageLocationSettings", - "properties": { - "locations": { - "additionalProperties": { - "$ref": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference" - }, - "description": "When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are GCS bucket locations.", - "type": "object" - }, - "policy": { - "description": "The chosen location policy.", - "enum": [ - "LOCAL_REGION", - "NEAREST_MULTI_REGION", - "SPECIFIC_LOCATIONS", - "STORAGE_LOCATION_POLICY_UNSPECIFIED" - ], - "enumDescriptions": [ - "Store snapshot in the same region as with the originating disk. No additional parameters are needed.", - "Store snapshot to the nearest multi region GCS bucket, relative to the originating disk. No additional parameters are needed.", - "Store snapshot in the specific locations, as specified by the user. The list of regions to store must be defined under the `locations` field.", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "SnapshotSettingsStorageLocationSettingsStorageLocationPreference": { - "description": "A structure for specifying storage locations.", - "id": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference", - "properties": { - "name": { - "description": "Name of the location. It should be one of the GCS buckets.", - "type": "string" - } - }, - "type": "object" - }, - "SourceDiskEncryptionKey": { - "id": "SourceDiskEncryptionKey", - "properties": { - "diskEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." - }, - "sourceDisk": { - "description": "URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ", - "type": "string" - } - }, - "type": "object" - }, - "SourceInstanceParams": { - "description": "A specification of the parameters to use when creating the instance template from a source instance.", - "id": "SourceInstanceParams", - "properties": { - "diskConfigs": { - "description": "Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.", - "items": { - "$ref": "DiskInstantiationConfig" - }, - "type": "array" - } - }, - "type": "object" - }, - "SourceInstanceProperties": { - "description": "DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.", - "id": "SourceInstanceProperties", + "StoragePoolDisk": { + "id": "StoragePoolDisk", "properties": { - "canIpForward": { - "description": "Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", - "type": "boolean" - }, - "deletionProtection": { - "description": "Whether the instance created from this machine image should be protected against deletion.", - "type": "boolean" - }, - "description": { - "description": "An optional text description for the instances that are created from this machine image.", - "type": "string" - }, - "disks": { - "description": "An array of disks that are associated with the instances that are created from this machine image.", - "items": { - "$ref": "SavedAttachedDisk" - }, - "type": "array" - }, - "guestAccelerators": { - "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image.", + "attachedInstances": { + "description": "[Output Only] Instances this disk is attached to.", "items": { - "$ref": "AcceleratorConfig" - }, - "type": "array" - }, - "keyRevocationActionType": { - "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", - "enum": [ - "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "NONE", - "STOP" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "Indicates user chose no operation.", - "Indicates user chose to opt for VM shutdown on key revocation." - ], - "type": "string" - }, - "labels": { - "additionalProperties": { "type": "string" }, - "description": "Labels to apply to instances that are created from this machine image.", - "type": "object" - }, - "machineType": { - "description": "The machine type to use for instances that are created from this machine image.", - "type": "string" - }, - "metadata": { - "$ref": "Metadata", - "description": "The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information." - }, - "minCpuPlatform": { - "description": "Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.", - "type": "string" - }, - "networkInterfaces": { - "description": "An array of network access configurations for this interface.", - "items": { - "$ref": "NetworkInterface" - }, - "type": "array" - }, - "postKeyRevocationActionType": { - "description": "PostKeyRevocationActionType of the instance.", - "enum": [ - "NOOP", - "POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "SHUTDOWN" - ], - "enumDescriptions": [ - "Indicates user chose no operation.", - "Default value. This value is unused.", - "Indicates user chose to opt for VM shutdown on key revocation." - ], - "type": "string" - }, - "scheduling": { - "$ref": "Scheduling", - "description": "Specifies the scheduling options for the instances that are created from this machine image." - }, - "serviceAccounts": { - "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.", - "items": { - "$ref": "ServiceAccount" - }, "type": "array" }, - "tags": { - "$ref": "Tags", - "description": "A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035." - } - }, - "type": "object" - }, - "SslCertificate": { - "description": "Represents an SSL certificate resource. Google Compute Engine has two SSL certificate resources: * [Global](/compute/docs/reference/rest/beta/sslCertificates) * [Regional](/compute/docs/reference/rest/beta/regionSslCertificates) The global SSL certificates (sslCertificates) are used by: - Global external Application Load Balancers - Classic Application Load Balancers - Proxy Network Load Balancers (with target SSL proxies) The regional SSL certificates (regionSslCertificates) are used by: - Regional external Application Load Balancers - Regional internal Application Load Balancers Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.", - "id": "SslCertificate", - "properties": { - "certificate": { - "description": "A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", - "type": "string" - }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "expireTime": { - "description": "[Output Only] Expire time of the certificate. RFC3339", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#sslCertificate", - "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.", + "disk": { + "description": "[Output Only] The URL of the disk.", "type": "string" }, - "managed": { - "$ref": "SslCertificateManagedSslCertificate", - "description": "Configuration and status of a managed SSL certificate." - }, "name": { - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "privateKey": { - "description": "A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.", + "description": "[Output Only] The name of the disk.", "type": "string" }, - "region": { - "description": "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.", + "provisionedIops": { + "description": "[Output Only] The number of IOPS provisioned for the disk.", + "format": "int64", "type": "string" }, - "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", + "provisionedThroughput": { + "description": "[Output Only] The throughput provisioned for the disk.", + "format": "int64", "type": "string" }, - "selfManaged": { - "$ref": "SslCertificateSelfManagedSslCertificate", - "description": "Configuration and status of a self-managed SSL certificate." - }, - "subjectAlternativeNames": { - "description": "[Output Only] Domains associated with the certificate via Subject Alternative Name.", + "resourcePolicies": { + "description": "[Output Only] Resource policies applied to disk for automatic snapshot creations.", "items": { "type": "string" }, "type": "array" }, - "type": { - "description": "(Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or \"MANAGED\". If not specified, the certificate is self-managed and the fields certificate and private_key are used.", + "sizeGb": { + "description": "[Output Only] The disk size, in GB.", + "format": "int64", + "type": "string" + }, + "status": { + "description": "[Output Only] The disk status.", "enum": [ - "MANAGED", - "SELF_MANAGED", - "TYPE_UNSPECIFIED" + "CREATING", + "DELETING", + "FAILED", + "READY", + "RESTORING", + "UNAVAILABLE" ], "enumDescriptions": [ - "Google-managed SSLCertificate.", - "Certificate uploaded by user.", - "" + "Disk is provisioning", + "Disk is deleting.", + "Disk creation failed.", + "Disk is ready for use.", + "Source data is being copied into the disk.", + "Disk is currently unavailable and cannot be accessed, attached or detached." ], "type": "string" + }, + "type": { + "description": "[Output Only] The disk type.", + "type": "string" + }, + "usedBytes": { + "description": "[Output Only] Amount of disk space used.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "SslCertificateAggregatedList": { - "id": "SslCertificateAggregatedList", + "StoragePoolList": { + "description": "A list of StoragePool resources.", + "id": "StoragePoolList", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "SslCertificatesScopedList", - "description": "Name of the scope containing this set of SslCertificates." + "description": "A list of StoragePool resources.", + "items": { + "$ref": "StoragePool" }, - "description": "A list of SslCertificatesScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#sslCertificateAggregatedList", - "description": "[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.", + "default": "compute#storagePoolList", + "description": "[Output Only] Type of resource. Always compute#storagePoolList for lists of storagePools.", "type": "string" }, "nextPageToken": { @@ -78890,7 +81337,7 @@ "type": "string" }, "unreachables": { - "description": "[Output Only] Unreachable resources.", + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", "items": { "type": "string" }, @@ -79020,24 +81467,26 @@ }, "type": "object" }, - "SslCertificateList": { - "description": "Contains a list of SslCertificate resources.", - "id": "SslCertificateList", + "StoragePoolListDisks": { + "id": "StoragePoolListDisks", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of SslCertificate resources.", + "description": "A list of StoragePoolDisk resources.", "items": { - "$ref": "SslCertificate" + "$ref": "StoragePoolDisk" }, "type": "array" }, "kind": { - "default": "compute#sslCertificateList", - "description": "Type of resource.", + "default": "compute#storagePoolListDisks", + "description": "[Output Only] Type of resource. Always compute#storagePoolListDisks for lists of disks in a storagePool.", "type": "string" }, "nextPageToken": { @@ -79048,6 +81497,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -79172,92 +81628,179 @@ }, "type": "object" }, - "SslCertificateManagedSslCertificate": { - "description": "Configuration and status of a managed SSL certificate.", - "id": "SslCertificateManagedSslCertificate", + "StoragePoolResourceStatus": { + "description": "[Output Only] Contains output only fields.", + "id": "StoragePoolResourceStatus", "properties": { - "domainStatus": { - "additionalProperties": { - "enum": [ - "ACTIVE", - "DOMAIN_STATUS_UNSPECIFIED", - "FAILED_CAA_CHECKING", - "FAILED_CAA_FORBIDDEN", - "FAILED_NOT_VISIBLE", - "FAILED_RATE_LIMITED", - "PROVISIONING" - ], - "enumDescriptions": [ - "A managed certificate can be provisioned, no issues for this domain.", - "", - "Failed to check CAA records for the domain.", - "Certificate issuance forbidden by an explicit CAA record for the domain.", - "There seems to be problem with the user's DNS or load balancer configuration for this domain.", - "Reached rate-limit for certificates per top-level private domain.", - "Certificate provisioning for this domain is under way. GCP will attempt to provision the first certificate." - ], - "type": "string" - }, - "description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.", - "type": "object" + "diskCount": { + "description": "[Output Only] Number of disks used.", + "format": "int64", + "type": "string" + }, + "lastResizeTimestamp": { + "description": "[Output Only] Timestamp of the last successful resize in RFC3339 text format.", + "type": "string" + }, + "maxTotalProvisionedDiskCapacityGb": { + "description": "[Output Only] Maximum allowed aggregate disk size in gigabytes.", + "format": "int64", + "type": "string" + }, + "poolUsedCapacityBytes": { + "description": "[Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks.", + "format": "int64", + "type": "string" + }, + "poolUsedIops": { + "description": "Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity.", + "format": "int64", + "type": "string" }, - "domains": { - "description": "The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).", - "items": { - "type": "string" - }, - "type": "array" + "poolUsedThroughput": { + "description": "[Output Only] Sum of all the disks' provisioned throughput in MB/s.", + "format": "int64", + "type": "string" }, - "status": { - "description": "[Output only] Status of the managed certificate resource.", - "enum": [ - "ACTIVE", - "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED", - "PROVISIONING", - "PROVISIONING_FAILED", - "PROVISIONING_FAILED_PERMANENTLY", - "RENEWAL_FAILED" - ], - "enumDescriptions": [ - "The certificate management is working, and a certificate has been provisioned.", - "", - "The certificate management is working. GCP will attempt to provision the first certificate.", - "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.", - "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won't be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.", - "Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field." - ], + "poolUserWrittenBytes": { + "description": "[Output Only] Amount of data written into the pool, before it is compacted.", + "format": "int64", + "type": "string" + }, + "totalProvisionedDiskCapacityGb": { + "description": "[Output Only] Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.", + "format": "int64", + "type": "string" + }, + "totalProvisionedDiskIops": { + "description": "[Output Only] Sum of all the disks' provisioned IOPS.", + "format": "int64", + "type": "string" + }, + "totalProvisionedDiskThroughput": { + "description": "[Output Only] Sum of all the disks' provisioned throughput in MB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity.", + "format": "int64", "type": "string" } }, "type": "object" }, - "SslCertificateSelfManagedSslCertificate": { - "description": "Configuration and status of a self-managed SSL certificate.", - "id": "SslCertificateSelfManagedSslCertificate", + "StoragePoolType": { + "id": "StoragePoolType", "properties": { - "certificate": { - "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "privateKey": { - "description": "A write-only private key in PEM format. Only insert requests will include this field.", + "deprecated": { + "$ref": "DeprecationStatus", + "description": "[Output Only] The deprecation status associated with this storage pool type." + }, + "description": { + "description": "[Output Only] An optional description of this resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#storagePoolType", + "description": "[Output Only] Type of the resource. Always compute#storagePoolType for storage pool types.", + "type": "string" + }, + "maxPoolProvisionedCapacityGb": { + "description": "[Output Only] Maximum storage pool size in GB.", + "format": "int64", + "type": "string" + }, + "maxPoolProvisionedIops": { + "description": "[Output Only] Maximum provisioned IOPS.", + "format": "int64", + "type": "string" + }, + "maxPoolProvisionedThroughput": { + "description": "[Output Only] Maximum provisioned throughput.", + "format": "int64", + "type": "string" + }, + "minPoolProvisionedCapacityGb": { + "description": "[Output Only] Minimum storage pool size in GB.", + "format": "int64", + "type": "string" + }, + "minPoolProvisionedIops": { + "description": "[Output Only] Minimum provisioned IOPS.", + "format": "int64", + "type": "string" + }, + "minPoolProvisionedThroughput": { + "description": "[Output Only] Minimum provisioned throughput.", + "format": "int64", + "type": "string" + }, + "minSizeGb": { + "description": "[Deprecated] This field is deprecated. Use minPoolProvisionedCapacityGb instead.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "[Output Only] Name of the resource.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "supportedDiskTypes": { + "description": "[Output Only] The list of disk types supported in this storage pool type.", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone": { + "description": "[Output Only] URL of the zone where the storage pool type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" } }, "type": "object" }, - "SslCertificatesScopedList": { - "id": "SslCertificatesScopedList", + "StoragePoolTypeAggregatedList": { + "id": "StoragePoolTypeAggregatedList", "properties": { - "sslCertificates": { - "description": "List of SslCertificates contained in this scope.", - "items": { - "$ref": "SslCertificate" + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "StoragePoolTypesScopedList", + "description": "[Output Only] Name of the scope containing this set of storage pool types." }, - "type": "array" + "description": "A list of StoragePoolTypesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#storagePoolTypeAggregatedList", + "description": "[Output Only] Type of resource. Always compute#storagePoolTypeAggregatedList .", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" }, "warning": { - "description": "Informational warning which replaces the list of backend services when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -79380,27 +81923,24 @@ }, "type": "object" }, - "SslPoliciesAggregatedList": { - "id": "SslPoliciesAggregatedList", + "StoragePoolTypeList": { + "description": "Contains a list of storage pool types.", + "id": "StoragePoolTypeList", "properties": { - "etag": { - "type": "string" - }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "SslPoliciesScopedList", - "description": "Name of the scope containing this set of SSL policies." + "description": "A list of StoragePoolType resources.", + "items": { + "$ref": "StoragePoolType" }, - "description": "A list of SslPoliciesScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#sslPoliciesAggregatedList", - "description": "[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies.", + "default": "compute#storagePoolTypeList", + "description": "[Output Only] Type of resource. Always compute#storagePoolTypeList for storage pool types.", "type": "string" }, "nextPageToken": { @@ -79411,13 +81951,6 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -79542,35 +82075,18 @@ }, "type": "object" }, - "SslPoliciesList": { - "id": "SslPoliciesList", + "StoragePoolTypesScopedList": { + "id": "StoragePoolTypesScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of SslPolicy resources.", + "storagePoolTypes": { + "description": "[Output Only] A list of storage pool types contained in this scope.", "items": { - "$ref": "SslPolicy" + "$ref": "StoragePoolType" }, "type": "array" }, - "kind": { - "default": "compute#sslPoliciesList", - "description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "[Output Only] Informational warning which replaces the list of storage pool types when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -79693,30 +82209,18 @@ }, "type": "object" }, - "SslPoliciesListAvailableFeaturesResponse": { - "id": "SslPoliciesListAvailableFeaturesResponse", - "properties": { - "features": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "SslPoliciesScopedList": { - "id": "SslPoliciesScopedList", + "StoragePoolsScopedList": { + "id": "StoragePoolsScopedList", "properties": { - "sslPolicies": { - "description": "A list of SslPolicies contained in this scope.", + "storagePools": { + "description": "[Output Only] A list of storage pool contained in this scope.", "items": { - "$ref": "SslPolicy" + "$ref": "StoragePool" }, "type": "array" }, "warning": { - "description": "Informational warning which replaces the list of SSL policies when the list is empty.", + "description": "[Output Only] Informational warning which replaces the list of storage pool when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -79839,327 +82343,6 @@ }, "type": "object" }, - "SslPolicy": { - "description": "Represents an SSL Policy resource. Use SSL policies to control SSL features, such as versions and cipher suites, that are offered by Application Load Balancers and proxy Network Load Balancers. For more information, read SSL policies overview.", - "id": "SslPolicy", - "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "customFeatures": { - "description": "A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.", - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "enabledFeatures": { - "description": "[Output Only] The list of features enabled in the SSL policy.", - "items": { - "type": "string" - }, - "type": "array" - }, - "fingerprint": { - "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.", - "format": "byte", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#sslPolicy", - "description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.", - "type": "string" - }, - "minTlsVersion": { - "description": "The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.", - "enum": [ - "TLS_1_0", - "TLS_1_1", - "TLS_1_2" - ], - "enumDescriptions": [ - "TLS 1.0", - "TLS 1.1", - "TLS 1.2" - ], - "type": "string" - }, - "name": { - "description": "Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "profile": { - "description": "Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.", - "enum": [ - "COMPATIBLE", - "CUSTOM", - "MODERN", - "RESTRICTED" - ], - "enumDescriptions": [ - "Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.", - "Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.", - "Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.", - "Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements." - ], - "type": "string" - }, - "region": { - "description": "[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "warnings": { - "description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.", - "items": { - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "SslPolicyReference": { - "id": "SslPolicyReference", - "properties": { - "sslPolicy": { - "description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.", - "type": "string" - } - }, - "type": "object" - }, - "StatefulPolicy": { - "id": "StatefulPolicy", - "properties": { - "preservedState": { - "$ref": "StatefulPolicyPreservedState" - } - }, - "type": "object" - }, - "StatefulPolicyPreservedState": { - "description": "Configuration of preserved resources.", - "id": "StatefulPolicyPreservedState", - "properties": { - "disks": { - "additionalProperties": { - "$ref": "StatefulPolicyPreservedStateDiskDevice" - }, - "description": "Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.", - "type": "object" - }, - "externalIPs": { - "additionalProperties": { - "$ref": "StatefulPolicyPreservedStateNetworkIp" - }, - "description": "External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", - "type": "object" - }, - "internalIPs": { - "additionalProperties": { - "$ref": "StatefulPolicyPreservedStateNetworkIp" - }, - "description": "Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", - "type": "object" - } - }, - "type": "object" - }, - "StatefulPolicyPreservedStateDiskDevice": { - "id": "StatefulPolicyPreservedStateDiskDevice", - "properties": { - "autoDelete": { - "description": "These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", - "enum": [ - "NEVER", - "ON_PERMANENT_INSTANCE_DELETION" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "StatefulPolicyPreservedStateNetworkIp": { - "id": "StatefulPolicyPreservedStateNetworkIp", - "properties": { - "autoDelete": { - "description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", - "enum": [ - "NEVER", - "ON_PERMANENT_INSTANCE_DELETION" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, "Subnetwork": { "description": "Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.", "id": "Subnetwork", diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index 50bfddddf4a..f205a5ef675 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -7519,6 +7519,279 @@ } } }, + "instanceGroupManagerResizeRequests": { + "methods": { + "cancel": { + "description": "Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "httpMethod": "POST", + "id": "compute.instanceGroupManagerResizeRequests.cancel", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "delete": { + "description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "DELETE", + "id": "compute.instanceGroupManagerResizeRequests.delete", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns all of the details about the specified resize request.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "GET", + "id": "compute.instanceGroupManagerResizeRequests.get", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the href=\"/compute/docs/regions-zones/#available\">zone scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new resize request that starts provisioning VMs immediately or queues VM creation.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "httpMethod": "POST", + "id": "compute.instanceGroupManagerResizeRequests.insert", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "request": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves a list of resize requests that are contained in the managed instance group.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "httpMethod": "GET", + "id": "compute.instanceGroupManagerResizeRequests.list", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "instanceGroupManager": { + "description": "The name of the managed instance group. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "response": { + "$ref": "InstanceGroupManagerResizeRequestsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "instanceGroupManagers": { "methods": { "abandonInstances": { @@ -31342,13 +31615,13 @@ } } }, - "subnetworks": { + "storagePoolTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/subnetworks", + "description": "Retrieves an aggregated list of storage pool types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/storagePoolTypes", "httpMethod": "GET", - "id": "compute.subnetworks.aggregatedList", + "id": "compute.storagePoolTypes.aggregatedList", "parameterOrder": [ "project" ], @@ -31400,9 +31673,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/subnetworks", + "path": "projects/{project}/aggregated/storagePoolTypes", "response": { - "$ref": "SubnetworkAggregatedList" + "$ref": "StoragePoolTypeAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31410,112 +31683,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "delete": { - "description": "Deletes the specified subnetwork.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "httpMethod": "DELETE", - "id": "compute.subnetworks.delete", - "parameterOrder": [ - "project", - "region", - "subnetwork" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "subnetwork": { - "description": "Name of the Subnetwork resource to delete.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "expandIpCidrRange": { - "description": "Expands the IP CIDR range of the subnetwork to a specified value.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", - "httpMethod": "POST", - "id": "compute.subnetworks.expandIpCidrRange", - "parameterOrder": [ - "project", - "region", - "subnetwork" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "subnetwork": { - "description": "Name of the Subnetwork resource to update.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", - "request": { - "$ref": "SubnetworksExpandIpCidrRangeRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, "get": { - "description": "Returns the specified subnetwork.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "description": "Returns the specified storage pool type.", + "flatPath": "projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}", "httpMethod": "GET", - "id": "compute.subnetworks.get", + "id": "compute.storagePoolTypes.get", "parameterOrder": [ "project", - "region", - "subnetwork" + "zone", + "storagePoolType" ], "parameters": { "project": { @@ -31525,73 +31701,24 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "subnetwork": { - "description": "Name of the Subnetwork resource to return.", + "storagePoolType": { + "description": "Name of the storage pool type to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "response": { - "$ref": "Subnetwork" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", - "httpMethod": "GET", - "id": "compute.subnetworks.getIamPolicy", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "format": "int32", - "location": "query", - "type": "integer" }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "The name of the region for this request.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", + "path": "projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}", "response": { - "$ref": "Policy" + "$ref": "StoragePoolType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31599,56 +31726,14 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "insert": { - "description": "Creates a subnetwork in the specified project using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/subnetworks", - "httpMethod": "POST", - "id": "compute.subnetworks.insert", - "parameterOrder": [ - "project", - "region" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/subnetworks", - "request": { - "$ref": "Subnetwork" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, "list": { - "description": "Retrieves a list of subnetworks available to the specified project.", - "flatPath": "projects/{project}/regions/{region}/subnetworks", + "description": "Retrieves a list of storage pool types available to the specified project.", + "flatPath": "projects/{project}/zones/{zone}/storagePoolTypes", "httpMethod": "GET", - "id": "compute.subnetworks.list", + "id": "compute.storagePoolTypes.list", "parameterOrder": [ "project", - "region" + "zone" ], "parameters": { "filter": { @@ -31681,34 +31766,38 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks", + "path": "projects/{project}/zones/{zone}/storagePoolTypes", "response": { - "$ref": "SubnetworkList" + "$ref": "StoragePoolTypeList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "listUsable": { - "description": "Retrieves an aggregated list of all usable subnetworks in the project.", - "flatPath": "projects/{project}/aggregated/subnetworks/listUsable", + } + } + }, + "storagePools": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/storagePools", "httpMethod": "GET", - "id": "compute.subnetworks.listUsable", + "id": "compute.storagePools.aggregatedList", "parameterOrder": [ "project" ], @@ -31718,6 +31807,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -31747,11 +31841,17 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/aggregated/subnetworks/listUsable", + "path": "projects/{project}/aggregated/storagePools", "response": { - "$ref": "UsableSubnetworksAggregatedList" + "$ref": "StoragePoolAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31759,23 +31859,17 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "httpMethod": "PATCH", - "id": "compute.subnetworks.patch", + "delete": { + "description": "Deletes the specified storage pool. Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", + "httpMethod": "DELETE", + "id": "compute.storagePools.delete", "parameterOrder": [ "project", - "region", - "subnetwork" + "zone", + "storagePool" ], "parameters": { - "drainTimeoutSeconds": { - "description": "The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.", - "format": "int32", - "location": "query", - "type": "integer" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -31783,92 +31877,43 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "subnetwork": { - "description": "Name of the Subnetwork resource to patch.", + "storagePool": { + "description": "Name of the storage pool to delete.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", - "request": { - "$ref": "Subnetwork" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", - "httpMethod": "POST", - "id": "compute.subnetworks.setIamPolicy", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "region": { - "description": "The name of the region for this request.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", - "request": { - "$ref": "RegionSetPolicyRequest" - }, + "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "response": { - "$ref": "Policy" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, - "setPrivateIpGoogleAccess": { - "description": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", - "httpMethod": "POST", - "id": "compute.subnetworks.setPrivateIpGoogleAccess", + "get": { + "description": "Returns a specified storage pool. Gets a list of available storage pools by making a list() request.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", + "httpMethod": "GET", + "id": "compute.storagePools.get", "parameterOrder": [ "project", - "region", - "subnetwork" + "zone", + "storagePool" ], "parameters": { "project": { @@ -31878,98 +31923,48 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "subnetwork": { - "description": "Name of the Subnetwork resource.", + "storagePool": { + "description": "Name of the storage pool to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", - "request": { - "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.subnetworks.testIamPermissions", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" }, - "region": { - "description": "The name of the region for this request.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, + "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "response": { - "$ref": "TestPermissionsResponse" + "$ref": "StoragePool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "targetGrpcProxies": { - "methods": { - "delete": { - "description": "Deletes the specified TargetGrpcProxy in the given scope", - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "httpMethod": "DELETE", - "id": "compute.targetGrpcProxies.delete", + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.storagePools.getIamPolicy", "parameterOrder": [ "project", - "targetGrpcProxy" + "zone", + "resource" ], "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -31977,56 +31972,24 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "targetGrpcProxy": { - "description": "Name of the TargetGrpcProxy resource to delete.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - } - }, - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "description": "Returns the specified TargetGrpcProxy resource in the given scope.", - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "httpMethod": "GET", - "id": "compute.targetGrpcProxies.get", - "parameterOrder": [ - "project", - "targetGrpcProxy" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" }, - "targetGrpcProxy": { - "description": "Name of the TargetGrpcProxy resource to return.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "path": "projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy", "response": { - "$ref": "TargetGrpcProxy" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32035,12 +31998,13 @@ ] }, "insert": { - "description": "Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.", - "flatPath": "projects/{project}/global/targetGrpcProxies", + "description": "Creates a storage pool in the specified project using the data in the request.", + "flatPath": "projects/{project}/zones/{zone}/storagePools", "httpMethod": "POST", - "id": "compute.targetGrpcProxies.insert", + "id": "compute.storagePools.insert", "parameterOrder": [ - "project" + "project", + "zone" ], "parameters": { "project": { @@ -32054,11 +32018,18 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/global/targetGrpcProxies", + "path": "projects/{project}/zones/{zone}/storagePools", "request": { - "$ref": "TargetGrpcProxy" + "$ref": "StoragePool" }, "response": { "$ref": "Operation" @@ -32069,12 +32040,13 @@ ] }, "list": { - "description": "Lists the TargetGrpcProxies for a project in the given scope.", - "flatPath": "projects/{project}/global/targetGrpcProxies", + "description": "Retrieves a list of storage pools contained within the specified zone.", + "flatPath": "projects/{project}/zones/{zone}/storagePools", "httpMethod": "GET", - "id": "compute.targetGrpcProxies.list", + "id": "compute.storagePools.list", "parameterOrder": [ - "project" + "project", + "zone" ], "parameters": { "filter": { @@ -32111,71 +32083,34 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" - } - }, - "path": "projects/{project}/global/targetGrpcProxies", - "response": { - "$ref": "TargetGrpcProxyList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "patch": { - "description": "Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "httpMethod": "PATCH", - "id": "compute.targetGrpcProxies.patch", - "parameterOrder": [ - "project", - "targetGrpcProxy" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" }, - "targetGrpcProxy": { - "description": "Name of the TargetGrpcProxy resource to patch.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", - "request": { - "$ref": "TargetGrpcProxy" - }, + "path": "projects/{project}/zones/{zone}/storagePools", "response": { - "$ref": "Operation" + "$ref": "StoragePoolList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "targetHttpProxies": { - "methods": { - "aggregatedList": { - "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetHttpProxies", + }, + "listDisks": { + "description": "Lists the disks in a specified storage pool.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks", "httpMethod": "GET", - "id": "compute.targetHttpProxies.aggregatedList", + "id": "compute.storagePools.listDisks", "parameterOrder": [ - "project" + "project", + "zone", + "storagePool" ], "parameters": { "filter": { @@ -32183,11 +32118,6 @@ "location": "query", "type": "string" }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -32207,7 +32137,7 @@ "type": "string" }, "project": { - "description": "Name of the project scoping this request.", + "description": "Project ID for this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, @@ -32218,16 +32148,24 @@ "location": "query", "type": "boolean" }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", - "location": "query", + "storagePool": { + "description": "Name of the storage pool to list disks of.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" } }, - "path": "projects/{project}/aggregated/targetHttpProxies", + "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks", "response": { - "$ref": "TargetHttpProxyAggregatedList" + "$ref": "StoragePoolListDisks" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32235,14 +32173,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "delete": { - "description": "Deletes the specified TargetHttpProxy resource.", - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "httpMethod": "DELETE", - "id": "compute.targetHttpProxies.delete", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.storagePools.setIamPolicy", "parameterOrder": [ "project", - "targetHttpProxy" + "zone", + "resource" ], "parameters": { "project": { @@ -32252,36 +32191,42 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy resource to delete.", + "zone": { + "description": "The name of the zone for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy", + "request": { + "$ref": "ZoneSetPolicyRequest" + }, "response": { - "$ref": "Operation" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, - "get": { - "description": "Returns the specified TargetHttpProxy resource.", - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "httpMethod": "GET", - "id": "compute.targetHttpProxies.get", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.storagePools.testIamPermissions", "parameterOrder": [ "project", - "targetHttpProxy" + "zone", + "resource" ], "parameters": { "project": { @@ -32291,17 +32236,27 @@ "required": true, "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy resource to return.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, "response": { - "$ref": "TargetHttpProxy" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32309,13 +32264,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "insert": { - "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/targetHttpProxies", - "httpMethod": "POST", - "id": "compute.targetHttpProxies.insert", + "update": { + "description": "Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: size_tb and provisioned_iops.", + "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", + "httpMethod": "PATCH", + "id": "compute.storagePools.update", "parameterOrder": [ - "project" + "project", + "zone", + "storagePool" ], "parameters": { "project": { @@ -32329,11 +32286,31 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "storagePool": { + "description": "The storagePool name for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies", + "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "request": { - "$ref": "TargetHttpProxy" + "$ref": "StoragePool" }, "response": { "$ref": "Operation" @@ -32342,12 +32319,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "list": { - "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.", - "flatPath": "projects/{project}/global/targetHttpProxies", + } + } + }, + "subnetworks": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/subnetworks", "httpMethod": "GET", - "id": "compute.targetHttpProxies.list", + "id": "compute.subnetworks.aggregatedList", "parameterOrder": [ "project" ], @@ -32357,6 +32338,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -32386,11 +32372,17 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies", + "path": "projects/{project}/aggregated/subnetworks", "response": { - "$ref": "TargetHttpProxyList" + "$ref": "SubnetworkAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32398,14 +32390,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "httpMethod": "PATCH", - "id": "compute.targetHttpProxies.patch", + "delete": { + "description": "Deletes the specified subnetwork.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "httpMethod": "DELETE", + "id": "compute.subnetworks.delete", "parameterOrder": [ "project", - "targetHttpProxy" + "region", + "subnetwork" ], "parameters": { "project": { @@ -32415,23 +32408,27 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy resource to patch.", + "subnetwork": { + "description": "Name of the Subnetwork resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", - "request": { - "$ref": "TargetHttpProxy" - }, + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "response": { "$ref": "Operation" }, @@ -32440,14 +32437,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "setUrlMap": { - "description": "Changes the URL map for TargetHttpProxy.", - "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "expandIpCidrRange": { + "description": "Expands the IP CIDR range of the subnetwork to a specified value.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", "httpMethod": "POST", - "id": "compute.targetHttpProxies.setUrlMap", + "id": "compute.subnetworks.expandIpCidrRange", "parameterOrder": [ "project", - "targetHttpProxy" + "region", + "subnetwork" ], "parameters": { "project": { @@ -32457,22 +32455,29 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetHttpProxy": { - "description": "Name of the TargetHttpProxy to set a URL map for.", + "subnetwork": { + "description": "Name of the Subnetwork resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", "request": { - "$ref": "UrlMapReference" + "$ref": "SubnetworksExpandIpCidrRangeRequest" }, "response": { "$ref": "Operation" @@ -32481,70 +32486,43 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "targetHttpsProxies": { - "methods": { - "aggregatedList": { - "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetHttpsProxies", + }, + "get": { + "description": "Returns the specified subnetwork.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "httpMethod": "GET", - "id": "compute.targetHttpsProxies.aggregatedList", + "id": "compute.subnetworks.get", "parameterOrder": [ - "project" + "project", + "region", + "subnetwork" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, "project": { - "description": "Name of the project scoping this request.", + "description": "Project ID for this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", - "location": "query", + "subnetwork": { + "description": "Name of the Subnetwork resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, "type": "string" } }, - "path": "projects/{project}/aggregated/targetHttpsProxies", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "response": { - "$ref": "TargetHttpsProxyAggregatedList" + "$ref": "Subnetwork" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32552,16 +32530,23 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "delete": { - "description": "Deletes the specified TargetHttpsProxy resource.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", - "httpMethod": "DELETE", - "id": "compute.targetHttpsProxies.delete", + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.subnetworks.getIamPolicy", "parameterOrder": [ "project", - "targetHttpsProxy" + "region", + "resource" ], "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -32569,36 +32554,39 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to delete.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", "response": { - "$ref": "Operation" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "get": { - "description": "Returns the specified TargetHttpsProxy resource.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", - "httpMethod": "GET", - "id": "compute.targetHttpsProxies.get", + "insert": { + "description": "Creates a subnetwork in the specified project using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/subnetworks", + "httpMethod": "POST", + "id": "compute.subnetworks.insert", "parameterOrder": [ "project", - "targetHttpsProxy" + "region" ], "parameters": { "project": { @@ -32608,33 +32596,64 @@ "required": true, "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to return.", + "region": { + "description": "Name of the region scoping this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/regions/{region}/subnetworks", + "request": { + "$ref": "Subnetwork" + }, "response": { - "$ref": "TargetHttpsProxy" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, - "insert": { - "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/targetHttpsProxies", - "httpMethod": "POST", - "id": "compute.targetHttpsProxies.insert", + "list": { + "description": "Retrieves a list of subnetworks available to the specified project.", + "flatPath": "projects/{project}/regions/{region}/subnetworks", + "httpMethod": "GET", + "id": "compute.subnetworks.list", "parameterOrder": [ - "project" + "project", + "region" ], "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -32642,29 +32661,34 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/global/targetHttpsProxies", - "request": { - "$ref": "TargetHttpsProxy" - }, + "path": "projects/{project}/regions/{region}/subnetworks", "response": { - "$ref": "Operation" + "$ref": "SubnetworkList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "list": { - "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.", - "flatPath": "projects/{project}/global/targetHttpsProxies", + "listUsable": { + "description": "Retrieves an aggregated list of all usable subnetworks in the project.", + "flatPath": "projects/{project}/aggregated/subnetworks/listUsable", "httpMethod": "GET", - "id": "compute.targetHttpsProxies.list", + "id": "compute.subnetworks.listUsable", "parameterOrder": [ "project" ], @@ -32705,9 +32729,9 @@ "type": "boolean" } }, - "path": "projects/{project}/global/targetHttpsProxies", + "path": "projects/{project}/aggregated/subnetworks/listUsable", "response": { - "$ref": "TargetHttpsProxyList" + "$ref": "UsableSubnetworksAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32716,15 +32740,22 @@ ] }, "patch": { - "description": "Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "httpMethod": "PATCH", - "id": "compute.targetHttpsProxies.patch", + "id": "compute.subnetworks.patch", "parameterOrder": [ "project", - "targetHttpsProxy" + "region", + "subnetwork" ], "parameters": { + "drainTimeoutSeconds": { + "description": "The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -32732,22 +32763,29 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to patch.", + "subnetwork": { + "description": "Name of the Subnetwork resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "request": { - "$ref": "TargetHttpsProxy" + "$ref": "Subnetwork" }, "response": { "$ref": "Operation" @@ -32757,14 +32795,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "setCertificateMap": { - "description": "Changes the Certificate Map for TargetHttpsProxy.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setCertificateMap", + "id": "compute.subnetworks.setIamPolicy", "parameterOrder": [ "project", - "targetHttpsProxy" + "region", + "resource" ], "parameters": { "project": { @@ -32774,38 +32813,42 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", "request": { - "$ref": "TargetHttpsProxiesSetCertificateMapRequest" + "$ref": "RegionSetPolicyRequest" }, "response": { - "$ref": "Operation" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, - "setQuicOverride": { - "description": "Sets the QUIC override policy for TargetHttpsProxy.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", + "setPrivateIpGoogleAccess": { + "description": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setQuicOverride", + "id": "compute.subnetworks.setPrivateIpGoogleAccess", "parameterOrder": [ "project", - "targetHttpsProxy" + "region", + "subnetwork" ], "parameters": { "project": { @@ -32815,21 +32858,29 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.", + "subnetwork": { + "description": "Name of the Subnetwork resource.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", "request": { - "$ref": "TargetHttpsProxiesSetQuicOverrideRequest" + "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest" }, "response": { "$ref": "Operation" @@ -32839,14 +32890,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "setSslCertificates": { - "description": "Replaces SslCertificates for TargetHttpsProxy.", - "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setSslCertificates", + "id": "compute.subnetworks.testIamPermissions", "parameterOrder": [ "project", - "targetHttpsProxy" + "region", + "resource" ], "parameters": { "project": { @@ -32856,39 +32908,46 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", "request": { - "$ref": "TargetHttpsProxiesSetSslCertificatesRequest" + "$ref": "TestPermissionsRequest" }, "response": { - "$ref": "Operation" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] - }, - "setSslPolicy": { - "description": "Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.", - "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", - "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setSslPolicy", + } + } + }, + "targetGrpcProxies": { + "methods": { + "delete": { + "description": "Deletes the specified TargetGrpcProxy in the given scope", + "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "httpMethod": "DELETE", + "id": "compute.targetGrpcProxies.delete", "parameterOrder": [ "project", - "targetHttpsProxy" + "targetGrpcProxy" ], "parameters": { "project": { @@ -32903,17 +32962,15 @@ "location": "query", "type": "string" }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.", + "targetGrpcProxy": { + "description": "Name of the TargetGrpcProxy resource to delete.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", - "request": { - "$ref": "SslPolicyReference" - }, + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "response": { "$ref": "Operation" }, @@ -32922,14 +32979,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "setUrlMap": { - "description": "Changes the URL map for TargetHttpsProxy.", - "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", - "httpMethod": "POST", - "id": "compute.targetHttpsProxies.setUrlMap", + "get": { + "description": "Returns the specified TargetGrpcProxy resource in the given scope.", + "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "httpMethod": "GET", + "id": "compute.targetGrpcProxies.get", "parameterOrder": [ "project", - "targetHttpsProxy" + "targetGrpcProxy" ], "parameters": { "project": { @@ -32939,22 +32996,49 @@ "required": true, "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "targetHttpsProxy": { - "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.", + "targetGrpcProxy": { + "description": "Name of the TargetGrpcProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "response": { + "$ref": "TargetGrpcProxy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.", + "flatPath": "projects/{project}/global/targetGrpcProxies", + "httpMethod": "POST", + "id": "compute.targetGrpcProxies.insert", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/targetGrpcProxies", "request": { - "$ref": "UrlMapReference" + "$ref": "TargetGrpcProxy" }, "response": { "$ref": "Operation" @@ -32963,16 +33047,12 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "targetInstances": { - "methods": { - "aggregatedList": { - "description": "Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetInstances", + }, + "list": { + "description": "Lists the TargetGrpcProxies for a project in the given scope.", + "flatPath": "projects/{project}/global/targetGrpcProxies", "httpMethod": "GET", - "id": "compute.targetInstances.aggregatedList", + "id": "compute.targetGrpcProxies.list", "parameterOrder": [ "project" ], @@ -32982,11 +33062,6 @@ "location": "query", "type": "string" }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -33016,17 +33091,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" - }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", - "location": "query", - "type": "string" } }, - "path": "projects/{project}/aggregated/targetInstances", + "path": "projects/{project}/global/targetGrpcProxies", "response": { - "$ref": "TargetInstanceAggregatedList" + "$ref": "TargetGrpcProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33034,15 +33103,14 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "delete": { - "description": "Deletes the specified TargetInstance resource.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", - "httpMethod": "DELETE", - "id": "compute.targetInstances.delete", + "patch": { + "description": "Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "httpMethod": "PATCH", + "id": "compute.targetGrpcProxies.patch", "parameterOrder": [ "project", - "zone", - "targetInstance" + "targetGrpcProxy" ], "parameters": { "project": { @@ -33057,22 +33125,18 @@ "location": "query", "type": "string" }, - "targetInstance": { - "description": "Name of the TargetInstance resource to delete.", + "targetGrpcProxy": { + "description": "Name of the TargetGrpcProxy resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" - }, - "zone": { - "description": "Name of the zone scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "request": { + "$ref": "TargetGrpcProxy" + }, "response": { "$ref": "Operation" }, @@ -33080,43 +33144,70 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "get": { - "description": "Returns the specified TargetInstance resource.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + } + } + }, + "targetHttpProxies": { + "methods": { + "aggregatedList": { + "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetHttpProxies", "httpMethod": "GET", - "id": "compute.targetInstances.get", + "id": "compute.targetHttpProxies.aggregatedList", "parameterOrder": [ - "project", - "zone", - "targetInstance" + "project" ], "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", "type": "string" }, - "targetInstance": { - "description": "Name of the TargetInstance resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", "type": "string" }, - "zone": { - "description": "Name of the zone scoping this request.", + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Name of the project scoping this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "path": "projects/{project}/aggregated/targetHttpProxies", "response": { - "$ref": "TargetInstance" + "$ref": "TargetHttpProxyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33124,14 +33215,14 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "insert": { - "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances", - "httpMethod": "POST", - "id": "compute.targetInstances.insert", + "delete": { + "description": "Deletes the specified TargetHttpProxy resource.", + "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "httpMethod": "DELETE", + "id": "compute.targetHttpProxies.delete", "parameterOrder": [ "project", - "zone" + "targetHttpProxy" ], "parameters": { "project": { @@ -33146,18 +33237,15 @@ "location": "query", "type": "string" }, - "zone": { - "description": "Name of the zone scoping this request.", + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy resource to delete.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances", - "request": { - "$ref": "TargetInstance" - }, + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "response": { "$ref": "Operation" }, @@ -33166,39 +33254,16 @@ "https://www.googleapis.com/auth/compute" ] }, - "list": { - "description": "Retrieves a list of TargetInstance resources available to the specified project and zone.", - "flatPath": "projects/{project}/zones/{zone}/targetInstances", + "get": { + "description": "Returns the specified TargetHttpProxy resource.", + "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "httpMethod": "GET", - "id": "compute.targetInstances.list", + "id": "compute.targetHttpProxies.get", "parameterOrder": [ "project", - "zone" + "targetHttpProxy" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -33206,22 +33271,17 @@ "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - }, - "zone": { - "description": "Name of the zone scoping this request.", + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy resource to return.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances", + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "response": { - "$ref": "TargetInstanceList" + "$ref": "TargetHttpProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33229,15 +33289,13 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setSecurityPolicy": { - "description": "Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview", - "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", + "insert": { + "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/targetHttpProxies", "httpMethod": "POST", - "id": "compute.targetInstances.setSecurityPolicy", + "id": "compute.targetHttpProxies.insert", "parameterOrder": [ - "project", - "zone", - "targetInstance" + "project" ], "parameters": { "project": { @@ -33251,24 +33309,11 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "targetInstance": { - "description": "Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.", - "location": "path", - "required": true, - "type": "string" - }, - "zone": { - "description": "Name of the zone scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" } }, - "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", + "path": "projects/{project}/global/targetHttpProxies", "request": { - "$ref": "SecurityPolicyReference" + "$ref": "TargetHttpProxy" }, "response": { "$ref": "Operation" @@ -33277,22 +33322,39 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "targetPools": { - "methods": { - "addHealthCheck": { - "description": "Adds health check URLs to a target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", - "httpMethod": "POST", - "id": "compute.targetPools.addHealthCheck", + }, + "list": { + "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.", + "flatPath": "projects/{project}/global/targetHttpProxies", + "httpMethod": "GET", + "id": "compute.targetHttpProxies.list", "parameterOrder": [ - "project", - "region", - "targetPool" + "project" ], "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -33300,10 +33362,36 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/targetHttpProxies", + "response": { + "$ref": "TargetHttpProxyList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", + "httpMethod": "PATCH", + "id": "compute.targetHttpProxies.patch", + "parameterOrder": [ + "project", + "targetHttpProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, @@ -33312,17 +33400,17 @@ "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the target pool to add a health check to.", + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "request": { - "$ref": "TargetPoolsAddHealthCheckRequest" + "$ref": "TargetHttpProxy" }, "response": { "$ref": "Operation" @@ -33332,15 +33420,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "addInstance": { - "description": "Adds an instance to a target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", + "setUrlMap": { + "description": "Changes the URL map for TargetHttpProxy.", + "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "httpMethod": "POST", - "id": "compute.targetPools.addInstance", + "id": "compute.targetHttpProxies.setUrlMap", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpProxy" ], "parameters": { "project": { @@ -33350,29 +33437,22 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the TargetPool resource to add instances to.", + "targetHttpProxy": { + "description": "Name of the TargetHttpProxy to set a URL map for.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", + "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "request": { - "$ref": "TargetPoolsAddInstanceRequest" + "$ref": "UrlMapReference" }, "response": { "$ref": "Operation" @@ -33381,12 +33461,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, + } + } + }, + "targetHttpsProxies": { + "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetPools", + "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetHttpsProxies", "httpMethod": "GET", - "id": "compute.targetPools.aggregatedList", + "id": "compute.targetHttpsProxies.aggregatedList", "parameterOrder": [ "project" ], @@ -33420,7 +33504,7 @@ "type": "string" }, "project": { - "description": "Project ID for this request.", + "description": "Name of the project scoping this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, @@ -33438,9 +33522,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/targetPools", + "path": "projects/{project}/aggregated/targetHttpsProxies", "response": { - "$ref": "TargetPoolAggregatedList" + "$ref": "TargetHttpsProxyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33449,14 +33533,13 @@ ] }, "delete": { - "description": "Deletes the specified target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "description": "Deletes the specified TargetHttpsProxy resource.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "DELETE", - "id": "compute.targetPools.delete", + "id": "compute.targetHttpsProxies.delete", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpsProxy" ], "parameters": { "project": { @@ -33466,27 +33549,20 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the TargetPool resource to delete.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "Operation" }, @@ -33496,57 +33572,13 @@ ] }, "get": { - "description": "Returns the specified target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", + "description": "Returns the specified TargetHttpsProxy resource.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "GET", - "id": "compute.targetPools.get", - "parameterOrder": [ - "project", - "region", - "targetPool" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "targetPool": { - "description": "Name of the TargetPool resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", - "response": { - "$ref": "TargetPool" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "getHealth": { - "description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", - "httpMethod": "POST", - "id": "compute.targetPools.getHealth", + "id": "compute.targetHttpsProxies.get", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpsProxy" ], "parameters": { "project": { @@ -33556,27 +33588,17 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "targetPool": { - "description": "Name of the TargetPool resource to which the queried instance belongs.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", - "request": { - "$ref": "InstanceReference" - }, + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "response": { - "$ref": "TargetPoolInstanceHealth" + "$ref": "TargetHttpsProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33585,13 +33607,12 @@ ] }, "insert": { - "description": "Creates a target pool in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/targetPools", + "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/targetHttpsProxies", "httpMethod": "POST", - "id": "compute.targetPools.insert", + "id": "compute.targetHttpsProxies.insert", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "project": { @@ -33601,22 +33622,15 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools", + "path": "projects/{project}/global/targetHttpsProxies", "request": { - "$ref": "TargetPool" + "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" @@ -33627,13 +33641,12 @@ ] }, "list": { - "description": "Retrieves a list of target pools available to the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/targetPools", + "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.", + "flatPath": "projects/{project}/global/targetHttpsProxies", "httpMethod": "GET", - "id": "compute.targetPools.list", + "id": "compute.targetHttpsProxies.list", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "filter": { @@ -33666,22 +33679,15 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/targetPools", + "path": "projects/{project}/global/targetHttpsProxies", "response": { - "$ref": "TargetPoolList" + "$ref": "TargetHttpsProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33689,15 +33695,14 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "removeHealthCheck": { - "description": "Removes health check URL from a target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", - "httpMethod": "POST", - "id": "compute.targetPools.removeHealthCheck", + "patch": { + "description": "Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "httpMethod": "PATCH", + "id": "compute.targetHttpsProxies.patch", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpsProxy" ], "parameters": { "project": { @@ -33707,29 +33712,22 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the target pool to remove health checks from.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "request": { - "$ref": "TargetPoolsRemoveHealthCheckRequest" + "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" @@ -33739,15 +33737,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "removeInstance": { - "description": "Removes instance URL from a target pool.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", + "setCertificateMap": { + "description": "Changes the Certificate Map for TargetHttpsProxy.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", "httpMethod": "POST", - "id": "compute.targetPools.removeInstance", + "id": "compute.targetHttpsProxies.setCertificateMap", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpsProxy" ], "parameters": { "project": { @@ -33757,29 +33754,21 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the TargetPool resource to remove instances from.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", "request": { - "$ref": "TargetPoolsRemoveInstanceRequest" + "$ref": "TargetHttpsProxiesSetCertificateMapRequest" }, "response": { "$ref": "Operation" @@ -33789,23 +33778,16 @@ "https://www.googleapis.com/auth/compute" ] }, - "setBackup": { - "description": "Changes a backup target pool's configurations.", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", + "setQuicOverride": { + "description": "Sets the QUIC override policy for TargetHttpsProxy.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", "httpMethod": "POST", - "id": "compute.targetPools.setBackup", + "id": "compute.targetHttpsProxies.setQuicOverride", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpsProxy" ], "parameters": { - "failoverRatio": { - "description": "New failoverRatio value for the target pool.", - "format": "float", - "location": "query", - "type": "number" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -33813,29 +33795,21 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the TargetPool resource to set a backup pool for.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", "request": { - "$ref": "TargetReference" + "$ref": "TargetHttpsProxiesSetQuicOverrideRequest" }, "response": { "$ref": "Operation" @@ -33845,15 +33819,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "setSecurityPolicy": { - "description": "Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview", - "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy", + "setSslCertificates": { + "description": "Replaces SslCertificates for TargetHttpsProxy.", + "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "httpMethod": "POST", - "id": "compute.targetPools.setSecurityPolicy", + "id": "compute.targetHttpsProxies.setSslCertificates", "parameterOrder": [ "project", - "region", - "targetPool" + "targetHttpsProxy" ], "parameters": { "project": { @@ -33863,28 +33836,22 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetPool": { - "description": "Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy", + "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "request": { - "$ref": "SecurityPolicyReference" + "$ref": "TargetHttpsProxiesSetSslCertificatesRequest" }, "response": { "$ref": "Operation" @@ -33893,19 +33860,15 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "targetSslProxies": { - "methods": { - "delete": { - "description": "Deletes the specified TargetSslProxy resource.", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", - "httpMethod": "DELETE", - "id": "compute.targetSslProxies.delete", + }, + "setSslPolicy": { + "description": "Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.", + "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", + "httpMethod": "POST", + "id": "compute.targetHttpsProxies.setSslPolicy", "parameterOrder": [ "project", - "targetSslProxy" + "targetHttpsProxy" ], "parameters": { "project": { @@ -33920,15 +33883,17 @@ "location": "query", "type": "string" }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource to delete.", + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", + "request": { + "$ref": "SslPolicyReference" + }, "response": { "$ref": "Operation" }, @@ -33937,48 +33902,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "get": { - "description": "Returns the specified TargetSslProxy resource.", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", - "httpMethod": "GET", - "id": "compute.targetSslProxies.get", - "parameterOrder": [ - "project", - "targetSslProxy" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", - "response": { - "$ref": "TargetSslProxy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "insert": { - "description": "Creates a TargetSslProxy resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/targetSslProxies", + "setUrlMap": { + "description": "Changes the URL map for TargetHttpsProxy.", + "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "httpMethod": "POST", - "id": "compute.targetSslProxies.insert", + "id": "compute.targetHttpsProxies.setUrlMap", "parameterOrder": [ - "project" + "project", + "targetHttpsProxy" ], "parameters": { "project": { @@ -33992,11 +33923,18 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/global/targetSslProxies", + "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "request": { - "$ref": "TargetSslProxy" + "$ref": "UrlMapReference" }, "response": { "$ref": "Operation" @@ -34005,12 +33943,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "list": { - "description": "Retrieves the list of TargetSslProxy resources available to the specified project.", - "flatPath": "projects/{project}/global/targetSslProxies", + } + } + }, + "targetInstances": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetInstances", "httpMethod": "GET", - "id": "compute.targetSslProxies.list", + "id": "compute.targetInstances.aggregatedList", "parameterOrder": [ "project" ], @@ -34020,6 +33962,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -34049,11 +33996,17 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/global/targetSslProxies", + "path": "projects/{project}/aggregated/targetInstances", "response": { - "$ref": "TargetSslProxyList" + "$ref": "TargetInstanceAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34061,14 +34014,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setBackendService": { - "description": "Changes the BackendService for TargetSslProxy.", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", - "httpMethod": "POST", - "id": "compute.targetSslProxies.setBackendService", + "delete": { + "description": "Deletes the specified TargetInstance resource.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "httpMethod": "DELETE", + "id": "compute.targetInstances.delete", "parameterOrder": [ "project", - "targetSslProxy" + "zone", + "targetInstance" ], "parameters": { "project": { @@ -34083,18 +34037,22 @@ "location": "query", "type": "string" }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource whose BackendService resource is to be set.", + "targetInstance": { + "description": "Name of the TargetInstance resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "zone": { + "description": "Name of the zone scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" } }, - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", - "request": { - "$ref": "TargetSslProxiesSetBackendServiceRequest" - }, + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "response": { "$ref": "Operation" }, @@ -34103,14 +34061,57 @@ "https://www.googleapis.com/auth/compute" ] }, - "setCertificateMap": { - "description": "Changes the Certificate Map for TargetSslProxy.", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", + "get": { + "description": "Returns the specified TargetInstance resource.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "httpMethod": "GET", + "id": "compute.targetInstances.get", + "parameterOrder": [ + "project", + "zone", + "targetInstance" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "targetInstance": { + "description": "Name of the TargetInstance resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", + "response": { + "$ref": "TargetInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances", "httpMethod": "POST", - "id": "compute.targetSslProxies.setCertificateMap", + "id": "compute.targetInstances.insert", "parameterOrder": [ "project", - "targetSslProxy" + "zone" ], "parameters": { "project": { @@ -34125,16 +34126,17 @@ "location": "query", "type": "string" }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", + "zone": { + "description": "Name of the zone scoping this request.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", + "path": "projects/{project}/zones/{zone}/targetInstances", "request": { - "$ref": "TargetSslProxiesSetCertificateMapRequest" + "$ref": "TargetInstance" }, "response": { "$ref": "Operation" @@ -34144,14 +34146,78 @@ "https://www.googleapis.com/auth/compute" ] }, - "setProxyHeader": { - "description": "Changes the ProxyHeaderType for TargetSslProxy.", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", + "list": { + "description": "Retrieves a list of TargetInstance resources available to the specified project and zone.", + "flatPath": "projects/{project}/zones/{zone}/targetInstances", + "httpMethod": "GET", + "id": "compute.targetInstances.list", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "Name of the zone scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/targetInstances", + "response": { + "$ref": "TargetInstanceList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "setSecurityPolicy": { + "description": "Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview", + "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", "httpMethod": "POST", - "id": "compute.targetSslProxies.setProxyHeader", + "id": "compute.targetInstances.setSecurityPolicy", "parameterOrder": [ "project", - "targetSslProxy" + "zone", + "targetInstance" ], "parameters": { "project": { @@ -34166,17 +34232,23 @@ "location": "query", "type": "string" }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource whose ProxyHeader is to be set.", + "targetInstance": { + "description": "Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", "request": { - "$ref": "TargetSslProxiesSetProxyHeaderRequest" + "$ref": "SecurityPolicyReference" }, "response": { "$ref": "Operation" @@ -34185,15 +34257,20 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "setSslCertificates": { - "description": "Changes SslCertificates for TargetSslProxy.", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", + } + } + }, + "targetPools": { + "methods": { + "addHealthCheck": { + "description": "Adds health check URLs to a target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", "httpMethod": "POST", - "id": "compute.targetSslProxies.setSslCertificates", + "id": "compute.targetPools.addHealthCheck", "parameterOrder": [ "project", - "targetSslProxy" + "region", + "targetPool" ], "parameters": { "project": { @@ -34203,22 +34280,29 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource whose SslCertificate resource is to be set.", + "targetPool": { + "description": "Name of the target pool to add a health check to.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", "request": { - "$ref": "TargetSslProxiesSetSslCertificatesRequest" + "$ref": "TargetPoolsAddHealthCheckRequest" }, "response": { "$ref": "Operation" @@ -34228,14 +34312,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "setSslPolicy": { - "description": "Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends.", - "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", + "addInstance": { + "description": "Adds an instance to a target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", "httpMethod": "POST", - "id": "compute.targetSslProxies.setSslPolicy", + "id": "compute.targetPools.addInstance", "parameterOrder": [ "project", - "targetSslProxy" + "region", + "targetPool" ], "parameters": { "project": { @@ -34245,21 +34330,29 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetSslProxy": { - "description": "Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.", + "targetPool": { + "description": "Name of the TargetPool resource to add instances to.", "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", "request": { - "$ref": "SslPolicyReference" + "$ref": "TargetPoolsAddInstanceRequest" }, "response": { "$ref": "Operation" @@ -34268,16 +34361,12 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "targetTcpProxies": { - "methods": { + }, "aggregatedList": { - "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetTcpProxies", + "description": "Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetPools", "httpMethod": "GET", - "id": "compute.targetTcpProxies.aggregatedList", + "id": "compute.targetPools.aggregatedList", "parameterOrder": [ "project" ], @@ -34311,7 +34400,7 @@ "type": "string" }, "project": { - "description": "Name of the project scoping this request.", + "description": "Project ID for this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, @@ -34329,9 +34418,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/targetTcpProxies", + "path": "projects/{project}/aggregated/targetPools", "response": { - "$ref": "TargetTcpProxyAggregatedList" + "$ref": "TargetPoolAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34340,13 +34429,14 @@ ] }, "delete": { - "description": "Deletes the specified TargetTcpProxy resource.", - "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", + "description": "Deletes the specified target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", "httpMethod": "DELETE", - "id": "compute.targetTcpProxies.delete", + "id": "compute.targetPools.delete", "parameterOrder": [ "project", - "targetTcpProxy" + "region", + "targetPool" ], "parameters": { "project": { @@ -34356,20 +34446,27 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetTcpProxy": { - "description": "Name of the TargetTcpProxy resource to delete.", + "targetPool": { + "description": "Name of the TargetPool resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", "response": { "$ref": "Operation" }, @@ -34379,13 +34476,14 @@ ] }, "get": { - "description": "Returns the specified TargetTcpProxy resource.", - "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", + "description": "Returns the specified target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", "httpMethod": "GET", - "id": "compute.targetTcpProxies.get", + "id": "compute.targetPools.get", "parameterOrder": [ "project", - "targetTcpProxy" + "region", + "targetPool" ], "parameters": { "project": { @@ -34395,17 +34493,70 @@ "required": true, "type": "string" }, - "targetTcpProxy": { - "description": "Name of the TargetTcpProxy resource to return.", + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "targetPool": { + "description": "Name of the TargetPool resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", "response": { - "$ref": "TargetTcpProxy" + "$ref": "TargetPool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getHealth": { + "description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", + "httpMethod": "POST", + "id": "compute.targetPools.getHealth", + "parameterOrder": [ + "project", + "region", + "targetPool" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "targetPool": { + "description": "Name of the TargetPool resource to which the queried instance belongs.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", + "request": { + "$ref": "InstanceReference" + }, + "response": { + "$ref": "TargetPoolInstanceHealth" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34414,12 +34565,13 @@ ] }, "insert": { - "description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/targetTcpProxies", + "description": "Creates a target pool in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/targetPools", "httpMethod": "POST", - "id": "compute.targetTcpProxies.insert", + "id": "compute.targetPools.insert", "parameterOrder": [ - "project" + "project", + "region" ], "parameters": { "project": { @@ -34429,15 +34581,22 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, - "path": "projects/{project}/global/targetTcpProxies", + "path": "projects/{project}/regions/{region}/targetPools", "request": { - "$ref": "TargetTcpProxy" + "$ref": "TargetPool" }, "response": { "$ref": "Operation" @@ -34448,12 +34607,13 @@ ] }, "list": { - "description": "Retrieves the list of TargetTcpProxy resources available to the specified project.", - "flatPath": "projects/{project}/global/targetTcpProxies", + "description": "Retrieves a list of target pools available to the specified project and region.", + "flatPath": "projects/{project}/regions/{region}/targetPools", "httpMethod": "GET", - "id": "compute.targetTcpProxies.list", + "id": "compute.targetPools.list", "parameterOrder": [ - "project" + "project", + "region" ], "parameters": { "filter": { @@ -34486,15 +34646,22 @@ "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/global/targetTcpProxies", + "path": "projects/{project}/regions/{region}/targetPools", "response": { - "$ref": "TargetTcpProxyList" + "$ref": "TargetPoolList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34502,14 +34669,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setBackendService": { - "description": "Changes the BackendService for TargetTcpProxy.", - "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", + "removeHealthCheck": { + "description": "Removes health check URL from a target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", "httpMethod": "POST", - "id": "compute.targetTcpProxies.setBackendService", + "id": "compute.targetPools.removeHealthCheck", "parameterOrder": [ "project", - "targetTcpProxy" + "region", + "targetPool" ], "parameters": { "project": { @@ -34519,22 +34687,29 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetTcpProxy": { - "description": "Name of the TargetTcpProxy resource whose BackendService resource is to be set.", + "targetPool": { + "description": "Name of the target pool to remove health checks from.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", "request": { - "$ref": "TargetTcpProxiesSetBackendServiceRequest" + "$ref": "TargetPoolsRemoveHealthCheckRequest" }, "response": { "$ref": "Operation" @@ -34544,14 +34719,15 @@ "https://www.googleapis.com/auth/compute" ] }, - "setProxyHeader": { - "description": "Changes the ProxyHeaderType for TargetTcpProxy.", - "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", + "removeInstance": { + "description": "Removes instance URL from a target pool.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", "httpMethod": "POST", - "id": "compute.targetTcpProxies.setProxyHeader", + "id": "compute.targetPools.removeInstance", "parameterOrder": [ "project", - "targetTcpProxy" + "region", + "targetPool" ], "parameters": { "project": { @@ -34561,22 +34737,29 @@ "required": true, "type": "string" }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "targetTcpProxy": { - "description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set.", + "targetPool": { + "description": "Name of the TargetPool resource to remove instances from.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", "request": { - "$ref": "TargetTcpProxiesSetProxyHeaderRequest" + "$ref": "TargetPoolsRemoveInstanceRequest" }, "response": { "$ref": "Operation" @@ -34585,47 +34768,23 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "targetVpnGateways": { - "methods": { - "aggregatedList": { - "description": "Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/targetVpnGateways", - "httpMethod": "GET", - "id": "compute.targetVpnGateways.aggregatedList", + }, + "setBackup": { + "description": "Changes a backup target pool's configurations.", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", + "httpMethod": "POST", + "id": "compute.targetPools.setBackup", "parameterOrder": [ - "project" + "project", + "region", + "targetPool" ], "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "failoverRatio": { + "description": "New failoverRatio value for the target pool.", + "format": "float", "location": "query", - "type": "string" + "type": "number" }, "project": { "description": "Project ID for this request.", @@ -34634,37 +34793,47 @@ "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "targetPool": { + "description": "Name of the TargetPool resource to set a backup pool for.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/aggregated/targetVpnGateways", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", + "request": { + "$ref": "TargetReference" + }, "response": { - "$ref": "TargetVpnGatewayAggregatedList" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, - "delete": { - "description": "Deletes the specified target VPN gateway.", - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", - "httpMethod": "DELETE", - "id": "compute.targetVpnGateways.delete", + "setSecurityPolicy": { + "description": "Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview", + "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy", + "httpMethod": "POST", + "id": "compute.targetPools.setSecurityPolicy", "parameterOrder": [ "project", "region", - "targetVpnGateway" + "targetPool" ], "parameters": { "project": { @@ -34675,7 +34844,7 @@ "type": "string" }, "region": { - "description": "Name of the region for this request.", + "description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -34686,15 +34855,17 @@ "location": "query", "type": "string" }, - "targetVpnGateway": { - "description": "Name of the target VPN gateway to delete.", + "targetPool": { + "description": "Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy", + "request": { + "$ref": "SecurityPolicyReference" + }, "response": { "$ref": "Operation" }, @@ -34702,16 +34873,19 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "get": { - "description": "Returns the specified target VPN gateway.", - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", - "httpMethod": "GET", - "id": "compute.targetVpnGateways.get", + } + } + }, + "targetSslProxies": { + "methods": { + "delete": { + "description": "Deletes the specified TargetSslProxy resource.", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", + "httpMethod": "DELETE", + "id": "compute.targetSslProxies.delete", "parameterOrder": [ "project", - "region", - "targetVpnGateway" + "targetSslProxy" ], "parameters": { "project": { @@ -34721,24 +34895,56 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetSslProxy": { + "description": "Name of the TargetSslProxy resource to delete.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified TargetSslProxy resource.", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", + "httpMethod": "GET", + "id": "compute.targetSslProxies.get", + "parameterOrder": [ + "project", + "targetSslProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, - "targetVpnGateway": { - "description": "Name of the target VPN gateway to return.", + "targetSslProxy": { + "description": "Name of the TargetSslProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", "response": { - "$ref": "TargetVpnGateway" + "$ref": "TargetSslProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34747,13 +34953,12 @@ ] }, "insert": { - "description": "Creates a target VPN gateway in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways", + "description": "Creates a TargetSslProxy resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/targetSslProxies", "httpMethod": "POST", - "id": "compute.targetVpnGateways.insert", + "id": "compute.targetSslProxies.insert", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "project": { @@ -34763,22 +34968,15 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetVpnGateways", + "path": "projects/{project}/global/targetSslProxies", "request": { - "$ref": "TargetVpnGateway" + "$ref": "TargetSslProxy" }, "response": { "$ref": "Operation" @@ -34789,13 +34987,12 @@ ] }, "list": { - "description": "Retrieves a list of target VPN gateways available to the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways", + "description": "Retrieves the list of TargetSslProxy resources available to the specified project.", + "flatPath": "projects/{project}/global/targetSslProxies", "httpMethod": "GET", - "id": "compute.targetVpnGateways.list", + "id": "compute.targetSslProxies.list", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "filter": { @@ -34828,22 +35025,15 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/targetVpnGateways", + "path": "projects/{project}/global/targetSslProxies", "response": { - "$ref": "TargetVpnGatewayList" + "$ref": "TargetSslProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34851,15 +35041,14 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setLabels": { - "description": "Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels", + "setBackendService": { + "description": "Changes the BackendService for TargetSslProxy.", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", "httpMethod": "POST", - "id": "compute.targetVpnGateways.setLabels", + "id": "compute.targetSslProxies.setBackendService", "parameterOrder": [ "project", - "region", - "resource" + "targetSslProxy" ], "parameters": { "project": { @@ -34869,29 +35058,22 @@ "required": true, "type": "string" }, - "region": { - "description": "The region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "targetSslProxy": { + "description": "Name of the TargetSslProxy resource whose BackendService resource is to be set.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", "request": { - "$ref": "RegionSetLabelsRequest" + "$ref": "TargetSslProxiesSetBackendServiceRequest" }, "response": { "$ref": "Operation" @@ -34900,85 +35082,15 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "urlMaps": { - "methods": { - "aggregatedList": { - "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/urlMaps", - "httpMethod": "GET", - "id": "compute.urlMaps.aggregatedList", - "parameterOrder": [ - "project" - ], - "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, - "project": { - "description": "Name of the project scoping this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/aggregated/urlMaps", - "response": { - "$ref": "UrlMapsAggregatedList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] }, - "delete": { - "description": "Deletes the specified UrlMap resource.", - "flatPath": "projects/{project}/global/urlMaps/{urlMap}", - "httpMethod": "DELETE", - "id": "compute.urlMaps.delete", + "setCertificateMap": { + "description": "Changes the Certificate Map for TargetSslProxy.", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", + "httpMethod": "POST", + "id": "compute.targetSslProxies.setCertificateMap", "parameterOrder": [ "project", - "urlMap" + "targetSslProxy" ], "parameters": { "project": { @@ -34993,15 +35105,17 @@ "location": "query", "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to delete.", + "targetSslProxy": { + "description": "Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/urlMaps/{urlMap}", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", + "request": { + "$ref": "TargetSslProxiesSetCertificateMapRequest" + }, "response": { "$ref": "Operation" }, @@ -35010,14 +35124,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "get": { - "description": "Returns the specified UrlMap resource.", - "flatPath": "projects/{project}/global/urlMaps/{urlMap}", - "httpMethod": "GET", - "id": "compute.urlMaps.get", + "setProxyHeader": { + "description": "Changes the ProxyHeaderType for TargetSslProxy.", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", + "httpMethod": "POST", + "id": "compute.targetSslProxies.setProxyHeader", "parameterOrder": [ "project", - "urlMap" + "targetSslProxy" ], "parameters": { "project": { @@ -35027,31 +35141,39 @@ "required": true, "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to return.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetSslProxy": { + "description": "Name of the TargetSslProxy resource whose ProxyHeader is to be set.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/urlMaps/{urlMap}", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", + "request": { + "$ref": "TargetSslProxiesSetProxyHeaderRequest" + }, "response": { - "$ref": "UrlMap" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, - "insert": { - "description": "Creates a UrlMap resource in the specified project using the data included in the request.", - "flatPath": "projects/{project}/global/urlMaps", + "setSslCertificates": { + "description": "Changes SslCertificates for TargetSslProxy.", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", "httpMethod": "POST", - "id": "compute.urlMaps.insert", + "id": "compute.targetSslProxies.setSslCertificates", "parameterOrder": [ - "project" + "project", + "targetSslProxy" ], "parameters": { "project": { @@ -35065,11 +35187,18 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "targetSslProxy": { + "description": "Name of the TargetSslProxy resource whose SslCertificate resource is to be set.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/global/urlMaps", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", "request": { - "$ref": "UrlMap" + "$ref": "TargetSslProxiesSetSslCertificatesRequest" }, "response": { "$ref": "Operation" @@ -35079,14 +35208,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "invalidateCache": { - "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).", - "flatPath": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", + "setSslPolicy": { + "description": "Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends.", + "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", "httpMethod": "POST", - "id": "compute.urlMaps.invalidateCache", + "id": "compute.targetSslProxies.setSslPolicy", "parameterOrder": [ "project", - "urlMap" + "targetSslProxy" ], "parameters": { "project": { @@ -35101,17 +35230,16 @@ "location": "query", "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap scoping this request.", + "targetSslProxy": { + "description": "Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", "request": { - "$ref": "CacheInvalidationRule" + "$ref": "SslPolicyReference" }, "response": { "$ref": "Operation" @@ -35120,12 +35248,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "list": { - "description": "Retrieves the list of UrlMap resources available to the specified project.", - "flatPath": "projects/{project}/global/urlMaps", + } + } + }, + "targetTcpProxies": { + "methods": { + "aggregatedList": { + "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetTcpProxies", "httpMethod": "GET", - "id": "compute.urlMaps.list", + "id": "compute.targetTcpProxies.aggregatedList", "parameterOrder": [ "project" ], @@ -35135,6 +35267,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -35154,7 +35291,7 @@ "type": "string" }, "project": { - "description": "Project ID for this request.", + "description": "Name of the project scoping this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, @@ -35164,11 +35301,17 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/global/urlMaps", + "path": "projects/{project}/aggregated/targetTcpProxies", "response": { - "$ref": "UrlMapList" + "$ref": "TargetTcpProxyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35176,14 +35319,14 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/global/urlMaps/{urlMap}", - "httpMethod": "PATCH", - "id": "compute.urlMaps.patch", + "delete": { + "description": "Deletes the specified TargetTcpProxy resource.", + "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", + "httpMethod": "DELETE", + "id": "compute.targetTcpProxies.delete", "parameterOrder": [ "project", - "urlMap" + "targetTcpProxy" ], "parameters": { "project": { @@ -35198,17 +35341,83 @@ "location": "query", "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to patch.", + "targetTcpProxy": { + "description": "Name of the TargetTcpProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/urlMaps/{urlMap}", + "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified TargetTcpProxy resource.", + "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", + "httpMethod": "GET", + "id": "compute.targetTcpProxies.get", + "parameterOrder": [ + "project", + "targetTcpProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "targetTcpProxy": { + "description": "Name of the TargetTcpProxy resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", + "response": { + "$ref": "TargetTcpProxy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/targetTcpProxies", + "httpMethod": "POST", + "id": "compute.targetTcpProxies.insert", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/targetTcpProxies", "request": { - "$ref": "UrlMap" + "$ref": "TargetTcpProxy" }, "response": { "$ref": "Operation" @@ -35218,14 +35427,69 @@ "https://www.googleapis.com/auth/compute" ] }, - "update": { - "description": "Updates the specified UrlMap resource with the data included in the request.", - "flatPath": "projects/{project}/global/urlMaps/{urlMap}", - "httpMethod": "PUT", - "id": "compute.urlMaps.update", + "list": { + "description": "Retrieves the list of TargetTcpProxy resources available to the specified project.", + "flatPath": "projects/{project}/global/targetTcpProxies", + "httpMethod": "GET", + "id": "compute.targetTcpProxies.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/targetTcpProxies", + "response": { + "$ref": "TargetTcpProxyList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "setBackendService": { + "description": "Changes the BackendService for TargetTcpProxy.", + "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", + "httpMethod": "POST", + "id": "compute.targetTcpProxies.setBackendService", "parameterOrder": [ "project", - "urlMap" + "targetTcpProxy" ], "parameters": { "project": { @@ -35240,17 +35504,17 @@ "location": "query", "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to update.", + "targetTcpProxy": { + "description": "Name of the TargetTcpProxy resource whose BackendService resource is to be set.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/urlMaps/{urlMap}", + "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", "request": { - "$ref": "UrlMap" + "$ref": "TargetTcpProxiesSetBackendServiceRequest" }, "response": { "$ref": "Operation" @@ -35260,14 +35524,14 @@ "https://www.googleapis.com/auth/compute" ] }, - "validate": { - "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", - "flatPath": "projects/{project}/global/urlMaps/{urlMap}/validate", + "setProxyHeader": { + "description": "Changes the ProxyHeaderType for TargetTcpProxy.", + "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", "httpMethod": "POST", - "id": "compute.urlMaps.validate", + "id": "compute.targetTcpProxies.setProxyHeader", "parameterOrder": [ "project", - "urlMap" + "targetTcpProxy" ], "parameters": { "project": { @@ -35277,20 +35541,25 @@ "required": true, "type": "string" }, - "urlMap": { - "description": "Name of the UrlMap resource to be validated as.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetTcpProxy": { + "description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/global/urlMaps/{urlMap}/validate", + "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", "request": { - "$ref": "UrlMapsValidateRequest" + "$ref": "TargetTcpProxiesSetProxyHeaderRequest" }, "response": { - "$ref": "UrlMapsValidateResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35299,13 +35568,13 @@ } } }, - "vpnGateways": { + "targetVpnGateways": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/vpnGateways", + "description": "Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/targetVpnGateways", "httpMethod": "GET", - "id": "compute.vpnGateways.aggregatedList", + "id": "compute.targetVpnGateways.aggregatedList", "parameterOrder": [ "project" ], @@ -35357,9 +35626,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/vpnGateways", + "path": "projects/{project}/aggregated/targetVpnGateways", "response": { - "$ref": "VpnGatewayAggregatedList" + "$ref": "TargetVpnGatewayAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35368,14 +35637,14 @@ ] }, "delete": { - "description": "Deletes the specified VPN gateway.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", + "description": "Deletes the specified target VPN gateway.", + "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "httpMethod": "DELETE", - "id": "compute.vpnGateways.delete", + "id": "compute.targetVpnGateways.delete", "parameterOrder": [ "project", "region", - "vpnGateway" + "targetVpnGateway" ], "parameters": { "project": { @@ -35397,15 +35666,15 @@ "location": "query", "type": "string" }, - "vpnGateway": { - "description": "Name of the VPN gateway to delete.", + "targetVpnGateway": { + "description": "Name of the target VPN gateway to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", + "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "response": { "$ref": "Operation" }, @@ -35415,57 +35684,14 @@ ] }, "get": { - "description": "Returns the specified VPN gateway.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", - "httpMethod": "GET", - "id": "compute.vpnGateways.get", - "parameterOrder": [ - "project", - "region", - "vpnGateway" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "vpnGateway": { - "description": "Name of the VPN gateway to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", - "response": { - "$ref": "VpnGateway" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "getStatus": { - "description": "Returns the status for the specified VPN gateway.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", + "description": "Returns the specified target VPN gateway.", + "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "httpMethod": "GET", - "id": "compute.vpnGateways.getStatus", + "id": "compute.targetVpnGateways.get", "parameterOrder": [ "project", "region", - "vpnGateway" + "targetVpnGateway" ], "parameters": { "project": { @@ -35482,17 +35708,17 @@ "required": true, "type": "string" }, - "vpnGateway": { - "description": "Name of the VPN gateway to return.", + "targetVpnGateway": { + "description": "Name of the target VPN gateway to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", + "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "response": { - "$ref": "VpnGatewaysGetStatusResponse" + "$ref": "TargetVpnGateway" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35501,10 +35727,10 @@ ] }, "insert": { - "description": "Creates a VPN gateway in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways", + "description": "Creates a target VPN gateway in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/targetVpnGateways", "httpMethod": "POST", - "id": "compute.vpnGateways.insert", + "id": "compute.targetVpnGateways.insert", "parameterOrder": [ "project", "region" @@ -35530,9 +35756,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnGateways", + "path": "projects/{project}/regions/{region}/targetVpnGateways", "request": { - "$ref": "VpnGateway" + "$ref": "TargetVpnGateway" }, "response": { "$ref": "Operation" @@ -35543,10 +35769,10 @@ ] }, "list": { - "description": "Retrieves a list of VPN gateways available to the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways", + "description": "Retrieves a list of target VPN gateways available to the specified project and region.", + "flatPath": "projects/{project}/regions/{region}/targetVpnGateways", "httpMethod": "GET", - "id": "compute.vpnGateways.list", + "id": "compute.targetVpnGateways.list", "parameterOrder": [ "project", "region" @@ -35595,9 +35821,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/vpnGateways", + "path": "projects/{project}/regions/{region}/targetVpnGateways", "response": { - "$ref": "VpnGatewayList" + "$ref": "TargetVpnGatewayList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35606,10 +35832,10 @@ ] }, "setLabels": { - "description": "Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels", + "description": "Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels", "httpMethod": "POST", - "id": "compute.vpnGateways.setLabels", + "id": "compute.targetVpnGateways.setLabels", "parameterOrder": [ "project", "region", @@ -35643,7 +35869,7 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels", + "path": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels", "request": { "$ref": "RegionSetLabelsRequest" }, @@ -35654,62 +35880,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.vpnGateways.testIamPermissions", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "The name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, - "response": { - "$ref": "TestPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] } } }, - "vpnTunnels": { + "urlMaps": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/vpnTunnels", + "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/urlMaps", "httpMethod": "GET", - "id": "compute.vpnTunnels.aggregatedList", + "id": "compute.urlMaps.aggregatedList", "parameterOrder": [ "project" ], @@ -35743,7 +35923,7 @@ "type": "string" }, "project": { - "description": "Project ID for this request.", + "description": "Name of the project scoping this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, @@ -35761,9 +35941,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/vpnTunnels", + "path": "projects/{project}/aggregated/urlMaps", "response": { - "$ref": "VpnTunnelAggregatedList" + "$ref": "UrlMapsAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35772,14 +35952,13 @@ ] }, "delete": { - "description": "Deletes the specified VpnTunnel resource.", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "description": "Deletes the specified UrlMap resource.", + "flatPath": "projects/{project}/global/urlMaps/{urlMap}", "httpMethod": "DELETE", - "id": "compute.vpnTunnels.delete", + "id": "compute.urlMaps.delete", "parameterOrder": [ "project", - "region", - "vpnTunnel" + "urlMap" ], "parameters": { "project": { @@ -35789,27 +35968,20 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "vpnTunnel": { - "description": "Name of the VpnTunnel resource to delete.", + "urlMap": { + "description": "Name of the UrlMap resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "path": "projects/{project}/global/urlMaps/{urlMap}", "response": { "$ref": "Operation" }, @@ -35819,14 +35991,13 @@ ] }, "get": { - "description": "Returns the specified VpnTunnel resource.", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "description": "Returns the specified UrlMap resource.", + "flatPath": "projects/{project}/global/urlMaps/{urlMap}", "httpMethod": "GET", - "id": "compute.vpnTunnels.get", + "id": "compute.urlMaps.get", "parameterOrder": [ "project", - "region", - "vpnTunnel" + "urlMap" ], "parameters": { "project": { @@ -35836,24 +36007,17 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "vpnTunnel": { - "description": "Name of the VpnTunnel resource to return.", + "urlMap": { + "description": "Name of the UrlMap resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "path": "projects/{project}/global/urlMaps/{urlMap}", "response": { - "$ref": "VpnTunnel" + "$ref": "UrlMap" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35862,13 +36026,12 @@ ] }, "insert": { - "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels", + "description": "Creates a UrlMap resource in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/urlMaps", "httpMethod": "POST", - "id": "compute.vpnTunnels.insert", + "id": "compute.urlMaps.insert", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "project": { @@ -35878,10 +36041,38 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/urlMaps", + "request": { + "$ref": "UrlMap" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "invalidateCache": { + "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).", + "flatPath": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", + "httpMethod": "POST", + "id": "compute.urlMaps.invalidateCache", + "parameterOrder": [ + "project", + "urlMap" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, @@ -35889,11 +36080,18 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "urlMap": { + "description": "Name of the UrlMap scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnTunnels", + "path": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", "request": { - "$ref": "VpnTunnel" + "$ref": "CacheInvalidationRule" }, "response": { "$ref": "Operation" @@ -35904,13 +36102,12 @@ ] }, "list": { - "description": "Retrieves a list of VpnTunnel resources contained in the specified project and region.", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels", + "description": "Retrieves the list of UrlMap resources available to the specified project.", + "flatPath": "projects/{project}/global/urlMaps", "httpMethod": "GET", - "id": "compute.vpnTunnels.list", + "id": "compute.urlMaps.list", "parameterOrder": [ - "project", - "region" + "project" ], "parameters": { "filter": { @@ -35943,22 +36140,15 @@ "required": true, "type": "string" }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/vpnTunnels", + "path": "projects/{project}/global/urlMaps", "response": { - "$ref": "VpnTunnelList" + "$ref": "UrlMapList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35966,15 +36156,14 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setLabels": { - "description": "Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", - "httpMethod": "POST", - "id": "compute.vpnTunnels.setLabels", + "patch": { + "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/global/urlMaps/{urlMap}", + "httpMethod": "PATCH", + "id": "compute.urlMaps.patch", "parameterOrder": [ "project", - "region", - "resource" + "urlMap" ], "parameters": { "project": { @@ -35984,29 +36173,22 @@ "required": true, "type": "string" }, - "region": { - "description": "The region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "urlMap": { + "description": "Name of the UrlMap resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", + "path": "projects/{project}/global/urlMaps/{urlMap}", "request": { - "$ref": "RegionSetLabelsRequest" + "$ref": "UrlMap" }, "response": { "$ref": "Operation" @@ -36015,28 +36197,126 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "zoneOperations": { - "methods": { - "delete": { - "description": "Deletes the specified zone-specific Operations resource.", - "flatPath": "projects/{project}/zones/{zone}/operations/{operation}", - "httpMethod": "DELETE", - "id": "compute.zoneOperations.delete", + }, + "update": { + "description": "Updates the specified UrlMap resource with the data included in the request.", + "flatPath": "projects/{project}/global/urlMaps/{urlMap}", + "httpMethod": "PUT", + "id": "compute.urlMaps.update", "parameterOrder": [ "project", - "zone", - "operation" + "urlMap" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to delete.", + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "urlMap": { + "description": "Name of the UrlMap resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/urlMaps/{urlMap}", + "request": { + "$ref": "UrlMap" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "validate": { + "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", + "flatPath": "projects/{project}/global/urlMaps/{urlMap}/validate", + "httpMethod": "POST", + "id": "compute.urlMaps.validate", + "parameterOrder": [ + "project", + "urlMap" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "urlMap": { + "description": "Name of the UrlMap resource to be validated as.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + } + }, + "path": "projects/{project}/global/urlMaps/{urlMap}/validate", + "request": { + "$ref": "UrlMapsValidateRequest" + }, + "response": { + "$ref": "UrlMapsValidateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "vpnGateways": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/vpnGateways", + "httpMethod": "GET", + "id": "compute.vpnGateways.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" }, "project": { "description": "Project ID for this request.", @@ -36045,38 +36325,129 @@ "required": true, "type": "string" }, - "zone": { - "description": "Name of the zone for this request.", + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/vpnGateways", + "response": { + "$ref": "VpnGatewayAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified VPN gateway.", + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", + "httpMethod": "DELETE", + "id": "compute.vpnGateways.delete", + "parameterOrder": [ + "project", + "region", + "vpnGateway" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "vpnGateway": { + "description": "Name of the VPN gateway to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/zones/{zone}/operations/{operation}", + "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", + "response": { + "$ref": "Operation" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, "get": { - "description": "Retrieves the specified zone-specific Operations resource.", - "flatPath": "projects/{project}/zones/{zone}/operations/{operation}", + "description": "Returns the specified VPN gateway.", + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", "httpMethod": "GET", - "id": "compute.zoneOperations.get", + "id": "compute.vpnGateways.get", "parameterOrder": [ "project", - "zone", - "operation" + "region", + "vpnGateway" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to return.", + "project": { + "description": "Project ID for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, + "vpnGateway": { + "description": "Name of the VPN gateway to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", + "response": { + "$ref": "VpnGateway" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getStatus": { + "description": "Returns the status for the specified VPN gateway.", + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", + "httpMethod": "GET", + "id": "compute.vpnGateways.getStatus", + "parameterOrder": [ + "project", + "region", + "vpnGateway" + ], + "parameters": { "project": { "description": "Project ID for this request.", "location": "path", @@ -36084,17 +36455,24 @@ "required": true, "type": "string" }, - "zone": { - "description": "Name of the zone for this request.", + "region": { + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "vpnGateway": { + "description": "Name of the VPN gateway to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/zones/{zone}/operations/{operation}", + "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", "response": { - "$ref": "Operation" + "$ref": "VpnGatewaysGetStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36102,14 +36480,56 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "insert": { + "description": "Creates a VPN gateway in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/vpnGateways", + "httpMethod": "POST", + "id": "compute.vpnGateways.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/vpnGateways", + "request": { + "$ref": "VpnGateway" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "list": { - "description": "Retrieves a list of Operation resources contained within the specified zone.", - "flatPath": "projects/{project}/zones/{zone}/operations", + "description": "Retrieves a list of VPN gateways available to the specified project and region.", + "flatPath": "projects/{project}/regions/{region}/vpnGateways", "httpMethod": "GET", - "id": "compute.zoneOperations.list", + "id": "compute.vpnGateways.list", "parameterOrder": [ "project", - "zone" + "region" ], "parameters": { "filter": { @@ -36142,22 +36562,22 @@ "required": true, "type": "string" }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - }, - "zone": { - "description": "Name of the zone for request.", + "region": { + "description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/zones/{zone}/operations", + "path": "projects/{project}/regions/{region}/vpnGateways", "response": { - "$ref": "OperationList" + "$ref": "VpnGatewayList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36165,24 +36585,17 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "wait": { - "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", - "flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait", + "setLabels": { + "description": "Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels", "httpMethod": "POST", - "id": "compute.zoneOperations.wait", + "id": "compute.vpnGateways.setLabels", "parameterOrder": [ "project", - "zone", - "operation" + "region", + "resource" ], "parameters": { - "operation": { - "description": "Name of the Operations resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -36190,36 +36603,47 @@ "required": true, "type": "string" }, - "zone": { - "description": "Name of the zone for this request.", + "region": { + "description": "The region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" } }, - "path": "projects/{project}/zones/{zone}/operations/{operation}/wait", + "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels", + "request": { + "$ref": "RegionSetLabelsRequest" + }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] - } - } - }, - "zones": { - "methods": { - "get": { - "description": "Returns the specified Zone resource.", - "flatPath": "projects/{project}/zones/{zone}", - "httpMethod": "GET", - "id": "compute.zones.get", + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.vpnGateways.testIamPermissions", "parameterOrder": [ "project", - "zone" + "region", + "resource" ], "parameters": { "project": { @@ -36229,29 +36653,43 @@ "required": true, "type": "string" }, - "zone": { - "description": "Name of the zone resource to return.", + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/zones/{zone}", + "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, "response": { - "$ref": "Zone" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "list": { - "description": "Retrieves the list of Zone resources available to the specified project.", - "flatPath": "projects/{project}/zones", + } + } + }, + "vpnTunnels": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/vpnTunnels", "httpMethod": "GET", - "id": "compute.zones.list", + "id": "compute.vpnTunnels.aggregatedList", "parameterOrder": [ "project" ], @@ -36261,6 +36699,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -36290,73 +36733,610 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" } }, - "path": "projects/{project}/zones", + "path": "projects/{project}/aggregated/vpnTunnels", "response": { - "$ref": "ZoneList" + "$ref": "VpnTunnelAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - } - }, - "revision": "20240218", - "rootUrl": "https://compute.googleapis.com/", - "schemas": { - "AWSV4Signature": { - "description": "Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.", - "id": "AWSV4Signature", - "properties": { - "accessKey": { - "description": "The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly", - "type": "string" - }, - "accessKeyId": { - "description": "The identifier of an access key used for s3 bucket authentication.", - "type": "string" - }, - "accessKeyVersion": { - "description": "The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.", - "type": "string" - }, - "originRegion": { - "description": "The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, \"us-east-1\" for AWS or \"us-ashburn-1\" for OCI.", - "type": "string" - } - }, - "type": "object" - }, - "AcceleratorConfig": { - "description": "A specification of the type and number of accelerator cards attached to the instance.", - "id": "AcceleratorConfig", - "properties": { - "acceleratorCount": { - "description": "The number of the guest accelerator cards exposed to this instance.", - "format": "int32", - "type": "integer" }, - "acceleratorType": { - "description": "Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.", - "type": "string" - } - }, - "type": "object" - }, - "AcceleratorType": { - "description": "Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine.", - "id": "AcceleratorType", - "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" + "delete": { + "description": "Deletes the specified VpnTunnel resource.", + "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "httpMethod": "DELETE", + "id": "compute.vpnTunnels.delete", + "parameterOrder": [ + "project", + "region", + "vpnTunnel" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "vpnTunnel": { + "description": "Name of the VpnTunnel resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] }, - "deprecated": { - "$ref": "DeprecationStatus", + "get": { + "description": "Returns the specified VpnTunnel resource.", + "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "httpMethod": "GET", + "id": "compute.vpnTunnels.get", + "parameterOrder": [ + "project", + "region", + "vpnTunnel" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "vpnTunnel": { + "description": "Name of the VpnTunnel resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "response": { + "$ref": "VpnTunnel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/vpnTunnels", + "httpMethod": "POST", + "id": "compute.vpnTunnels.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/vpnTunnels", + "request": { + "$ref": "VpnTunnel" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves a list of VpnTunnel resources contained in the specified project and region.", + "flatPath": "projects/{project}/regions/{region}/vpnTunnels", + "httpMethod": "GET", + "id": "compute.vpnTunnels.list", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/vpnTunnels", + "response": { + "$ref": "VpnTunnelList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "setLabels": { + "description": "Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.vpnTunnels.setLabels", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", + "request": { + "$ref": "RegionSetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "zoneOperations": { + "methods": { + "delete": { + "description": "Deletes the specified zone-specific Operations resource.", + "flatPath": "projects/{project}/zones/{zone}/operations/{operation}", + "httpMethod": "DELETE", + "id": "compute.zoneOperations.delete", + "parameterOrder": [ + "project", + "zone", + "operation" + ], + "parameters": { + "operation": { + "description": "Name of the Operations resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/operations/{operation}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Retrieves the specified zone-specific Operations resource.", + "flatPath": "projects/{project}/zones/{zone}/operations/{operation}", + "httpMethod": "GET", + "id": "compute.zoneOperations.get", + "parameterOrder": [ + "project", + "zone", + "operation" + ], + "parameters": { + "operation": { + "description": "Name of the Operations resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/operations/{operation}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves a list of Operation resources contained within the specified zone.", + "flatPath": "projects/{project}/zones/{zone}/operations", + "httpMethod": "GET", + "id": "compute.zoneOperations.list", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "Name of the zone for request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/operations", + "response": { + "$ref": "OperationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "wait": { + "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", + "flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait", + "httpMethod": "POST", + "id": "compute.zoneOperations.wait", + "parameterOrder": [ + "project", + "zone", + "operation" + ], + "parameters": { + "operation": { + "description": "Name of the Operations resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/operations/{operation}/wait", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "zones": { + "methods": { + "get": { + "description": "Returns the specified Zone resource.", + "flatPath": "projects/{project}/zones/{zone}", + "httpMethod": "GET", + "id": "compute.zones.get", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}", + "response": { + "$ref": "Zone" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves the list of Zone resources available to the specified project.", + "flatPath": "projects/{project}/zones", + "httpMethod": "GET", + "id": "compute.zones.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/zones", + "response": { + "$ref": "ZoneList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + } + }, + "revision": "20240305", + "rootUrl": "https://compute.googleapis.com/", + "schemas": { + "AWSV4Signature": { + "description": "Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.", + "id": "AWSV4Signature", + "properties": { + "accessKey": { + "description": "The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly", + "type": "string" + }, + "accessKeyId": { + "description": "The identifier of an access key used for s3 bucket authentication.", + "type": "string" + }, + "accessKeyVersion": { + "description": "The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.", + "type": "string" + }, + "originRegion": { + "description": "The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, \"us-east-1\" for AWS or \"us-ashburn-1\" for OCI.", + "type": "string" + } + }, + "type": "object" + }, + "AcceleratorConfig": { + "description": "A specification of the type and number of accelerator cards attached to the instance.", + "id": "AcceleratorConfig", + "properties": { + "acceleratorCount": { + "description": "The number of the guest accelerator cards exposed to this instance.", + "format": "int32", + "type": "integer" + }, + "acceleratorType": { + "description": "Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.", + "type": "string" + } + }, + "type": "object" + }, + "AcceleratorType": { + "description": "Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine.", + "id": "AcceleratorType", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "deprecated": { + "$ref": "DeprecationStatus", "description": "[Output Only] The deprecation status associated with this accelerator type." }, "description": { @@ -37991,6 +38971,10 @@ "sourceSnapshotEncryptionKey": { "$ref": "CustomerEncryptionKey", "description": "The customer-supplied encryption key of the source snapshot." + }, + "storagePool": { + "description": "The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool ", + "type": "string" } }, "type": "object" @@ -41133,6 +42117,7 @@ "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", + "GENERAL_PURPOSE_N4", "GENERAL_PURPOSE_T2D", "GRAPHICS_OPTIMIZED", "MEMORY_OPTIMIZED", @@ -41157,6 +42142,7 @@ "", "", "", + "", "" ], "type": "string" @@ -41774,7 +42760,7 @@ "type": "array" }, "allowOriginRegexes": { - "description": "Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", + "description": "Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", "items": { "type": "string" }, @@ -41788,7 +42774,7 @@ "type": "array" }, "disabled": { - "description": "If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.", + "description": "If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.", "type": "boolean" }, "exposeHeaders": { @@ -42118,17 +43104,23 @@ "DELETING", "FAILED", "READY", - "RESTORING" + "RESTORING", + "UNAVAILABLE" ], "enumDescriptions": [ "Disk is provisioning", "Disk is deleting.", "Disk creation failed.", "Disk is ready for use.", - "Source data is being copied into the disk." + "Source data is being copied into the disk.", + "Disk is currently unavailable and cannot be accessed, attached or detached." ], "type": "string" }, + "storagePool": { + "description": "The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool ", + "type": "string" + }, "type": { "description": "URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.", "type": "string" @@ -45619,7 +46611,7 @@ "id": "GuestOsFeature", "properties": { "type": { - "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", + "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", "enum": [ "FEATURE_TYPE_UNSPECIFIED", "GVNIC", @@ -49407,6 +50399,350 @@ }, "type": "object" }, + "InstanceGroupManagerResizeRequest": { + "description": "InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.", + "id": "InstanceGroupManagerResizeRequest", + "properties": { + "creationTimestamp": { + "description": "[Output Only] The creation timestamp for this resize request in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#instanceGroupManagerResizeRequest", + "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.instanceGroupManagerResizeRequests.insert" + ] + }, + "description": "The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "requestedRunDuration": { + "$ref": "Duration", + "description": "Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted." + }, + "resizeBy": { + "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number.", + "format": "int32", + "type": "integer" + }, + "selfLink": { + "description": "[Output Only] The URL for this resize request. The server defines this URL.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "state": { + "description": "[Output only] Current state of the request.", + "enum": [ + "ACCEPTED", + "CANCELLED", + "CREATING", + "FAILED", + "STATE_UNSPECIFIED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "The request was created successfully and was accepted for provisioning when the capacity becomes available.", + "The request is cancelled.", + "Resize request is being created and may still fail creation.", + "The request failed before or during provisioning. If the request fails during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.", + "Default value. This value should never be returned.", + "The request succeeded." + ], + "type": "string" + }, + "status": { + "$ref": "InstanceGroupManagerResizeRequestStatus", + "description": "[Output only] Status of the request." + }, + "zone": { + "description": "[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.", + "type": "string" + } + }, + "type": "object" + }, + "InstanceGroupManagerResizeRequestStatus": { + "id": "InstanceGroupManagerResizeRequestStatus", + "properties": { + "error": { + "description": "[Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.", + "properties": { + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "properties": { + "code": { + "description": "[Output Only] The error type identifier for this error.", + "type": "string" + }, + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "lastAttempt": { + "$ref": "InstanceGroupManagerResizeRequestStatusLastAttempt", + "description": "[Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the \"error\" field only." + } + }, + "type": "object" + }, + "InstanceGroupManagerResizeRequestStatusLastAttempt": { + "id": "InstanceGroupManagerResizeRequestStatusLastAttempt", + "properties": { + "error": { + "description": "Errors that prevented the ResizeRequest to be fulfilled.", + "properties": { + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "properties": { + "code": { + "description": "[Output Only] The error type identifier for this error.", + "type": "string" + }, + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InstanceGroupManagerResizeRequestsListResponse": { + "description": "[Output Only] A list of resize requests.", + "id": "InstanceGroupManagerResizeRequestsListResponse", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of resize request resources.", + "items": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "type": "array" + }, + "kind": { + "default": "compute#instanceGroupManagerResizeRequestList", + "description": "[Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "InstanceGroupManagerStatus": { "id": "InstanceGroupManagerStatus", "properties": { @@ -51972,13 +53308,15 @@ "CREATING", "DELETING", "FAILED", - "READY" + "READY", + "UNAVAILABLE" ], "enumDescriptions": [ "InstantSnapshot creation is in progress.", "InstantSnapshot is currently being deleted.", "InstantSnapshot creation failed.", - "InstantSnapshot has been created successfully." + "InstantSnapshot has been created successfully.", + "InstantSnapshot is currently unavailable and cannot be used for Disk restoration" ], "type": "string" }, @@ -54409,7 +55747,7 @@ "id": "InterconnectRemoteLocationConstraints", "properties": { "portPairRemoteLocation": { - "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. GCP's API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", + "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", "enum": [ "PORT_PAIR_MATCHING_REMOTE_LOCATION", "PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION" @@ -63821,6 +65159,9 @@ "GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES", "GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES", "GPUS_ALL_REGIONS", + "HDB_TOTAL_GB", + "HDB_TOTAL_IOPS", + "HDB_TOTAL_THROUGHPUT", "HEALTH_CHECKS", "IMAGES", "INSTANCES", @@ -63894,6 +65235,7 @@ "REGIONAL_INSTANCE_GROUP_MANAGERS", "REGIONAL_INTERNAL_LB_BACKEND_SERVICES", "REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES", + "REGIONAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES", "RESERVATIONS", "RESOURCE_POLICIES", "ROUTERS", @@ -64065,6 +65407,10 @@ "", "", "", + "", + "", + "", + "", "The total number of snapshots allowed for a single project.", "", "", @@ -64233,43 +65579,559 @@ "items": { "type": "string" }, - "type": "array" + "type": "array" + } + }, + "type": "object" + }, + "RegionAddressesMoveRequest": { + "id": "RegionAddressesMoveRequest", + "properties": { + "description": { + "description": "An optional destination address description if intended to be different from the source.", + "type": "string" + }, + "destinationAddress": { + "description": "The URL of the destination address to move to. This can be a full or partial URL. For example, the following are all valid URLs to a address: - https://www.googleapis.com/compute/v1/projects/project/regions/region /addresses/address - projects/project/regions/region/addresses/address Note that destination project must be different from the source project. So /regions/region/addresses/address is not valid partial url.", + "type": "string" + } + }, + "type": "object" + }, + "RegionAutoscalerList": { + "description": "Contains a list of autoscalers.", + "id": "RegionAutoscalerList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of Autoscaler resources.", + "items": { + "$ref": "Autoscaler" + }, + "type": "array" + }, + "kind": { + "default": "compute#regionAutoscalerList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "RegionDiskTypeList": { + "id": "RegionDiskTypeList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of DiskType resources.", + "items": { + "$ref": "DiskType" + }, + "type": "array" + }, + "kind": { + "default": "compute#regionDiskTypeList", + "description": "[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "RegionDisksAddResourcePoliciesRequest": { + "id": "RegionDisksAddResourcePoliciesRequest", + "properties": { + "resourcePolicies": { + "description": "Resource policies to be added to this disk.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionDisksRemoveResourcePoliciesRequest": { + "id": "RegionDisksRemoveResourcePoliciesRequest", + "properties": { + "resourcePolicies": { + "description": "Resource policies to be removed from this disk.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionDisksResizeRequest": { + "id": "RegionDisksResizeRequest", + "properties": { + "sizeGb": { + "description": "The new size of the regional persistent disk, which is specified in GB.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RegionDisksStartAsyncReplicationRequest": { + "id": "RegionDisksStartAsyncReplicationRequest", + "properties": { + "asyncSecondaryDisk": { + "description": "The secondary disk to start asynchronous replication to. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk ", + "type": "string" + } + }, + "type": "object" + }, + "RegionInstanceGroupList": { + "description": "Contains a list of InstanceGroup resources.", + "id": "RegionInstanceGroupList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of InstanceGroup resources.", + "items": { + "$ref": "InstanceGroup" + }, + "type": "array" + }, + "kind": { + "default": "compute#regionInstanceGroupList", + "description": "The resource type.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "RegionAddressesMoveRequest": { - "id": "RegionAddressesMoveRequest", + "RegionInstanceGroupManagerDeleteInstanceConfigReq": { + "description": "RegionInstanceGroupManagers.deletePerInstanceConfigs", + "id": "RegionInstanceGroupManagerDeleteInstanceConfigReq", "properties": { - "description": { - "description": "An optional destination address description if intended to be different from the source.", - "type": "string" - }, - "destinationAddress": { - "description": "The URL of the destination address to move to. This can be a full or partial URL. For example, the following are all valid URLs to a address: - https://www.googleapis.com/compute/v1/projects/project/regions/region /addresses/address - projects/project/regions/region/addresses/address Note that destination project must be different from the source project. So /regions/region/addresses/address is not valid partial url.", - "type": "string" + "names": { + "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "RegionAutoscalerList": { - "description": "Contains a list of autoscalers.", - "id": "RegionAutoscalerList", + "RegionInstanceGroupManagerList": { + "description": "Contains a list of managed instance groups.", + "id": "RegionInstanceGroupManagerList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of Autoscaler resources.", + "description": "A list of InstanceGroupManager resources.", "items": { - "$ref": "Autoscaler" + "$ref": "InstanceGroupManager" }, "type": "array" }, "kind": { - "default": "compute#regionAutoscalerList", - "description": "Type of resource.", + "default": "compute#regionInstanceGroupManagerList", + "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.", "type": "string" }, "nextPageToken": { @@ -64404,31 +66266,157 @@ }, "type": "object" }, - "RegionDiskTypeList": { - "id": "RegionDiskTypeList", + "RegionInstanceGroupManagerPatchInstanceConfigReq": { + "description": "RegionInstanceGroupManagers.patchPerInstanceConfigs", + "id": "RegionInstanceGroupManagerPatchInstanceConfigReq", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" + "perInstanceConfigs": { + "description": "The list of per-instance configurations to insert or patch on this managed instance group.", + "items": { + "$ref": "PerInstanceConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagerUpdateInstanceConfigReq": { + "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs", + "id": "RegionInstanceGroupManagerUpdateInstanceConfigReq", + "properties": { + "perInstanceConfigs": { + "description": "The list of per-instance configurations to insert or patch on this managed instance group.", + "items": { + "$ref": "PerInstanceConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagersAbandonInstancesRequest": { + "id": "RegionInstanceGroupManagersAbandonInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagersApplyUpdatesRequest": { + "description": "RegionInstanceGroupManagers.applyUpdatesToInstances", + "id": "RegionInstanceGroupManagersApplyUpdatesRequest", + "properties": { + "allInstances": { + "description": "Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.", + "type": "boolean" }, - "items": { - "description": "A list of DiskType resources.", + "instances": { + "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", "items": { - "$ref": "DiskType" + "type": "string" }, "type": "array" }, - "kind": { - "default": "compute#regionDiskTypeList", - "description": "[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.", + "minimalAction": { + "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.", + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" + ], + "enumDescriptions": [ + "Do not perform any action.", + "Do not stop the instance.", + "(Default.) Replace the instance according to the replacement method option.", + "Stop the instance and start it again." + ], + "type": "string" + }, + "mostDisruptiveAllowedAction": { + "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.", + "enum": [ + "NONE", + "REFRESH", + "REPLACE", + "RESTART" + ], + "enumDescriptions": [ + "Do not perform any action.", + "Do not stop the instance.", + "(Default.) Replace the instance according to the replacement method option.", + "Stop the instance and start it again." + ], "type": "string" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagersCreateInstancesRequest": { + "description": "RegionInstanceGroupManagers.createInstances", + "id": "RegionInstanceGroupManagersCreateInstancesRequest", + "properties": { + "instances": { + "description": "[Required] List of specifications of per-instance configs.", + "items": { + "$ref": "PerInstanceConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagersDeleteInstancesRequest": { + "id": "RegionInstanceGroupManagersDeleteInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + }, + "skipInstancesOnValidationError": { + "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.", + "type": "boolean" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagersListErrorsResponse": { + "id": "RegionInstanceGroupManagersListErrorsResponse", + "properties": { + "items": { + "description": "[Output Only] The list of errors of the managed instance group.", + "items": { + "$ref": "InstanceManagedByIgmError" + }, + "type": "array" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagersListInstanceConfigsResp": { + "id": "RegionInstanceGroupManagersListInstanceConfigsResp", + "properties": { + "items": { + "description": "[Output Only] The list of PerInstanceConfig.", + "items": { + "$ref": "PerInstanceConfig" + }, + "type": "array" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { @@ -64555,24 +66543,28 @@ }, "type": "object" }, - "RegionDisksAddResourcePoliciesRequest": { - "id": "RegionDisksAddResourcePoliciesRequest", + "RegionInstanceGroupManagersListInstancesResponse": { + "id": "RegionInstanceGroupManagersListInstancesResponse", "properties": { - "resourcePolicies": { - "description": "Resource policies to be added to this disk.", + "managedInstances": { + "description": "A list of managed instances.", "items": { - "type": "string" + "$ref": "ManagedInstance" }, "type": "array" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" } }, "type": "object" }, - "RegionDisksRemoveResourcePoliciesRequest": { - "id": "RegionDisksRemoveResourcePoliciesRequest", + "RegionInstanceGroupManagersRecreateRequest": { + "id": "RegionInstanceGroupManagersRecreateRequest", "properties": { - "resourcePolicies": { - "description": "Resource policies to be removed from this disk.", + "instances": { + "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", "items": { "type": "string" }, @@ -64581,44 +66573,50 @@ }, "type": "object" }, - "RegionDisksResizeRequest": { - "id": "RegionDisksResizeRequest", + "RegionInstanceGroupManagersSetTargetPoolsRequest": { + "id": "RegionInstanceGroupManagersSetTargetPoolsRequest", "properties": { - "sizeGb": { - "description": "The new size of the regional persistent disk, which is specified in GB.", - "format": "int64", + "fingerprint": { + "description": "Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.", + "format": "byte", "type": "string" + }, + "targetPools": { + "description": "The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "RegionDisksStartAsyncReplicationRequest": { - "id": "RegionDisksStartAsyncReplicationRequest", + "RegionInstanceGroupManagersSetTemplateRequest": { + "id": "RegionInstanceGroupManagersSetTemplateRequest", "properties": { - "asyncSecondaryDisk": { - "description": "The secondary disk to start asynchronous replication to. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk ", + "instanceTemplate": { + "description": "URL of the InstanceTemplate resource from which all new instances will be created.", "type": "string" } }, "type": "object" }, - "RegionInstanceGroupList": { - "description": "Contains a list of InstanceGroup resources.", - "id": "RegionInstanceGroupList", + "RegionInstanceGroupsListInstances": { + "id": "RegionInstanceGroupsListInstances", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InstanceGroup resources.", + "description": "A list of InstanceWithNamedPorts resources.", "items": { - "$ref": "InstanceGroup" + "$ref": "InstanceWithNamedPorts" }, "type": "array" }, "kind": { - "default": "compute#regionInstanceGroupList", + "default": "compute#regionInstanceGroupsListInstances", "description": "The resource type.", "type": "string" }, @@ -64754,38 +66752,65 @@ }, "type": "object" }, - "RegionInstanceGroupManagerDeleteInstanceConfigReq": { - "description": "RegionInstanceGroupManagers.deletePerInstanceConfigs", - "id": "RegionInstanceGroupManagerDeleteInstanceConfigReq", + "RegionInstanceGroupsListInstancesRequest": { + "id": "RegionInstanceGroupsListInstancesRequest", "properties": { - "names": { - "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.", + "instanceState": { + "description": "Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.", + "enum": [ + "ALL", + "RUNNING" + ], + "enumDescriptions": [ + "Matches any status of the instances, running, non-running and others.", + "Instance is in RUNNING state if it is running." + ], + "type": "string" + }, + "portName": { + "description": "Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + } + }, + "type": "object" + }, + "RegionInstanceGroupsSetNamedPortsRequest": { + "id": "RegionInstanceGroupsSetNamedPortsRequest", + "properties": { + "fingerprint": { + "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.", + "format": "byte", + "type": "string" + }, + "namedPorts": { + "description": "The list of named ports to set for this instance group.", "items": { - "type": "string" + "$ref": "NamedPort" }, "type": "array" } }, "type": "object" }, - "RegionInstanceGroupManagerList": { - "description": "Contains a list of managed instance groups.", - "id": "RegionInstanceGroupManagerList", + "RegionList": { + "description": "Contains a list of region resources.", + "id": "RegionList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of InstanceGroupManager resources.", + "description": "A list of Region resources.", "items": { - "$ref": "InstanceGroupManager" + "$ref": "Region" }, "type": "array" }, "kind": { - "default": "compute#regionInstanceGroupManagerList", - "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.", + "default": "compute#regionList", + "description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.", "type": "string" }, "nextPageToken": { @@ -64920,39 +66945,134 @@ }, "type": "object" }, - "RegionInstanceGroupManagerPatchInstanceConfigReq": { - "description": "RegionInstanceGroupManagers.patchPerInstanceConfigs", - "id": "RegionInstanceGroupManagerPatchInstanceConfigReq", + "RegionNetworkEndpointGroupsAttachEndpointsRequest": { + "id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", "properties": { - "perInstanceConfigs": { - "description": "The list of per-instance configurations to insert or patch on this managed instance group.", + "networkEndpoints": { + "description": "The list of network endpoints to be attached.", "items": { - "$ref": "PerInstanceConfig" + "$ref": "NetworkEndpoint" }, "type": "array" } }, "type": "object" }, - "RegionInstanceGroupManagerUpdateInstanceConfigReq": { - "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs", - "id": "RegionInstanceGroupManagerUpdateInstanceConfigReq", + "RegionNetworkEndpointGroupsDetachEndpointsRequest": { + "id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", "properties": { - "perInstanceConfigs": { - "description": "The list of per-instance configurations to insert or patch on this managed instance group.", + "networkEndpoints": { + "description": "The list of network endpoints to be detached.", "items": { - "$ref": "PerInstanceConfig" + "$ref": "NetworkEndpoint" }, "type": "array" } }, "type": "object" }, - "RegionInstanceGroupManagersAbandonInstancesRequest": { - "id": "RegionInstanceGroupManagersAbandonInstancesRequest", + "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { + "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", "properties": { - "instances": { - "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "firewallPolicys": { + "description": "Effective firewalls from firewall policy.", + "items": { + "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" + }, + "type": "array" + }, + "firewalls": { + "description": "Effective firewalls on the network.", + "items": { + "$ref": "Firewall" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { + "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", + "properties": { + "displayName": { + "description": "[Output Only] The display name of the firewall policy.", + "type": "string" + }, + "name": { + "description": "[Output Only] The name of the firewall policy.", + "type": "string" + }, + "rules": { + "description": "The rules that apply to the network.", + "items": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" + }, + "type": { + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", + "enum": [ + "HIERARCHY", + "NETWORK", + "NETWORK_REGIONAL", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "RegionSetLabelsRequest": { + "id": "RegionSetLabelsRequest", + "properties": { + "labelFingerprint": { + "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels to set for this resource.", + "type": "object" + } + }, + "type": "object" + }, + "RegionSetPolicyRequest": { + "id": "RegionSetPolicyRequest", + "properties": { + "bindings": { + "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", + "format": "byte", + "type": "string" + }, + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them." + } + }, + "type": "object" + }, + "RegionTargetHttpsProxiesSetSslCertificatesRequest": { + "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", + "properties": { + "sslCertificates": { + "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource.", "items": { "type": "string" }, @@ -64961,118 +67081,193 @@ }, "type": "object" }, - "RegionInstanceGroupManagersApplyUpdatesRequest": { - "description": "RegionInstanceGroupManagers.applyUpdatesToInstances", - "id": "RegionInstanceGroupManagersApplyUpdatesRequest", + "RegionUrlMapsValidateRequest": { + "id": "RegionUrlMapsValidateRequest", "properties": { - "allInstances": { - "description": "Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.", + "resource": { + "$ref": "UrlMap", + "description": "Content of the UrlMap to be validated." + } + }, + "type": "object" + }, + "RequestMirrorPolicy": { + "description": "A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow.", + "id": "RequestMirrorPolicy", + "properties": { + "backendService": { + "description": "The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. ", + "type": "string" + } + }, + "type": "object" + }, + "Reservation": { + "description": "Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.", + "id": "Reservation", + "properties": { + "aggregateReservation": { + "$ref": "AllocationAggregateReservation", + "description": "Reservation for aggregated resources, providing shape flexibility." + }, + "commitment": { + "description": "[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.", + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#reservation", + "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.instances.insert" + ] + }, + "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "resourcePolicies": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.", + "type": "object" + }, + "resourceStatus": { + "$ref": "AllocationResourceStatus", + "description": "[Output Only] Status information for Reservation resource." + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", "type": "boolean" }, - "instances": { - "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", - "items": { - "type": "string" - }, - "type": "array" + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "shareSettings": { + "$ref": "ShareSettings", + "description": "Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation." }, - "minimalAction": { - "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.", + "specificReservation": { + "$ref": "AllocationSpecificSKUReservation", + "description": "Reservation for instances with specific machine shapes." + }, + "specificReservationRequired": { + "description": "Indicates whether the reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.", + "type": "boolean" + }, + "status": { + "description": "[Output Only] The status of the reservation.", "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" + "CREATING", + "DELETING", + "INVALID", + "READY", + "UPDATING" ], "enumDescriptions": [ - "Do not perform any action.", - "Do not stop the instance.", - "(Default.) Replace the instance according to the replacement method option.", - "Stop the instance and start it again." + "Resources are being allocated for the reservation.", + "Reservation is currently being deleted.", + "", + "Reservation has allocated all its resources.", + "Reservation is currently being resized." ], "type": "string" }, - "mostDisruptiveAllowedAction": { - "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.", - "enum": [ - "NONE", - "REFRESH", - "REPLACE", - "RESTART" - ], - "enumDescriptions": [ - "Do not perform any action.", - "Do not stop the instance.", - "(Default.) Replace the instance according to the replacement method option.", - "Stop the instance and start it again." - ], + "zone": { + "description": "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.", "type": "string" } }, "type": "object" }, - "RegionInstanceGroupManagersCreateInstancesRequest": { - "description": "RegionInstanceGroupManagers.createInstances", - "id": "RegionInstanceGroupManagersCreateInstancesRequest", - "properties": { - "instances": { - "description": "[Required] List of specifications of per-instance configs.", - "items": { - "$ref": "PerInstanceConfig" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionInstanceGroupManagersDeleteInstancesRequest": { - "id": "RegionInstanceGroupManagersDeleteInstancesRequest", + "ReservationAffinity": { + "description": "Specifies the reservations that this instance can consume from.", + "id": "ReservationAffinity", "properties": { - "instances": { - "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "consumeReservationType": { + "description": "Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.", + "enum": [ + "ANY_RESERVATION", + "NO_RESERVATION", + "SPECIFIC_RESERVATION", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Consume any allocation available.", + "Do not consume from any allocated capacity.", + "Must consume from a specific reservation. Must specify key value fields for specifying the reservations.", + "" + ], + "type": "string" + }, + "key": { + "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.", + "type": "string" + }, + "values": { + "description": "Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or \"projects/different-project/reservations/some-reservation-name\" to target a shared reservation in the same zone but in a different project.", "items": { "type": "string" }, "type": "array" - }, - "skipInstancesOnValidationError": { - "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.", - "type": "boolean" } }, "type": "object" }, - "RegionInstanceGroupManagersListErrorsResponse": { - "id": "RegionInstanceGroupManagersListErrorsResponse", + "ReservationAggregatedList": { + "description": "Contains a list of reservations.", + "id": "ReservationAggregatedList", "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, "items": { - "description": "[Output Only] The list of errors of the managed instance group.", - "items": { - "$ref": "InstanceManagedByIgmError" + "additionalProperties": { + "$ref": "ReservationsScopedList", + "description": "Name of the scope containing this set of reservations." }, - "type": "array" + "description": "A list of Allocation resources.", + "type": "object" + }, + "kind": { + "default": "compute#reservationAggregatedList", + "description": "Type of resource.", + "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" - } - }, - "type": "object" - }, - "RegionInstanceGroupManagersListInstanceConfigsResp": { - "id": "RegionInstanceGroupManagersListInstanceConfigsResp", - "properties": { - "items": { - "description": "[Output Only] The list of PerInstanceConfig.", + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", "items": { - "$ref": "PerInstanceConfig" + "type": "string" }, "type": "array" }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -65197,81 +67392,23 @@ }, "type": "object" }, - "RegionInstanceGroupManagersListInstancesResponse": { - "id": "RegionInstanceGroupManagersListInstancesResponse", - "properties": { - "managedInstances": { - "description": "A list of managed instances.", - "items": { - "$ref": "ManagedInstance" - }, - "type": "array" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - } - }, - "type": "object" - }, - "RegionInstanceGroupManagersRecreateRequest": { - "id": "RegionInstanceGroupManagersRecreateRequest", - "properties": { - "instances": { - "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionInstanceGroupManagersSetTargetPoolsRequest": { - "id": "RegionInstanceGroupManagersSetTargetPoolsRequest", - "properties": { - "fingerprint": { - "description": "Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.", - "format": "byte", - "type": "string" - }, - "targetPools": { - "description": "The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionInstanceGroupManagersSetTemplateRequest": { - "id": "RegionInstanceGroupManagersSetTemplateRequest", - "properties": { - "instanceTemplate": { - "description": "URL of the InstanceTemplate resource from which all new instances will be created.", - "type": "string" - } - }, - "type": "object" - }, - "RegionInstanceGroupsListInstances": { - "id": "RegionInstanceGroupsListInstances", + "ReservationList": { + "id": "ReservationList", "properties": { "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "items": { - "description": "A list of InstanceWithNamedPorts resources.", + "description": "[Output Only] A list of Allocation resources.", "items": { - "$ref": "InstanceWithNamedPorts" + "$ref": "Reservation" }, "type": "array" }, "kind": { - "default": "compute#regionInstanceGroupsListInstances", - "description": "The resource type.", + "default": "compute#reservationList", + "description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations", "type": "string" }, "nextPageToken": { @@ -65406,77 +67543,29 @@ }, "type": "object" }, - "RegionInstanceGroupsListInstancesRequest": { - "id": "RegionInstanceGroupsListInstancesRequest", - "properties": { - "instanceState": { - "description": "Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.", - "enum": [ - "ALL", - "RUNNING" - ], - "enumDescriptions": [ - "Matches any status of the instances, running, non-running and others.", - "Instance is in RUNNING state if it is running." - ], - "type": "string" - }, - "portName": { - "description": "Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - } - }, - "type": "object" - }, - "RegionInstanceGroupsSetNamedPortsRequest": { - "id": "RegionInstanceGroupsSetNamedPortsRequest", + "ReservationsResizeRequest": { + "id": "ReservationsResizeRequest", "properties": { - "fingerprint": { - "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.", - "format": "byte", + "specificSkuCount": { + "description": "Number of allocated resources can be resized with minimum = 1 and maximum = 1000.", + "format": "int64", "type": "string" - }, - "namedPorts": { - "description": "The list of named ports to set for this instance group.", - "items": { - "$ref": "NamedPort" - }, - "type": "array" } }, "type": "object" }, - "RegionList": { - "description": "Contains a list of region resources.", - "id": "RegionList", + "ReservationsScopedList": { + "id": "ReservationsScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of Region resources.", + "reservations": { + "description": "A list of reservations contained in this scope.", "items": { - "$ref": "Region" + "$ref": "Reservation" }, "type": "array" }, - "kind": { - "default": "compute#regionList", - "description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "Informational warning which replaces the list of reservations when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -65593,337 +67682,68 @@ "description": "[Output Only] A human-readable description of the warning code.", "type": "string" } - }, - "type": "object" - } - }, - "type": "object" - }, - "RegionNetworkEndpointGroupsAttachEndpointsRequest": { - "id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be attached.", - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionNetworkEndpointGroupsDetachEndpointsRequest": { - "id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be detached.", - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { - "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", - "properties": { - "firewallPolicys": { - "description": "Effective firewalls from firewall policy.", - "items": { - "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" - }, - "type": "array" - }, - "firewalls": { - "description": "Effective firewalls on the network.", - "items": { - "$ref": "Firewall" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { - "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", - "properties": { - "displayName": { - "description": "[Output Only] The display name of the firewall policy.", - "type": "string" - }, - "name": { - "description": "[Output Only] The name of the firewall policy.", - "type": "string" - }, - "rules": { - "description": "The rules that apply to the network.", - "items": { - "$ref": "FirewallPolicyRule" - }, - "type": "array" - }, - "type": { - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", - "enum": [ - "HIERARCHY", - "NETWORK", - "NETWORK_REGIONAL", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "RegionSetLabelsRequest": { - "id": "RegionSetLabelsRequest", - "properties": { - "labelFingerprint": { - "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", - "format": "byte", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "The labels to set for this resource.", - "type": "object" - } - }, - "type": "object" - }, - "RegionSetPolicyRequest": { - "id": "RegionSetPolicyRequest", - "properties": { - "bindings": { - "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "etag": { - "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", - "format": "byte", - "type": "string" - }, - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them." - } - }, - "type": "object" - }, - "RegionTargetHttpsProxiesSetSslCertificatesRequest": { - "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", - "properties": { - "sslCertificates": { - "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionUrlMapsValidateRequest": { - "id": "RegionUrlMapsValidateRequest", - "properties": { - "resource": { - "$ref": "UrlMap", - "description": "Content of the UrlMap to be validated." - } - }, - "type": "object" - }, - "RequestMirrorPolicy": { - "description": "A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow.", - "id": "RequestMirrorPolicy", - "properties": { - "backendService": { - "description": "The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. ", - "type": "string" - } - }, - "type": "object" - }, - "Reservation": { - "description": "Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.", - "id": "Reservation", - "properties": { - "aggregateReservation": { - "$ref": "AllocationAggregateReservation", - "description": "Reservation for aggregated resources, providing shape flexibility." - }, - "commitment": { - "description": "[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.", - "type": "string" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#reservation", - "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", - "type": "string" - }, - "name": { - "annotations": { - "required": [ - "compute.instances.insert" - ] - }, - "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "resourcePolicies": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.", - "type": "object" - }, - "resourceStatus": { - "$ref": "AllocationResourceStatus", - "description": "[Output Only] Status information for Reservation resource." - }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" - }, - "selfLink": { - "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + }, + "type": "object" + } + }, + "type": "object" + }, + "ResourceCommitment": { + "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", + "id": "ResourceCommitment", + "properties": { + "acceleratorType": { + "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", "type": "string" }, - "shareSettings": { - "$ref": "ShareSettings", - "description": "Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation." - }, - "specificReservation": { - "$ref": "AllocationSpecificSKUReservation", - "description": "Reservation for instances with specific machine shapes." - }, - "specificReservationRequired": { - "description": "Indicates whether the reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.", - "type": "boolean" + "amount": { + "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", + "format": "int64", + "type": "string" }, - "status": { - "description": "[Output Only] The status of the reservation.", + "type": { + "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", "enum": [ - "CREATING", - "DELETING", - "INVALID", - "READY", - "UPDATING" + "ACCELERATOR", + "LOCAL_SSD", + "MEMORY", + "UNSPECIFIED", + "VCPU" ], "enumDescriptions": [ - "Resources are being allocated for the reservation.", - "Reservation is currently being deleted.", "", - "Reservation has allocated all its resources.", - "Reservation is currently being resized." + "", + "", + "", + "" ], "type": "string" - }, - "zone": { - "description": "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.", - "type": "string" } }, "type": "object" }, - "ReservationAffinity": { - "description": "Specifies the reservations that this instance can consume from.", - "id": "ReservationAffinity", + "ResourceGroupReference": { + "id": "ResourceGroupReference", "properties": { - "consumeReservationType": { - "description": "Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.", - "enum": [ - "ANY_RESERVATION", - "NO_RESERVATION", - "SPECIFIC_RESERVATION", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "Consume any allocation available.", - "Do not consume from any allocated capacity.", - "Must consume from a specific reservation. Must specify key value fields for specifying the reservations.", - "" - ], - "type": "string" - }, - "key": { - "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.", + "group": { + "description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service.", "type": "string" - }, - "values": { - "description": "Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or \"projects/different-project/reservations/some-reservation-name\" to target a shared reservation in the same zone but in a different project.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "ReservationAggregatedList": { - "description": "Contains a list of reservations.", - "id": "ReservationAggregatedList", + "ResourcePoliciesScopedList": { + "id": "ResourcePoliciesScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "additionalProperties": { - "$ref": "ReservationsScopedList", - "description": "Name of the scope containing this set of reservations." - }, - "description": "A list of Allocation resources.", - "type": "object" - }, - "kind": { - "default": "compute#reservationAggregatedList", - "description": "Type of resource.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", + "resourcePolicies": { + "description": "A list of resourcePolicies contained in this scope.", "items": { - "type": "string" + "$ref": "ResourcePolicy" }, "type": "array" }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "Informational warning which replaces the list of resourcePolicies when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -66046,23 +67866,107 @@ }, "type": "object" }, - "ReservationList": { - "id": "ReservationList", + "ResourcePolicy": { + "description": "Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.", + "id": "ResourcePolicy", "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "type": "string" + }, + "diskConsistencyGroupPolicy": { + "$ref": "ResourcePolicyDiskConsistencyGroupPolicy", + "description": "Resource policy for disk consistency groups." + }, + "groupPlacementPolicy": { + "$ref": "ResourcePolicyGroupPlacementPolicy", + "description": "Resource policy for instances for placement configuration." + }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "instanceSchedulePolicy": { + "$ref": "ResourcePolicyInstanceSchedulePolicy", + "description": "Resource policy for scheduling instance operations." + }, + "kind": { + "default": "compute#resourcePolicy", + "description": "[Output Only] Type of the resource. Always compute#resource_policies for resource policies.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.instances.insert" + ] + }, + "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "region": { + "type": "string" + }, + "resourceStatus": { + "$ref": "ResourcePolicyResourceStatus", + "description": "[Output Only] The system status of the resource policy." + }, + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "snapshotSchedulePolicy": { + "$ref": "ResourcePolicySnapshotSchedulePolicy", + "description": "Resource policy for persistent disks for creating snapshots." + }, + "status": { + "description": "[Output Only] The status of resource policy creation.", + "enum": [ + "CREATING", + "DELETING", + "EXPIRED", + "INVALID", + "READY" + ], + "enumDescriptions": [ + "Resource policy is being created.", + "Resource policy is being deleted.", + "Resource policy is expired and will not run again.", + "", + "Resource policy is ready to be used." + ], + "type": "string" + } + }, + "type": "object" + }, + "ResourcePolicyAggregatedList": { + "description": "Contains a list of resourcePolicies.", + "id": "ResourcePolicyAggregatedList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "[Output Only] A list of Allocation resources.", - "items": { - "$ref": "Reservation" + "additionalProperties": { + "$ref": "ResourcePoliciesScopedList", + "description": "Name of the scope containing this set of resourcePolicies." }, - "type": "array" + "description": "A list of ResourcePolicy resources.", + "type": "object" }, "kind": { - "default": "compute#reservationList", - "description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations", + "default": "compute#resourcePolicyAggregatedList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { @@ -66073,6 +67977,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -66197,29 +68108,151 @@ }, "type": "object" }, - "ReservationsResizeRequest": { - "id": "ReservationsResizeRequest", + "ResourcePolicyDailyCycle": { + "description": "Time window specified for daily operations.", + "id": "ResourcePolicyDailyCycle", "properties": { - "specificSkuCount": { - "description": "Number of allocated resources can be resized with minimum = 1 and maximum = 1000.", - "format": "int64", + "daysInCycle": { + "description": "Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle.", + "format": "int32", + "type": "integer" + }, + "duration": { + "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.", + "type": "string" + }, + "startTime": { + "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.", "type": "string" } }, "type": "object" }, - "ReservationsScopedList": { - "id": "ReservationsScopedList", + "ResourcePolicyDiskConsistencyGroupPolicy": { + "description": "Resource policy for disk consistency groups.", + "id": "ResourcePolicyDiskConsistencyGroupPolicy", + "properties": {}, + "type": "object" + }, + "ResourcePolicyGroupPlacementPolicy": { + "description": "A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality", + "id": "ResourcePolicyGroupPlacementPolicy", "properties": { - "reservations": { - "description": "A list of reservations contained in this scope.", + "availabilityDomainCount": { + "description": "The number of availability domains to spread instances across. If two instances are in different availability domain, they are not in the same low latency network.", + "format": "int32", + "type": "integer" + }, + "collocation": { + "description": "Specifies network collocation", + "enum": [ + "COLLOCATED", + "UNSPECIFIED_COLLOCATION" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "vmCount": { + "description": "Number of VMs in this placement group. Google does not recommend that you use this field unless you use a compact policy and you want your policy to work only if it contains this exact number of VMs.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ResourcePolicyHourlyCycle": { + "description": "Time window specified for hourly operations.", + "id": "ResourcePolicyHourlyCycle", + "properties": { + "duration": { + "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", + "type": "string" + }, + "hoursInCycle": { + "description": "Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.", + "format": "int32", + "type": "integer" + }, + "startTime": { + "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.", + "type": "string" + } + }, + "type": "object" + }, + "ResourcePolicyInstanceSchedulePolicy": { + "description": "An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance.", + "id": "ResourcePolicyInstanceSchedulePolicy", + "properties": { + "expirationTime": { + "description": "The expiration time of the schedule. The timestamp is an RFC3339 string.", + "type": "string" + }, + "startTime": { + "description": "The start time of the schedule. The timestamp is an RFC3339 string.", + "type": "string" + }, + "timeZone": { + "description": "Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: https://wikipedia.org/wiki/Tz_database.", + "type": "string" + }, + "vmStartSchedule": { + "$ref": "ResourcePolicyInstanceSchedulePolicySchedule", + "description": "Specifies the schedule for starting instances." + }, + "vmStopSchedule": { + "$ref": "ResourcePolicyInstanceSchedulePolicySchedule", + "description": "Specifies the schedule for stopping instances." + } + }, + "type": "object" + }, + "ResourcePolicyInstanceSchedulePolicySchedule": { + "description": "Schedule for an instance operation.", + "id": "ResourcePolicyInstanceSchedulePolicySchedule", + "properties": { + "schedule": { + "description": "Specifies the frequency for the operation, using the unix-cron format.", + "type": "string" + } + }, + "type": "object" + }, + "ResourcePolicyList": { + "id": "ResourcePolicyList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "type": "string" + }, + "items": { + "description": "[Output Only] A list of ResourcePolicy resources.", "items": { - "$ref": "Reservation" + "$ref": "ResourcePolicy" }, "type": "array" }, + "kind": { + "default": "compute#resourcePolicyList", + "description": "[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, "warning": { - "description": "Informational warning which replaces the list of reservations when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -66342,29 +68375,154 @@ }, "type": "object" }, - "ResourceCommitment": { - "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", - "id": "ResourceCommitment", + "ResourcePolicyResourceStatus": { + "description": "Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this \"status\" field should mimic the structure of ResourcePolicy proto specification.", + "id": "ResourcePolicyResourceStatus", "properties": { - "acceleratorType": { - "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", + "instanceSchedulePolicy": { + "$ref": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus", + "description": "[Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field." + } + }, + "type": "object" + }, + "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus": { + "id": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus", + "properties": { + "lastRunStartTime": { + "description": "[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.", "type": "string" }, - "amount": { - "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", - "format": "int64", + "nextRunStartTime": { + "description": "[Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.", "type": "string" + } + }, + "type": "object" + }, + "ResourcePolicySnapshotSchedulePolicy": { + "description": "A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.", + "id": "ResourcePolicySnapshotSchedulePolicy", + "properties": { + "retentionPolicy": { + "$ref": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy", + "description": "Retention policy applied to snapshots created by this resource policy." }, - "type": { - "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", + "schedule": { + "$ref": "ResourcePolicySnapshotSchedulePolicySchedule", + "description": "A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy." + }, + "snapshotProperties": { + "$ref": "ResourcePolicySnapshotSchedulePolicySnapshotProperties", + "description": "Properties with which snapshots are created such as labels, encryption keys." + } + }, + "type": "object" + }, + "ResourcePolicySnapshotSchedulePolicyRetentionPolicy": { + "description": "Policy for retention of scheduled snapshots.", + "id": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy", + "properties": { + "maxRetentionDays": { + "description": "Maximum age of the snapshot that is allowed to be kept.", + "format": "int32", + "type": "integer" + }, + "onSourceDiskDelete": { + "description": "Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.", + "enum": [ + "APPLY_RETENTION_POLICY", + "KEEP_AUTO_SNAPSHOTS", + "UNSPECIFIED_ON_SOURCE_DISK_DELETE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "ResourcePolicySnapshotSchedulePolicySchedule": { + "description": "A schedule for disks where the schedueled operations are performed.", + "id": "ResourcePolicySnapshotSchedulePolicySchedule", + "properties": { + "dailySchedule": { + "$ref": "ResourcePolicyDailyCycle" + }, + "hourlySchedule": { + "$ref": "ResourcePolicyHourlyCycle" + }, + "weeklySchedule": { + "$ref": "ResourcePolicyWeeklyCycle" + } + }, + "type": "object" + }, + "ResourcePolicySnapshotSchedulePolicySnapshotProperties": { + "description": "Specified snapshot properties for scheduled snapshots created by this policy.", + "id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties", + "properties": { + "chainName": { + "description": "Chain name that the snapshot is created in.", + "type": "string" + }, + "guestFlush": { + "description": "Indication to perform a 'guest aware' snapshot.", + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.", + "type": "object" + }, + "storageLocations": { + "description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResourcePolicyWeeklyCycle": { + "description": "Time window specified for weekly operations.", + "id": "ResourcePolicyWeeklyCycle", + "properties": { + "dayOfWeeks": { + "description": "Up to 7 intervals/windows, one for each day of the week.", + "items": { + "$ref": "ResourcePolicyWeeklyCycleDayOfWeek" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResourcePolicyWeeklyCycleDayOfWeek": { + "id": "ResourcePolicyWeeklyCycleDayOfWeek", + "properties": { + "day": { + "description": "Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.", "enum": [ - "ACCELERATOR", - "LOCAL_SSD", - "MEMORY", - "UNSPECIFIED", - "VCPU" + "FRIDAY", + "INVALID", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" ], "enumDescriptions": [ + "", + "", + "", "", "", "", @@ -66372,254 +68530,353 @@ "" ], "type": "string" + }, + "duration": { + "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", + "type": "string" + }, + "startTime": { + "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.", + "type": "string" } }, "type": "object" }, - "ResourceGroupReference": { - "id": "ResourceGroupReference", + "ResourceStatus": { + "description": "Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.", + "id": "ResourceStatus", "properties": { - "group": { - "description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service.", + "physicalHost": { + "description": "[Output Only] An opaque ID of the host on which the VM is running.", "type": "string" + }, + "upcomingMaintenance": { + "$ref": "UpcomingMaintenance" } }, "type": "object" }, - "ResourcePoliciesScopedList": { - "id": "ResourcePoliciesScopedList", + "Route": { + "description": "Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.", + "id": "Route", "properties": { - "resourcePolicies": { - "description": "A list of resourcePolicies contained in this scope.", + "asPaths": { + "description": "[Output Only] AS path.", "items": { - "$ref": "ResourcePolicy" + "$ref": "RouteAsPath" }, "type": "array" }, - "warning": { - "description": "Informational warning which replaces the list of resourcePolicies when the list is empty.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ResourcePolicy": { - "description": "Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.", - "id": "ResourcePolicy", - "properties": { "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "description": { + "description": "An optional description of this resource. Provide this field when you create the resource.", "type": "string" }, - "diskConsistencyGroupPolicy": { - "$ref": "ResourcePolicyDiskConsistencyGroupPolicy", - "description": "Resource policy for disk consistency groups." - }, - "groupPlacementPolicy": { - "$ref": "ResourcePolicyGroupPlacementPolicy", - "description": "Resource policy for instances for placement configuration." + "destRange": { + "annotations": { + "required": [ + "compute.routes.insert" + ] + }, + "description": "The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.", + "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", "type": "string" }, - "instanceSchedulePolicy": { - "$ref": "ResourcePolicyInstanceSchedulePolicy", - "description": "Resource policy for scheduling instance operations." - }, "kind": { - "default": "compute#resourcePolicy", - "description": "[Output Only] Type of the resource. Always compute#resource_policies for resource policies.", + "default": "compute#route", + "description": "[Output Only] Type of this resource. Always compute#routes for Route resources.", "type": "string" }, "name": { "annotations": { "required": [ - "compute.instances.insert" + "compute.routes.insert" ] }, - "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "region": { + "network": { + "annotations": { + "required": [ + "compute.routes.insert" + ] + }, + "description": "Fully-qualified URL of the network that this route applies to.", "type": "string" }, - "resourceStatus": { - "$ref": "ResourcePolicyResourceStatus", - "description": "[Output Only] The system status of the resource policy." + "nextHopGateway": { + "description": "The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway", + "type": "string" + }, + "nextHopHub": { + "description": "[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.", + "type": "string" + }, + "nextHopIlb": { + "description": "The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule ", + "type": "string" + }, + "nextHopInstance": { + "description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/", + "type": "string" + }, + "nextHopIp": { + "description": "The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.", + "type": "string" + }, + "nextHopNetwork": { + "description": "The URL of the local network if it should handle matching packets.", + "type": "string" + }, + "nextHopPeering": { + "description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.", + "type": "string" + }, + "nextHopVpnTunnel": { + "description": "The URL to a VpnTunnel that should handle matching packets.", + "type": "string" + }, + "priority": { + "annotations": { + "required": [ + "compute.routes.insert" + ] + }, + "description": "The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.", + "format": "uint32", + "type": "integer" + }, + "routeStatus": { + "description": "[Output only] The status of the route.", + "enum": [ + "ACTIVE", + "DROPPED", + "INACTIVE", + "PENDING" + ], + "enumDescriptions": [ + "This route is processed and active.", + "The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example", + "This route is processed but inactive due to failure from the backend. The backend may have rejected the route", + "This route is being processed internally. The status will change once processed." + ], + "type": "string" + }, + "routeType": { + "description": "[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route", + "enum": [ + "BGP", + "STATIC", + "SUBNET", + "TRANSIT" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" }, - "snapshotSchedulePolicy": { - "$ref": "ResourcePolicySnapshotSchedulePolicy", - "description": "Resource policy for persistent disks for creating snapshots." + "tags": { + "annotations": { + "required": [ + "compute.routes.insert" + ] + }, + "description": "A list of instance tags to which this route applies.", + "items": { + "type": "string" + }, + "type": "array" }, - "status": { - "description": "[Output Only] The status of resource policy creation.", + "warnings": { + "description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.", + "items": { + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "RouteAsPath": { + "id": "RouteAsPath", + "properties": { + "asLists": { + "description": "[Output Only] The AS numbers of the AS Path.", + "items": { + "format": "uint32", + "type": "integer" + }, + "type": "array" + }, + "pathSegmentType": { + "description": "[Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed ", "enum": [ - "CREATING", - "DELETING", - "EXPIRED", - "INVALID", - "READY" + "AS_CONFED_SEQUENCE", + "AS_CONFED_SET", + "AS_SEQUENCE", + "AS_SET" ], "enumDescriptions": [ - "Resource policy is being created.", - "Resource policy is being deleted.", - "Resource policy is expired and will not run again.", "", - "Resource policy is ready to be used." + "", + "", + "" ], "type": "string" } }, "type": "object" }, - "ResourcePolicyAggregatedList": { - "description": "Contains a list of resourcePolicies.", - "id": "ResourcePolicyAggregatedList", + "RouteList": { + "description": "Contains a list of Route resources.", + "id": "RouteList", "properties": { - "etag": { - "type": "string" - }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "ResourcePoliciesScopedList", - "description": "Name of the scope containing this set of resourcePolicies." + "description": "A list of Route resources.", + "items": { + "$ref": "Route" }, - "description": "A list of ResourcePolicy resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#resourcePolicyAggregatedList", + "default": "compute#routeList", "description": "Type of resource.", "type": "string" }, @@ -66631,13 +68888,6 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -66753,148 +69003,138 @@ "type": "array" }, "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ResourcePolicyDailyCycle": { - "description": "Time window specified for daily operations.", - "id": "ResourcePolicyDailyCycle", - "properties": { - "daysInCycle": { - "description": "Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle.", - "format": "int32", - "type": "integer" - }, - "duration": { - "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.", - "type": "string" - }, - "startTime": { - "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.", - "type": "string" + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "ResourcePolicyDiskConsistencyGroupPolicy": { - "description": "Resource policy for disk consistency groups.", - "id": "ResourcePolicyDiskConsistencyGroupPolicy", - "properties": {}, - "type": "object" - }, - "ResourcePolicyGroupPlacementPolicy": { - "description": "A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality", - "id": "ResourcePolicyGroupPlacementPolicy", + "Router": { + "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.", + "id": "Router", "properties": { - "availabilityDomainCount": { - "description": "The number of availability domains to spread instances across. If two instances are in different availability domain, they are not in the same low latency network.", - "format": "int32", - "type": "integer" + "bgp": { + "$ref": "RouterBgp", + "description": "BGP information specific to this router." }, - "collocation": { - "description": "Specifies network collocation", - "enum": [ - "COLLOCATED", - "UNSPECIFIED_COLLOCATION" - ], - "enumDescriptions": [ - "", - "" - ], + "bgpPeers": { + "description": "BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.", + "items": { + "$ref": "RouterBgpPeer" + }, + "type": "array" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "vmCount": { - "description": "Number of VMs in this placement group. Google does not recommend that you use this field unless you use a compact policy and you want your policy to work only if it contains this exact number of VMs.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ResourcePolicyHourlyCycle": { - "description": "Time window specified for hourly operations.", - "id": "ResourcePolicyHourlyCycle", - "properties": { - "duration": { - "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "hoursInCycle": { - "description": "Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.", - "format": "int32", - "type": "integer" + "encryptedInterconnectRouter": { + "description": "Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).", + "type": "boolean" }, - "startTime": { - "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.", + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", "type": "string" - } - }, - "type": "object" - }, - "ResourcePolicyInstanceSchedulePolicy": { - "description": "An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance.", - "id": "ResourcePolicyInstanceSchedulePolicy", - "properties": { - "expirationTime": { - "description": "The expiration time of the schedule. The timestamp is an RFC3339 string.", + }, + "interfaces": { + "description": "Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.", + "items": { + "$ref": "RouterInterface" + }, + "type": "array" + }, + "kind": { + "default": "compute#router", + "description": "[Output Only] Type of resource. Always compute#router for routers.", "type": "string" }, - "startTime": { - "description": "The start time of the schedule. The timestamp is an RFC3339 string.", + "md5AuthenticationKeys": { + "description": "Keys used for MD5 authentication.", + "items": { + "$ref": "RouterMd5AuthenticationKey" + }, + "type": "array" + }, + "name": { + "annotations": { + "required": [ + "compute.routers.insert" + ] + }, + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "timeZone": { - "description": "Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: https://wikipedia.org/wiki/Tz_database.", + "nats": { + "description": "A list of NAT services created in this router.", + "items": { + "$ref": "RouterNat" + }, + "type": "array" + }, + "network": { + "annotations": { + "required": [ + "compute.routers.insert", + "compute.routers.update" + ] + }, + "description": "URI of the network to which this router belongs.", "type": "string" }, - "vmStartSchedule": { - "$ref": "ResourcePolicyInstanceSchedulePolicySchedule", - "description": "Specifies the schedule for starting instances." + "region": { + "description": "[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" }, - "vmStopSchedule": { - "$ref": "ResourcePolicyInstanceSchedulePolicySchedule", - "description": "Specifies the schedule for stopping instances." + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" } }, "type": "object" }, - "ResourcePolicyInstanceSchedulePolicySchedule": { - "description": "Schedule for an instance operation.", - "id": "ResourcePolicyInstanceSchedulePolicySchedule", + "RouterAdvertisedIpRange": { + "description": "Description-tagged IP ranges for the router to advertise.", + "id": "RouterAdvertisedIpRange", "properties": { - "schedule": { - "description": "Specifies the frequency for the operation, using the unix-cron format.", + "description": { + "description": "User-specified description for the IP range.", + "type": "string" + }, + "range": { + "description": "The IP range to advertise. The value must be a CIDR-formatted string.", "type": "string" } }, "type": "object" }, - "ResourcePolicyList": { - "id": "ResourcePolicyList", + "RouterAggregatedList": { + "description": "Contains a list of routers.", + "id": "RouterAggregatedList", "properties": { - "etag": { - "type": "string" - }, "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "[Output Only] A list of ResourcePolicy resources.", - "items": { - "$ref": "ResourcePolicy" + "additionalProperties": { + "$ref": "RoutersScopedList", + "description": "Name of the scope containing this set of routers." }, - "type": "array" + "description": "A list of Router resources.", + "type": "object" }, "kind": { - "default": "compute#resourcePolicyList", - "description": "[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies", + "default": "compute#routerAggregatedList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { @@ -66905,6 +69145,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -67029,785 +69276,1004 @@ }, "type": "object" }, - "ResourcePolicyResourceStatus": { - "description": "Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this \"status\" field should mimic the structure of ResourcePolicy proto specification.", - "id": "ResourcePolicyResourceStatus", - "properties": { - "instanceSchedulePolicy": { - "$ref": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus", - "description": "[Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field." - } - }, - "type": "object" - }, - "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus": { - "id": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus", + "RouterBgp": { + "id": "RouterBgp", "properties": { - "lastRunStartTime": { - "description": "[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.", + "advertiseMode": { + "description": "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.", + "enum": [ + "CUSTOM", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "" + ], "type": "string" }, - "nextRunStartTime": { - "description": "[Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.", - "type": "string" - } - }, - "type": "object" - }, - "ResourcePolicySnapshotSchedulePolicy": { - "description": "A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.", - "id": "ResourcePolicySnapshotSchedulePolicy", - "properties": { - "retentionPolicy": { - "$ref": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy", - "description": "Retention policy applied to snapshots created by this resource policy." + "advertisedGroups": { + "description": "User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.", + "items": { + "enum": [ + "ALL_SUBNETS" + ], + "enumDescriptions": [ + "Advertise all available subnets (including peer VPC subnets)." + ], + "type": "string" + }, + "type": "array" }, - "schedule": { - "$ref": "ResourcePolicySnapshotSchedulePolicySchedule", - "description": "A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy." + "advertisedIpRanges": { + "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.", + "items": { + "$ref": "RouterAdvertisedIpRange" + }, + "type": "array" }, - "snapshotProperties": { - "$ref": "ResourcePolicySnapshotSchedulePolicySnapshotProperties", - "description": "Properties with which snapshots are created such as labels, encryption keys." + "asn": { + "description": "Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.", + "format": "uint32", + "type": "integer" + }, + "keepaliveInterval": { + "description": "The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.", + "format": "uint32", + "type": "integer" } }, "type": "object" }, - "ResourcePolicySnapshotSchedulePolicyRetentionPolicy": { - "description": "Policy for retention of scheduled snapshots.", - "id": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy", + "RouterBgpPeer": { + "id": "RouterBgpPeer", "properties": { - "maxRetentionDays": { - "description": "Maximum age of the snapshot that is allowed to be kept.", + "advertiseMode": { + "description": "User-specified flag to indicate which mode to use for advertisement.", + "enum": [ + "CUSTOM", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "advertisedGroups": { + "description": "User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.", + "items": { + "enum": [ + "ALL_SUBNETS" + ], + "enumDescriptions": [ + "Advertise all available subnets (including peer VPC subnets)." + ], + "type": "string" + }, + "type": "array" + }, + "advertisedIpRanges": { + "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.", + "items": { + "$ref": "RouterAdvertisedIpRange" + }, + "type": "array" + }, + "advertisedRoutePriority": { + "description": "The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.", + "format": "uint32", + "type": "integer" + }, + "bfd": { + "$ref": "RouterBgpPeerBfd", + "description": "BFD configuration for the BGP peering." + }, + "customLearnedIpRanges": { + "description": "A list of user-defined custom learned route IP address ranges for a BGP session.", + "items": { + "$ref": "RouterBgpPeerCustomLearnedIpRange" + }, + "type": "array" + }, + "customLearnedRoutePriority": { + "description": "The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from `0` to `65335`. If you don't provide a value, Google Cloud assigns a priority of `100` to the ranges.", "format": "int32", "type": "integer" }, - "onSourceDiskDelete": { - "description": "Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.", + "enable": { + "description": "The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.", "enum": [ - "APPLY_RETENTION_POLICY", - "KEEP_AUTO_SNAPSHOTS", - "UNSPECIFIED_ON_SOURCE_DISK_DELETE" + "FALSE", + "TRUE" ], "enumDescriptions": [ - "", "", "" ], "type": "string" - } - }, - "type": "object" - }, - "ResourcePolicySnapshotSchedulePolicySchedule": { - "description": "A schedule for disks where the schedueled operations are performed.", - "id": "ResourcePolicySnapshotSchedulePolicySchedule", - "properties": { - "dailySchedule": { - "$ref": "ResourcePolicyDailyCycle" }, - "hourlySchedule": { - "$ref": "ResourcePolicyHourlyCycle" + "enableIpv6": { + "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.", + "type": "boolean" }, - "weeklySchedule": { - "$ref": "ResourcePolicyWeeklyCycle" + "interfaceName": { + "description": "Name of the interface the BGP peer is associated with.", + "type": "string" + }, + "ipAddress": { + "description": "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.", + "type": "string" + }, + "ipv6NexthopAddress": { + "description": "IPv6 address of the interface inside Google Cloud Platform.", + "type": "string" + }, + "managementType": { + "description": "[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. ", + "enum": [ + "MANAGED_BY_ATTACHMENT", + "MANAGED_BY_USER" + ], + "enumDescriptions": [ + "The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.", + "Default value, the BGP peer is manually created and managed by user." + ], + "type": "string" + }, + "md5AuthenticationKeyName": { + "description": "Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.routers.insert" + ] + }, + "description": "Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "peerAsn": { + "annotations": { + "required": [ + "compute.routers.insert" + ] + }, + "description": "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.", + "format": "uint32", + "type": "integer" + }, + "peerIpAddress": { + "description": "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.", + "type": "string" + }, + "peerIpv6NexthopAddress": { + "description": "IPv6 address of the BGP interface outside Google Cloud Platform.", + "type": "string" + }, + "routerApplianceInstance": { + "description": "URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.", + "type": "string" } }, "type": "object" }, - "ResourcePolicySnapshotSchedulePolicySnapshotProperties": { - "description": "Specified snapshot properties for scheduled snapshots created by this policy.", - "id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties", + "RouterBgpPeerBfd": { + "id": "RouterBgpPeerBfd", "properties": { - "chainName": { - "description": "Chain name that the snapshot is created in.", - "type": "string" + "minReceiveInterval": { + "description": "The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.", + "format": "uint32", + "type": "integer" }, - "guestFlush": { - "description": "Indication to perform a 'guest aware' snapshot.", - "type": "boolean" + "minTransmitInterval": { + "description": "The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.", + "format": "uint32", + "type": "integer" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.", - "type": "object" + "multiplier": { + "description": "The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.", + "format": "uint32", + "type": "integer" }, - "storageLocations": { - "description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).", - "items": { - "type": "string" - }, - "type": "array" + "sessionInitializationMode": { + "description": "The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.", + "enum": [ + "ACTIVE", + "DISABLED", + "PASSIVE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" } }, "type": "object" }, - "ResourcePolicyWeeklyCycle": { - "description": "Time window specified for weekly operations.", - "id": "ResourcePolicyWeeklyCycle", + "RouterBgpPeerCustomLearnedIpRange": { + "id": "RouterBgpPeerCustomLearnedIpRange", "properties": { - "dayOfWeeks": { - "description": "Up to 7 intervals/windows, one for each day of the week.", - "items": { - "$ref": "ResourcePolicyWeeklyCycleDayOfWeek" - }, - "type": "array" + "range": { + "description": "The custom learned route IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a `/32` singular IP address range, and, for IPv6, `/128`.", + "type": "string" } }, "type": "object" }, - "ResourcePolicyWeeklyCycleDayOfWeek": { - "id": "ResourcePolicyWeeklyCycleDayOfWeek", + "RouterInterface": { + "id": "RouterInterface", "properties": { - "day": { - "description": "Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.", + "ipRange": { + "description": "IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.", + "type": "string" + }, + "linkedInterconnectAttachment": { + "description": "URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.", + "type": "string" + }, + "linkedVpnTunnel": { + "description": "URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.", + "type": "string" + }, + "managementType": { + "description": "[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. ", "enum": [ - "FRIDAY", - "INVALID", - "MONDAY", - "SATURDAY", - "SUNDAY", - "THURSDAY", - "TUESDAY", - "WEDNESDAY" + "MANAGED_BY_ATTACHMENT", + "MANAGED_BY_USER" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "" + "The interface is automatically created for PARTNER type InterconnectAttachment, Google will automatically create/update/delete this interface when the PARTNER InterconnectAttachment is created/provisioned/deleted. This type of interface cannot be manually managed by user.", + "Default value, the interface is manually created and managed by user." ], "type": "string" }, - "duration": { - "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", + "name": { + "annotations": { + "required": [ + "compute.routers.insert" + ] + }, + "description": "Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "privateIpAddress": { + "description": "The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.", + "type": "string" + }, + "redundantInterface": { + "description": "Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "startTime": { - "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.", + "subnetwork": { + "description": "The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.", "type": "string" } }, "type": "object" }, - "ResourceStatus": { - "description": "Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.", - "id": "ResourceStatus", + "RouterList": { + "description": "Contains a list of Router resources.", + "id": "RouterList", "properties": { - "physicalHost": { - "description": "[Output Only] An opaque ID of the host on which the VM is running.", + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "upcomingMaintenance": { - "$ref": "UpcomingMaintenance" - } - }, - "type": "object" - }, - "Route": { - "description": "Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.", - "id": "Route", - "properties": { - "asPaths": { - "description": "[Output Only] AS path.", + "items": { + "description": "A list of Router resources.", "items": { - "$ref": "RouteAsPath" + "$ref": "Router" }, "type": "array" }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this field when you create the resource.", - "type": "string" - }, - "destRange": { - "annotations": { - "required": [ - "compute.routes.insert" - ] - }, - "description": "The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.", + "kind": { + "default": "compute#routerList", + "description": "[Output Only] Type of resource. Always compute#router for routers.", "type": "string" }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, - "kind": { - "default": "compute#route", - "description": "[Output Only] Type of this resource. Always compute#routes for Route resources.", + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "name": { + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "RouterMd5AuthenticationKey": { + "id": "RouterMd5AuthenticationKey", + "properties": { + "key": { "annotations": { "required": [ - "compute.routes.insert" + "compute.routers.insert" ] }, - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "[Input only] Value of the key. For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.", "type": "string" }, - "network": { + "name": { "annotations": { "required": [ - "compute.routes.insert" + "compute.routers.insert", + "compute.routers.update" ] }, - "description": "Fully-qualified URL of the network that this route applies to.", + "description": "Name used to identify the key. Must be unique within a router. Must be referenced by exactly one bgpPeer. Must comply with RFC1035.", "type": "string" - }, - "nextHopGateway": { - "description": "The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway", + } + }, + "type": "object" + }, + "RouterNat": { + "description": "Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.", + "id": "RouterNat", + "properties": { + "autoNetworkTier": { + "description": "The network tier to use when automatically reserving NAT IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, then the current project-level default tier is used.", + "enum": [ + "FIXED_STANDARD", + "PREMIUM", + "STANDARD", + "STANDARD_OVERRIDES_FIXED_STANDARD" + ], + "enumDescriptions": [ + "Public internet quality with fixed bandwidth.", + "High quality, Google-grade network tier, support for all networking products.", + "Public internet quality, only limited support for other networking products.", + "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured." + ], "type": "string" }, - "nextHopHub": { - "description": "[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.", - "type": "string" + "drainNatIps": { + "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.", + "items": { + "type": "string" + }, + "type": "array" }, - "nextHopIlb": { - "description": "The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule ", - "type": "string" + "enableDynamicPortAllocation": { + "description": "Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config. ", + "type": "boolean" }, - "nextHopInstance": { - "description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/", - "type": "string" + "enableEndpointIndependentMapping": { + "type": "boolean" }, - "nextHopIp": { - "description": "The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.", - "type": "string" + "endpointTypes": { + "description": "List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM", + "items": { + "enum": [ + "ENDPOINT_TYPE_MANAGED_PROXY_LB", + "ENDPOINT_TYPE_SWG", + "ENDPOINT_TYPE_VM" + ], + "enumDescriptions": [ + "This is used for regional Application Load Balancers (internal and external) and regional proxy Network Load Balancers (internal and external) endpoints.", + "This is used for Secure Web Gateway endpoints.", + "This is the default." + ], + "type": "string" + }, + "type": "array" }, - "nextHopNetwork": { - "description": "The URL of the local network if it should handle matching packets.", - "type": "string" + "icmpIdleTimeoutSec": { + "description": "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.", + "format": "int32", + "type": "integer" }, - "nextHopPeering": { - "description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.", - "type": "string" + "logConfig": { + "$ref": "RouterNatLogConfig", + "description": "Configure logging on this NAT." }, - "nextHopVpnTunnel": { - "description": "The URL to a VpnTunnel that should handle matching packets.", - "type": "string" + "maxPortsPerVm": { + "description": "Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.", + "format": "int32", + "type": "integer" }, - "priority": { - "annotations": { - "required": [ - "compute.routes.insert" - ] - }, - "description": "The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.", - "format": "uint32", + "minPortsPerVm": { + "description": "Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.", + "format": "int32", "type": "integer" }, - "routeStatus": { - "description": "[Output only] The status of the route.", - "enum": [ - "ACTIVE", - "DROPPED", - "INACTIVE", - "PENDING" - ], - "enumDescriptions": [ - "This route is processed and active.", - "The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example", - "This route is processed but inactive due to failure from the backend. The backend may have rejected the route", - "This route is being processed internally. The status will change once processed." - ], + "name": { + "description": "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "routeType": { - "description": "[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route", + "natIpAllocateOption": { + "description": "Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. ", "enum": [ - "BGP", - "STATIC", - "SUBNET", - "TRANSIT" + "AUTO_ONLY", + "MANUAL_ONLY" ], "enumDescriptions": [ - "", - "", - "", - "" + "Nat IPs are allocated by GCP; customers can not specify any Nat IPs.", + "Only use Nat IPs provided by customers. When specified Nat IPs are not enough then the Nat service fails for new VMs." ], "type": "string" }, - "selfLink": { - "description": "[Output Only] Server-defined fully-qualified URL for this resource.", - "type": "string" - }, - "tags": { - "annotations": { - "required": [ - "compute.routes.insert" - ] - }, - "description": "A list of instance tags to which this route applies.", + "natIps": { + "description": "A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.", "items": { "type": "string" }, "type": "array" }, - "warnings": { - "description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.", + "rules": { + "description": "A list of rules associated with this NAT.", "items": { - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" + "$ref": "RouterNatRule" + }, + "type": "array" + }, + "sourceSubnetworkIpRangesToNat": { + "description": "Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region.", + "enum": [ + "ALL_SUBNETWORKS_ALL_IP_RANGES", + "ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES", + "LIST_OF_SUBNETWORKS" + ], + "enumDescriptions": [ + "All the IP ranges in every Subnetwork are allowed to Nat.", + "All the primary IP ranges in every Subnetwork are allowed to Nat.", + "A list of Subnetworks are allowed to Nat (specified in the field subnetwork below)" + ], + "type": "string" + }, + "subnetworks": { + "description": "A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.", + "items": { + "$ref": "RouterNatSubnetworkToNat" }, "type": "array" + }, + "tcpEstablishedIdleTimeoutSec": { + "description": "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.", + "format": "int32", + "type": "integer" + }, + "tcpTimeWaitTimeoutSec": { + "description": "Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.", + "format": "int32", + "type": "integer" + }, + "tcpTransitoryIdleTimeoutSec": { + "description": "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.", + "enum": [ + "PRIVATE", + "PUBLIC" + ], + "enumDescriptions": [ + "NAT used for private IP translation.", + "NAT used for public IP translation. This is the default." + ], + "type": "string" + }, + "udpIdleTimeoutSec": { + "description": "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "RouteAsPath": { - "id": "RouteAsPath", + "RouterNatLogConfig": { + "description": "Configuration of logging on a NAT.", + "id": "RouterNatLogConfig", "properties": { - "asLists": { - "description": "[Output Only] The AS numbers of the AS Path.", - "items": { - "format": "uint32", - "type": "integer" - }, - "type": "array" + "enable": { + "description": "Indicates whether or not to export logs. This is false by default.", + "type": "boolean" }, - "pathSegmentType": { - "description": "[Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed ", + "filter": { + "description": "Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful. ", "enum": [ - "AS_CONFED_SEQUENCE", - "AS_CONFED_SET", - "AS_SEQUENCE", - "AS_SET" + "ALL", + "ERRORS_ONLY", + "TRANSLATIONS_ONLY" ], "enumDescriptions": [ - "", - "", - "", - "" + "Export logs for all (successful and unsuccessful) connections.", + "Export logs for connection failures only.", + "Export logs for successful connections only." ], "type": "string" } }, "type": "object" }, - "RouteList": { - "description": "Contains a list of Route resources.", - "id": "RouteList", + "RouterNatRule": { + "id": "RouterNatRule", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "action": { + "$ref": "RouterNatRuleAction", + "description": "The action to be enforced for traffic that matches this rule." + }, + "description": { + "description": "An optional description of this rule.", "type": "string" }, - "items": { - "description": "A list of Route resources.", + "match": { + "description": "CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: \"inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')\" \"destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'\" The following example is a valid match expression for private NAT: \"nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'\"", + "type": "string" + }, + "ruleNumber": { + "description": "An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.", + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, + "RouterNatRuleAction": { + "id": "RouterNatRuleAction", + "properties": { + "sourceNatActiveIps": { + "description": "A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT.", "items": { - "$ref": "Route" + "type": "string" }, "type": "array" }, - "kind": { - "default": "compute#routeList", - "description": "Type of resource.", - "type": "string" + "sourceNatActiveRanges": { + "description": "A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT.", + "items": { + "type": "string" + }, + "type": "array" }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" + "sourceNatDrainIps": { + "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT.", + "items": { + "type": "string" + }, + "type": "array" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", + "sourceNatDrainRanges": { + "description": "A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RouterNatSubnetworkToNat": { + "description": "Defines the IP ranges that want to use NAT for a subnetwork.", + "id": "RouterNatSubnetworkToNat", + "properties": { + "name": { + "description": "URL for the subnetwork resource that will use NAT.", "type": "string" }, - "warning": { - "description": "[Output Only] Informational warning message.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } + "secondaryIpRangeNames": { + "description": "A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if \"LIST_OF_SECONDARY_IP_RANGES\" is one of the values in source_ip_ranges_to_nat.", + "items": { + "type": "string" }, - "type": "object" + "type": "array" + }, + "sourceIpRangesToNat": { + "description": "Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: [\"PRIMARY_IP_RANGE\", \"LIST_OF_SECONDARY_IP_RANGES\"] Default: [ALL_IP_RANGES]", + "items": { + "enum": [ + "ALL_IP_RANGES", + "LIST_OF_SECONDARY_IP_RANGES", + "PRIMARY_IP_RANGE" + ], + "enumDescriptions": [ + "The primary and all the secondary ranges are allowed to Nat.", + "A list of secondary ranges are allowed to Nat.", + "The primary range is allowed to Nat." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "Router": { - "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.", - "id": "Router", + "RouterStatus": { + "id": "RouterStatus", "properties": { - "bgp": { - "$ref": "RouterBgp", - "description": "BGP information specific to this router." + "bestRoutes": { + "description": "Best routes for this router's network.", + "items": { + "$ref": "Route" + }, + "type": "array" }, - "bgpPeers": { - "description": "BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.", + "bestRoutesForRouter": { + "description": "Best routes learned by this router.", "items": { - "$ref": "RouterBgpPeer" + "$ref": "Route" }, "type": "array" }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "bgpPeerStatus": { + "items": { + "$ref": "RouterStatusBgpPeerStatus" + }, + "type": "array" + }, + "natStatus": { + "items": { + "$ref": "RouterStatusNatStatus" + }, + "type": "array" + }, + "network": { + "description": "URI of the network to which this router belongs.", "type": "string" + } + }, + "type": "object" + }, + "RouterStatusBgpPeerStatus": { + "id": "RouterStatusBgpPeerStatus", + "properties": { + "advertisedRoutes": { + "description": "Routes that were advertised to the remote BGP peer", + "items": { + "$ref": "Route" + }, + "type": "array" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", + "bfdStatus": { + "$ref": "BfdStatus" + }, + "enableIpv6": { + "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.", + "type": "boolean" + }, + "ipAddress": { + "description": "IP address of the local BGP interface.", "type": "string" }, - "encryptedInterconnectRouter": { - "description": "Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).", + "ipv6NexthopAddress": { + "description": "IPv6 address of the local BGP interface.", + "type": "string" + }, + "linkedVpnTunnel": { + "description": "URL of the VPN tunnel that this BGP peer controls.", + "type": "string" + }, + "md5AuthEnabled": { + "description": "Informs whether MD5 authentication is enabled on this BGP peer.", "type": "boolean" }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", + "name": { + "description": "Name of this BGP peer. Unique within the Routers resource.", "type": "string" }, - "interfaces": { - "description": "Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.", + "numLearnedRoutes": { + "description": "Number of routes learned from the remote BGP Peer.", + "format": "uint32", + "type": "integer" + }, + "peerIpAddress": { + "description": "IP address of the remote BGP interface.", + "type": "string" + }, + "peerIpv6NexthopAddress": { + "description": "IPv6 address of the remote BGP interface.", + "type": "string" + }, + "routerApplianceInstance": { + "description": "[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session.", + "type": "string" + }, + "state": { + "description": "The state of the BGP session. For a list of possible values for this field, see BGP session states.", + "type": "string" + }, + "status": { + "description": "Status of the BGP peer: {UP, DOWN}", + "enum": [ + "DOWN", + "UNKNOWN", + "UP" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "statusReason": { + "description": "Indicates why particular status was returned.", + "enum": [ + "MD5_AUTH_INTERNAL_PROBLEM", + "STATUS_REASON_UNSPECIFIED" + ], + "enumDescriptions": [ + "Indicates internal problems with configuration of MD5 authentication. This particular reason can only be returned when md5AuthEnabled is true and status is DOWN.", + "" + ], + "type": "string" + }, + "uptime": { + "description": "Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds", + "type": "string" + }, + "uptimeSeconds": { + "description": "Time this session has been up, in seconds. Format: 145", + "type": "string" + } + }, + "type": "object" + }, + "RouterStatusNatStatus": { + "description": "Status of a NAT contained in this router.", + "id": "RouterStatusNatStatus", + "properties": { + "autoAllocatedNatIps": { + "description": "A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]", "items": { - "$ref": "RouterInterface" + "type": "string" }, "type": "array" }, - "kind": { - "default": "compute#router", - "description": "[Output Only] Type of resource. Always compute#router for routers.", - "type": "string" + "drainAutoAllocatedNatIps": { + "description": "A list of IPs auto-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", + "items": { + "type": "string" + }, + "type": "array" }, - "md5AuthenticationKeys": { - "description": "Keys used for MD5 authentication.", + "drainUserAllocatedNatIps": { + "description": "A list of IPs user-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", "items": { - "$ref": "RouterMd5AuthenticationKey" + "type": "string" }, "type": "array" }, + "minExtraNatIpsNeeded": { + "description": "The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used.", + "format": "int32", + "type": "integer" + }, "name": { - "annotations": { - "required": [ - "compute.routers.insert" - ] - }, - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "description": "Unique name of this NAT.", "type": "string" }, - "nats": { - "description": "A list of NAT services created in this router.", + "numVmEndpointsWithNatMappings": { + "description": "Number of VM endpoints (i.e., Nics) that can use NAT.", + "format": "int32", + "type": "integer" + }, + "ruleStatus": { + "description": "Status of rules in this NAT.", "items": { - "$ref": "RouterNat" + "$ref": "RouterStatusNatStatusNatRuleStatus" }, "type": "array" }, - "network": { - "annotations": { - "required": [ - "compute.routers.insert", - "compute.routers.update" - ] + "userAllocatedNatIpResources": { + "description": "A list of fully qualified URLs of reserved IP address resources.", + "items": { + "type": "string" }, - "description": "URI of the network to which this router belongs.", - "type": "string" + "type": "array" }, - "region": { - "description": "[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", - "type": "string" + "userAllocatedNatIps": { + "description": "A list of IPs user-allocated for NAT. They will be raw IP strings like \"179.12.26.133\".", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RouterStatusNatStatusNatRuleStatus": { + "description": "Status of a NAT Rule contained in this NAT.", + "id": "RouterStatusNatStatusNatRuleStatus", + "properties": { + "activeNatIps": { + "description": "A list of active IPs for NAT. Example: [\"1.1.1.1\", \"179.12.26.133\"].", + "items": { + "type": "string" + }, + "type": "array" }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", + "drainNatIps": { + "description": "A list of IPs for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", + "items": { + "type": "string" + }, + "type": "array" + }, + "minExtraIpsNeeded": { + "description": "The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.", + "format": "int32", + "type": "integer" + }, + "numVmEndpointsWithNatMappings": { + "description": "Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.", + "format": "int32", + "type": "integer" + }, + "ruleNumber": { + "description": "Rule number of the rule.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "RouterStatusResponse": { + "id": "RouterStatusResponse", + "properties": { + "kind": { + "default": "compute#routerStatusResponse", + "description": "Type of resource.", "type": "string" + }, + "result": { + "$ref": "RouterStatus" } }, "type": "object" }, - "RouterAdvertisedIpRange": { - "description": "Description-tagged IP ranges for the router to advertise.", - "id": "RouterAdvertisedIpRange", + "RoutersPreviewResponse": { + "id": "RoutersPreviewResponse", "properties": { - "description": { - "description": "User-specified description for the IP range.", - "type": "string" - }, - "range": { - "description": "The IP range to advertise. The value must be a CIDR-formatted string.", - "type": "string" + "resource": { + "$ref": "Router", + "description": "Preview of given router." } }, "type": "object" }, - "RouterAggregatedList": { - "description": "Contains a list of routers.", - "id": "RouterAggregatedList", + "RoutersScopedList": { + "id": "RoutersScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "additionalProperties": { - "$ref": "RoutersScopedList", - "description": "Name of the scope containing this set of routers." - }, - "description": "A list of Router resources.", - "type": "object" - }, - "kind": { - "default": "compute#routerAggregatedList", - "description": "Type of resource.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", + "routers": { + "description": "A list of routers contained in this scope.", "items": { - "type": "string" + "$ref": "Router" }, "type": "array" }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "Informational warning which replaces the list of routers when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -67930,62 +70396,103 @@ }, "type": "object" }, - "RouterBgp": { - "id": "RouterBgp", + "Rule": { + "description": "This is deprecated and has no effect. Do not use.", + "id": "Rule", "properties": { - "advertiseMode": { - "description": "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.", + "action": { + "description": "This is deprecated and has no effect. Do not use.", "enum": [ - "CUSTOM", - "DEFAULT" + "ALLOW", + "ALLOW_WITH_LOG", + "DENY", + "DENY_WITH_LOG", + "LOG", + "NO_ACTION" ], "enumDescriptions": [ - "", - "" + "This is deprecated and has no effect. Do not use.", + "This is deprecated and has no effect. Do not use.", + "This is deprecated and has no effect. Do not use.", + "This is deprecated and has no effect. Do not use.", + "This is deprecated and has no effect. Do not use.", + "This is deprecated and has no effect. Do not use." ], "type": "string" }, - "advertisedGroups": { - "description": "User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.", + "conditions": { + "description": "This is deprecated and has no effect. Do not use.", + "items": { + "$ref": "Condition" + }, + "type": "array" + }, + "description": { + "description": "This is deprecated and has no effect. Do not use.", + "type": "string" + }, + "ins": { + "description": "This is deprecated and has no effect. Do not use.", "items": { - "enum": [ - "ALL_SUBNETS" - ], - "enumDescriptions": [ - "Advertise all available subnets (including peer VPC subnets)." - ], "type": "string" }, "type": "array" }, - "advertisedIpRanges": { - "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.", + "logConfigs": { + "description": "This is deprecated and has no effect. Do not use.", "items": { - "$ref": "RouterAdvertisedIpRange" + "$ref": "LogConfig" }, "type": "array" }, - "asn": { - "description": "Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.", - "format": "uint32", - "type": "integer" + "notIns": { + "description": "This is deprecated and has no effect. Do not use.", + "items": { + "type": "string" + }, + "type": "array" }, - "keepaliveInterval": { - "description": "The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.", - "format": "uint32", - "type": "integer" + "permissions": { + "description": "This is deprecated and has no effect. Do not use.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "RouterBgpPeer": { - "id": "RouterBgpPeer", + "SSLHealthCheck": { + "id": "SSLHealthCheck", "properties": { - "advertiseMode": { - "description": "User-specified flag to indicate which mode to use for advertisement.", + "port": { + "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.", + "format": "int32", + "type": "integer" + }, + "portName": { + "description": "Not supported.", + "type": "string" + }, + "portSpecification": { + "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", "enum": [ - "CUSTOM", - "DEFAULT" + "USE_FIXED_PORT", + "USE_NAMED_PORT", + "USE_SERVING_PORT" + ], + "enumDescriptions": [ + "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", + "Not supported.", + "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." + ], + "type": "string" + }, + "proxyHeader": { + "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", + "enum": [ + "NONE", + "PROXY_V1" ], "enumDescriptions": [ "", @@ -67993,52 +70500,63 @@ ], "type": "string" }, - "advertisedGroups": { - "description": "User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.", - "items": { - "enum": [ - "ALL_SUBNETS" - ], - "enumDescriptions": [ - "Advertise all available subnets (including peer VPC subnets)." - ], - "type": "string" - }, - "type": "array" + "request": { + "description": "Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake.", + "type": "string" }, - "advertisedIpRanges": { - "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.", - "items": { - "$ref": "RouterAdvertisedIpRange" - }, - "type": "array" + "response": { + "description": "Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp", + "type": "string" + } + }, + "type": "object" + }, + "SavedAttachedDisk": { + "description": "DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.", + "id": "SavedAttachedDisk", + "properties": { + "autoDelete": { + "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", + "type": "boolean" }, - "advertisedRoutePriority": { - "description": "The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.", - "format": "uint32", - "type": "integer" + "boot": { + "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.", + "type": "boolean" }, - "bfd": { - "$ref": "RouterBgpPeerBfd", - "description": "BFD configuration for the BGP peering." + "deviceName": { + "description": "Specifies the name of the disk attached to the source instance.", + "type": "string" }, - "customLearnedIpRanges": { - "description": "A list of user-defined custom learned route IP address ranges for a BGP session.", + "diskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "The encryption key for the disk." + }, + "diskSizeGb": { + "description": "The size of the disk in base-2 GB.", + "format": "int64", + "type": "string" + }, + "diskType": { + "description": "[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd", + "type": "string" + }, + "guestOsFeatures": { + "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", "items": { - "$ref": "RouterBgpPeerCustomLearnedIpRange" + "$ref": "GuestOsFeature" }, "type": "array" }, - "customLearnedRoutePriority": { - "description": "The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from `0` to `65335`. If you don't provide a value, Google Cloud assigns a priority of `100` to the ranges.", + "index": { + "description": "Specifies zero-based index of the disk that is attached to the source instance.", "format": "int32", "type": "integer" }, - "enable": { - "description": "The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.", + "interface": { + "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.", "enum": [ - "FALSE", - "TRUE" + "NVME", + "SCSI" ], "enumDescriptions": [ "", @@ -68046,100 +70564,105 @@ ], "type": "string" }, - "enableIpv6": { - "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.", - "type": "boolean" - }, - "interfaceName": { - "description": "Name of the interface the BGP peer is associated with.", - "type": "string" - }, - "ipAddress": { - "description": "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.", + "kind": { + "default": "compute#savedAttachedDisk", + "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.", "type": "string" }, - "ipv6NexthopAddress": { - "description": "IPv6 address of the interface inside Google Cloud Platform.", - "type": "string" + "licenses": { + "description": "[Output Only] Any valid publicly visible licenses.", + "items": { + "type": "string" + }, + "type": "array" }, - "managementType": { - "description": "[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. ", + "mode": { + "description": "The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.", "enum": [ - "MANAGED_BY_ATTACHMENT", - "MANAGED_BY_USER" + "READ_ONLY", + "READ_WRITE" ], "enumDescriptions": [ - "The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.", - "Default value, the BGP peer is manually created and managed by user." + "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.", + "*[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode." ], "type": "string" }, - "md5AuthenticationKeyName": { - "description": "Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.", - "type": "string" - }, - "name": { - "annotations": { - "required": [ - "compute.routers.insert" - ] - }, - "description": "Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "source": { + "description": "Specifies a URL of the disk attached to the source instance.", "type": "string" }, - "peerAsn": { - "annotations": { - "required": [ - "compute.routers.insert" - ] - }, - "description": "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.", - "format": "uint32", - "type": "integer" - }, - "peerIpAddress": { - "description": "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.", + "storageBytes": { + "description": "[Output Only] A size of the storage used by the disk's snapshot by this machine image.", + "format": "int64", "type": "string" }, - "peerIpv6NexthopAddress": { - "description": "IPv6 address of the BGP interface outside Google Cloud Platform.", + "storageBytesStatus": { + "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", + "enum": [ + "UPDATING", + "UP_TO_DATE" + ], + "enumDescriptions": [ + "", + "" + ], "type": "string" }, - "routerApplianceInstance": { - "description": "URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.", + "type": { + "description": "Specifies the type of the attached disk, either SCRATCH or PERSISTENT.", + "enum": [ + "PERSISTENT", + "SCRATCH" + ], + "enumDescriptions": [ + "", + "" + ], "type": "string" } }, "type": "object" }, - "RouterBgpPeerBfd": { - "id": "RouterBgpPeerBfd", + "SavedDisk": { + "description": "An instance-attached disk resource.", + "id": "SavedDisk", "properties": { - "minReceiveInterval": { - "description": "The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.", - "format": "uint32", - "type": "integer" + "architecture": { + "description": "[Output Only] The architecture of the attached disk.", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" + ], + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" + ], + "type": "string" }, - "minTransmitInterval": { - "description": "The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.", - "format": "uint32", - "type": "integer" + "kind": { + "default": "compute#savedDisk", + "description": "[Output Only] Type of the resource. Always compute#savedDisk for attached disks.", + "type": "string" }, - "multiplier": { - "description": "The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.", - "format": "uint32", - "type": "integer" + "sourceDisk": { + "description": "Specifies a URL of the disk attached to the source instance.", + "type": "string" }, - "sessionInitializationMode": { - "description": "The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.", + "storageBytes": { + "description": "[Output Only] Size of the individual disk snapshot used by this machine image.", + "format": "int64", + "type": "string" + }, + "storageBytesStatus": { + "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", "enum": [ - "ACTIVE", - "DISABLED", - "PASSIVE" + "UPDATING", + "UP_TO_DATE" ], "enumDescriptions": [ - "", "", "" ], @@ -68148,87 +70671,178 @@ }, "type": "object" }, - "RouterBgpPeerCustomLearnedIpRange": { - "id": "RouterBgpPeerCustomLearnedIpRange", + "ScalingScheduleStatus": { + "id": "ScalingScheduleStatus", "properties": { - "range": { - "description": "The custom learned route IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a `/32` singular IP address range, and, for IPv6, `/128`.", + "lastStartTime": { + "description": "[Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format.", + "type": "string" + }, + "nextStartTime": { + "description": "[Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format.", + "type": "string" + }, + "state": { + "description": "[Output Only] The current state of a scaling schedule.", + "enum": [ + "ACTIVE", + "DISABLED", + "OBSOLETE", + "READY" + ], + "enumDescriptions": [ + "The current autoscaling recommendation is influenced by this scaling schedule.", + "This scaling schedule has been disabled by the user.", + "This scaling schedule will never become active again.", + "The current autoscaling recommendation is not influenced by this scaling schedule." + ], "type": "string" } }, "type": "object" }, - "RouterInterface": { - "id": "RouterInterface", + "Scheduling": { + "description": "Sets the scheduling options for an Instance.", + "id": "Scheduling", "properties": { - "ipRange": { - "description": "IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.", - "type": "string" + "automaticRestart": { + "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", + "type": "boolean" }, - "linkedInterconnectAttachment": { - "description": "URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.", + "instanceTerminationAction": { + "description": "Specifies the termination action for the instance.", + "enum": [ + "DELETE", + "INSTANCE_TERMINATION_ACTION_UNSPECIFIED", + "STOP" + ], + "enumDescriptions": [ + "Delete the VM.", + "Default value. This value is unused.", + "Stop the VM without storing in-memory content. default action." + ], "type": "string" }, - "linkedVpnTunnel": { - "description": "URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.", + "localSsdRecoveryTimeout": { + "$ref": "Duration", + "description": "Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour." + }, + "locationHint": { + "description": "An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.", "type": "string" }, - "managementType": { - "description": "[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. ", + "minNodeCpus": { + "description": "The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.", + "format": "int32", + "type": "integer" + }, + "nodeAffinities": { + "description": "A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.", + "items": { + "$ref": "SchedulingNodeAffinity" + }, + "type": "array" + }, + "onHostMaintenance": { + "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.", "enum": [ - "MANAGED_BY_ATTACHMENT", - "MANAGED_BY_USER" + "MIGRATE", + "TERMINATE" ], "enumDescriptions": [ - "The interface is automatically created for PARTNER type InterconnectAttachment, Google will automatically create/update/delete this interface when the PARTNER InterconnectAttachment is created/provisioned/deleted. This type of interface cannot be manually managed by user.", - "Default value, the interface is manually created and managed by user." + "*[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.", + "Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events." ], "type": "string" }, - "name": { - "annotations": { - "required": [ - "compute.routers.insert" - ] - }, - "description": "Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "preemptible": { + "description": "Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.", + "type": "boolean" + }, + "provisioningModel": { + "description": "Specifies the provisioning model of the instance.", + "enum": [ + "SPOT", + "STANDARD" + ], + "enumDescriptions": [ + "Heavily discounted, no guaranteed runtime.", + "Standard provisioning with user controlled runtime, no discounts." + ], + "type": "string" + } + }, + "type": "object" + }, + "SchedulingNodeAffinity": { + "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.", + "id": "SchedulingNodeAffinity", + "properties": { + "key": { + "description": "Corresponds to the label key of Node resource.", "type": "string" }, - "privateIpAddress": { - "description": "The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.", + "operator": { + "description": "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.", + "enum": [ + "IN", + "NOT_IN", + "OPERATOR_UNSPECIFIED" + ], + "enumDescriptions": [ + "Requires Compute Engine to seek for matched nodes.", + "Requires Compute Engine to avoid certain nodes.", + "" + ], "type": "string" }, - "redundantInterface": { - "description": "Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "values": { + "description": "Corresponds to the label values of Node resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Screenshot": { + "description": "An instance's screenshot.", + "id": "Screenshot", + "properties": { + "contents": { + "description": "[Output Only] The Base64-encoded screenshot data.", "type": "string" }, - "subnetwork": { - "description": "The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.", + "kind": { + "default": "compute#screenshot", + "description": "[Output Only] Type of the resource. Always compute#screenshot for the screenshots.", "type": "string" } }, "type": "object" }, - "RouterList": { - "description": "Contains a list of Router resources.", - "id": "RouterList", + "SecurityPoliciesAggregatedList": { + "id": "SecurityPoliciesAggregatedList", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of Router resources.", - "items": { - "$ref": "Router" + "additionalProperties": { + "$ref": "SecurityPoliciesScopedList", + "description": "Name of the scope containing this set of security policies." }, - "type": "array" + "description": "A list of SecurityPoliciesScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#routerList", - "description": "[Output Only] Type of resource. Always compute#router for routers.", + "default": "compute#securityPoliciesAggregatedList", + "description": "[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies.", "type": "string" }, "nextPageToken": { @@ -68239,6 +70853,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -68363,405 +70984,235 @@ }, "type": "object" }, - "RouterMd5AuthenticationKey": { - "id": "RouterMd5AuthenticationKey", - "properties": { - "key": { - "annotations": { - "required": [ - "compute.routers.insert" - ] - }, - "description": "[Input only] Value of the key. For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.", - "type": "string" - }, - "name": { - "annotations": { - "required": [ - "compute.routers.insert", - "compute.routers.update" - ] - }, - "description": "Name used to identify the key. Must be unique within a router. Must be referenced by exactly one bgpPeer. Must comply with RFC1035.", - "type": "string" - } - }, - "type": "object" - }, - "RouterNat": { - "description": "Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.", - "id": "RouterNat", - "properties": { - "autoNetworkTier": { - "description": "The network tier to use when automatically reserving NAT IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, then the current project-level default tier is used.", - "enum": [ - "FIXED_STANDARD", - "PREMIUM", - "STANDARD", - "STANDARD_OVERRIDES_FIXED_STANDARD" - ], - "enumDescriptions": [ - "Public internet quality with fixed bandwidth.", - "High quality, Google-grade network tier, support for all networking products.", - "Public internet quality, only limited support for other networking products.", - "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured." - ], - "type": "string" - }, - "drainNatIps": { - "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.", - "items": { - "type": "string" - }, - "type": "array" - }, - "enableDynamicPortAllocation": { - "description": "Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config. ", - "type": "boolean" - }, - "enableEndpointIndependentMapping": { - "type": "boolean" - }, - "endpointTypes": { - "description": "List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM", - "items": { - "enum": [ - "ENDPOINT_TYPE_MANAGED_PROXY_LB", - "ENDPOINT_TYPE_SWG", - "ENDPOINT_TYPE_VM" - ], - "enumDescriptions": [ - "This is used for regional Application Load Balancers (internal and external) and regional proxy Network Load Balancers (internal and external) endpoints.", - "This is used for Secure Web Gateway endpoints.", - "This is the default." - ], - "type": "string" - }, - "type": "array" - }, - "icmpIdleTimeoutSec": { - "description": "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.", - "format": "int32", - "type": "integer" - }, - "logConfig": { - "$ref": "RouterNatLogConfig", - "description": "Configure logging on this NAT." - }, - "maxPortsPerVm": { - "description": "Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.", - "format": "int32", - "type": "integer" - }, - "minPortsPerVm": { - "description": "Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "natIpAllocateOption": { - "description": "Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. ", - "enum": [ - "AUTO_ONLY", - "MANUAL_ONLY" - ], - "enumDescriptions": [ - "Nat IPs are allocated by GCP; customers can not specify any Nat IPs.", - "Only use Nat IPs provided by customers. When specified Nat IPs are not enough then the Nat service fails for new VMs." - ], - "type": "string" - }, - "natIps": { - "description": "A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.", - "items": { - "type": "string" - }, - "type": "array" - }, - "rules": { - "description": "A list of rules associated with this NAT.", - "items": { - "$ref": "RouterNatRule" - }, - "type": "array" - }, - "sourceSubnetworkIpRangesToNat": { - "description": "Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region.", - "enum": [ - "ALL_SUBNETWORKS_ALL_IP_RANGES", - "ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES", - "LIST_OF_SUBNETWORKS" - ], - "enumDescriptions": [ - "All the IP ranges in every Subnetwork are allowed to Nat.", - "All the primary IP ranges in every Subnetwork are allowed to Nat.", - "A list of Subnetworks are allowed to Nat (specified in the field subnetwork below)" - ], - "type": "string" - }, - "subnetworks": { - "description": "A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.", - "items": { - "$ref": "RouterNatSubnetworkToNat" - }, - "type": "array" - }, - "tcpEstablishedIdleTimeoutSec": { - "description": "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.", - "format": "int32", - "type": "integer" - }, - "tcpTimeWaitTimeoutSec": { - "description": "Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.", - "format": "int32", - "type": "integer" - }, - "tcpTransitoryIdleTimeoutSec": { - "description": "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.", - "enum": [ - "PRIVATE", - "PUBLIC" - ], - "enumDescriptions": [ - "NAT used for private IP translation.", - "NAT used for public IP translation. This is the default." - ], - "type": "string" - }, - "udpIdleTimeoutSec": { - "description": "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "RouterNatLogConfig": { - "description": "Configuration of logging on a NAT.", - "id": "RouterNatLogConfig", - "properties": { - "enable": { - "description": "Indicates whether or not to export logs. This is false by default.", - "type": "boolean" - }, - "filter": { - "description": "Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful. ", - "enum": [ - "ALL", - "ERRORS_ONLY", - "TRANSLATIONS_ONLY" - ], - "enumDescriptions": [ - "Export logs for all (successful and unsuccessful) connections.", - "Export logs for connection failures only.", - "Export logs for successful connections only." - ], - "type": "string" - } - }, - "type": "object" - }, - "RouterNatRule": { - "id": "RouterNatRule", + "SecurityPoliciesListPreconfiguredExpressionSetsResponse": { + "id": "SecurityPoliciesListPreconfiguredExpressionSetsResponse", "properties": { - "action": { - "$ref": "RouterNatRuleAction", - "description": "The action to be enforced for traffic that matches this rule." - }, - "description": { - "description": "An optional description of this rule.", - "type": "string" - }, - "match": { - "description": "CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: \"inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')\" \"destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'\" The following example is a valid match expression for private NAT: \"nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'\"", - "type": "string" - }, - "ruleNumber": { - "description": "An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.", - "format": "uint32", - "type": "integer" + "preconfiguredExpressionSets": { + "$ref": "SecurityPoliciesWafConfig" } }, "type": "object" }, - "RouterNatRuleAction": { - "id": "RouterNatRuleAction", + "SecurityPoliciesScopedList": { + "id": "SecurityPoliciesScopedList", "properties": { - "sourceNatActiveIps": { - "description": "A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT.", - "items": { - "type": "string" - }, - "type": "array" - }, - "sourceNatActiveRanges": { - "description": "A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT.", - "items": { - "type": "string" - }, - "type": "array" - }, - "sourceNatDrainIps": { - "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT.", + "securityPolicies": { + "description": "A list of SecurityPolicies contained in this scope.", "items": { - "type": "string" + "$ref": "SecurityPolicy" }, "type": "array" }, - "sourceNatDrainRanges": { - "description": "A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT.", - "items": { - "type": "string" + "warning": { + "description": "Informational warning which replaces the list of security policies when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } }, - "type": "array" + "type": "object" } }, "type": "object" }, - "RouterNatSubnetworkToNat": { - "description": "Defines the IP ranges that want to use NAT for a subnetwork.", - "id": "RouterNatSubnetworkToNat", + "SecurityPoliciesWafConfig": { + "id": "SecurityPoliciesWafConfig", "properties": { - "name": { - "description": "URL for the subnetwork resource that will use NAT.", - "type": "string" - }, - "secondaryIpRangeNames": { - "description": "A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if \"LIST_OF_SECONDARY_IP_RANGES\" is one of the values in source_ip_ranges_to_nat.", - "items": { - "type": "string" - }, - "type": "array" - }, - "sourceIpRangesToNat": { - "description": "Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: [\"PRIMARY_IP_RANGE\", \"LIST_OF_SECONDARY_IP_RANGES\"] Default: [ALL_IP_RANGES]", - "items": { - "enum": [ - "ALL_IP_RANGES", - "LIST_OF_SECONDARY_IP_RANGES", - "PRIMARY_IP_RANGE" - ], - "enumDescriptions": [ - "The primary and all the secondary ranges are allowed to Nat.", - "A list of secondary ranges are allowed to Nat.", - "The primary range is allowed to Nat." - ], - "type": "string" - }, - "type": "array" + "wafRules": { + "$ref": "PreconfiguredWafSet" } }, "type": "object" }, - "RouterStatus": { - "id": "RouterStatus", + "SecurityPolicy": { + "description": "Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.", + "id": "SecurityPolicy", "properties": { - "bestRoutes": { - "description": "Best routes for this router's network.", - "items": { - "$ref": "Route" - }, - "type": "array" - }, - "bestRoutesForRouter": { - "description": "Best routes learned by this router.", - "items": { - "$ref": "Route" - }, - "type": "array" - }, - "bgpPeerStatus": { - "items": { - "$ref": "RouterStatusBgpPeerStatus" - }, - "type": "array" - }, - "natStatus": { - "items": { - "$ref": "RouterStatusNatStatus" - }, - "type": "array" + "adaptiveProtectionConfig": { + "$ref": "SecurityPolicyAdaptiveProtectionConfig" }, - "network": { - "description": "URI of the network to which this router belongs.", - "type": "string" - } - }, - "type": "object" - }, - "RouterStatusBgpPeerStatus": { - "id": "RouterStatusBgpPeerStatus", - "properties": { - "advertisedRoutes": { - "description": "Routes that were advertised to the remote BGP peer", - "items": { - "$ref": "Route" - }, - "type": "array" + "advancedOptionsConfig": { + "$ref": "SecurityPolicyAdvancedOptionsConfig" }, - "bfdStatus": { - "$ref": "BfdStatus" + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" }, - "enableIpv6": { - "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.", - "type": "boolean" + "ddosProtectionConfig": { + "$ref": "SecurityPolicyDdosProtectionConfig" }, - "ipAddress": { - "description": "IP address of the local BGP interface.", + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "ipv6NexthopAddress": { - "description": "IPv6 address of the local BGP interface.", + "fingerprint": { + "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.", + "format": "byte", "type": "string" }, - "linkedVpnTunnel": { - "description": "URL of the VPN tunnel that this BGP peer controls.", + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", "type": "string" }, - "md5AuthEnabled": { - "description": "Informs whether MD5 authentication is enabled on this BGP peer.", - "type": "boolean" + "kind": { + "default": "compute#securityPolicy", + "description": "[Output only] Type of the resource. Always compute#securityPolicyfor security policies", + "type": "string" }, - "name": { - "description": "Name of this BGP peer. Unique within the Routers resource.", + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.", + "format": "byte", "type": "string" }, - "numLearnedRoutes": { - "description": "Number of routes learned from the remote BGP Peer.", - "format": "uint32", - "type": "integer" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.", + "type": "object" }, - "peerIpAddress": { - "description": "IP address of the remote BGP interface.", + "name": { + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "peerIpv6NexthopAddress": { - "description": "IPv6 address of the remote BGP interface.", - "type": "string" + "recaptchaOptionsConfig": { + "$ref": "SecurityPolicyRecaptchaOptionsConfig" }, - "routerApplianceInstance": { - "description": "[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session.", + "region": { + "description": "[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.", "type": "string" }, - "state": { - "description": "The state of the BGP session. For a list of possible values for this field, see BGP session states.", + "rules": { + "description": "A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"*\" for srcIpRanges and for the networkMatch condition every field must be either match \"*\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added.", + "items": { + "$ref": "SecurityPolicyRule" + }, + "type": "array" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "status": { - "description": "Status of the BGP peer: {UP, DOWN}", + "type": { + "description": "The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.", "enum": [ - "DOWN", - "UNKNOWN", - "UP" + "CLOUD_ARMOR", + "CLOUD_ARMOR_EDGE", + "CLOUD_ARMOR_NETWORK" ], "enumDescriptions": [ "", @@ -68770,84 +71221,117 @@ ], "type": "string" }, - "statusReason": { - "description": "Indicates why particular status was returned.", + "userDefinedFields": { + "description": "Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: \"ipv4_fragment_offset\" base: IPV4 offset: 6 size: 2 mask: \"0x1fff\"", + "items": { + "$ref": "SecurityPolicyUserDefinedField" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityPolicyAdaptiveProtectionConfig": { + "description": "Configuration options for Cloud Armor Adaptive Protection (CAAP).", + "id": "SecurityPolicyAdaptiveProtectionConfig", + "properties": { + "layer7DdosDefenseConfig": { + "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig", + "description": "If set to true, enables Cloud Armor Machine Learning." + } + }, + "type": "object" + }, + "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig": { + "description": "Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", + "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig", + "properties": { + "enable": { + "description": "If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", + "type": "boolean" + }, + "ruleVisibility": { + "description": "Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", "enum": [ - "MD5_AUTH_INTERNAL_PROBLEM", - "STATUS_REASON_UNSPECIFIED" + "PREMIUM", + "STANDARD" ], "enumDescriptions": [ - "Indicates internal problems with configuration of MD5 authentication. This particular reason can only be returned when md5AuthEnabled is true and status is DOWN.", + "", "" ], "type": "string" }, - "uptime": { - "description": "Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds", - "type": "string" - }, - "uptimeSeconds": { - "description": "Time this session has been up, in seconds. Format: 145", - "type": "string" + "thresholdConfigs": { + "description": "Configuration options for layer7 adaptive protection for various customizable thresholds.", + "items": { + "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig" + }, + "type": "array" } }, "type": "object" }, - "RouterStatusNatStatus": { - "description": "Status of a NAT contained in this router.", - "id": "RouterStatusNatStatus", + "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig": { + "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig", "properties": { - "autoAllocatedNatIps": { - "description": "A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "drainAutoAllocatedNatIps": { - "description": "A list of IPs auto-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", - "items": { - "type": "string" - }, - "type": "array" - }, - "drainUserAllocatedNatIps": { - "description": "A list of IPs user-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", - "items": { - "type": "string" - }, - "type": "array" + "autoDeployConfidenceThreshold": { + "format": "float", + "type": "number" }, - "minExtraNatIpsNeeded": { - "description": "The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used.", + "autoDeployExpirationSec": { "format": "int32", "type": "integer" }, + "autoDeployImpactedBaselineThreshold": { + "format": "float", + "type": "number" + }, + "autoDeployLoadThreshold": { + "format": "float", + "type": "number" + }, "name": { - "description": "Unique name of this NAT.", + "description": "The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" + } + }, + "type": "object" + }, + "SecurityPolicyAdvancedOptionsConfig": { + "id": "SecurityPolicyAdvancedOptionsConfig", + "properties": { + "jsonCustomConfig": { + "$ref": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig", + "description": "Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD." }, - "numVmEndpointsWithNatMappings": { - "description": "Number of VM endpoints (i.e., Nics) that can use NAT.", - "format": "int32", - "type": "integer" - }, - "ruleStatus": { - "description": "Status of rules in this NAT.", - "items": { - "$ref": "RouterStatusNatStatusNatRuleStatus" - }, - "type": "array" + "jsonParsing": { + "enum": [ + "DISABLED", + "STANDARD", + "STANDARD_WITH_GRAPHQL" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" }, - "userAllocatedNatIpResources": { - "description": "A list of fully qualified URLs of reserved IP address resources.", - "items": { - "type": "string" - }, - "type": "array" + "logLevel": { + "enum": [ + "NORMAL", + "VERBOSE" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" }, - "userAllocatedNatIps": { - "description": "A list of IPs user-allocated for NAT. They will be raw IP strings like \"179.12.26.133\".", + "userIpRequestHeaders": { + "description": "An optional list of case-insensitive request header names to use for resolving the callers client IP address.", "items": { "type": "string" }, @@ -68856,78 +71340,61 @@ }, "type": "object" }, - "RouterStatusNatStatusNatRuleStatus": { - "description": "Status of a NAT Rule contained in this NAT.", - "id": "RouterStatusNatStatusNatRuleStatus", + "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig": { + "id": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig", "properties": { - "activeNatIps": { - "description": "A list of active IPs for NAT. Example: [\"1.1.1.1\", \"179.12.26.133\"].", - "items": { - "type": "string" - }, - "type": "array" - }, - "drainNatIps": { - "description": "A list of IPs for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", + "contentTypes": { + "description": "A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type \"/\" subtype *[\";\" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.", "items": { "type": "string" }, "type": "array" - }, - "minExtraIpsNeeded": { - "description": "The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.", - "format": "int32", - "type": "integer" - }, - "numVmEndpointsWithNatMappings": { - "description": "Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.", - "format": "int32", - "type": "integer" - }, - "ruleNumber": { - "description": "Rule number of the rule.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "RouterStatusResponse": { - "id": "RouterStatusResponse", + "SecurityPolicyDdosProtectionConfig": { + "id": "SecurityPolicyDdosProtectionConfig", "properties": { - "kind": { - "default": "compute#routerStatusResponse", - "description": "Type of resource.", + "ddosProtection": { + "enum": [ + "ADVANCED", + "STANDARD" + ], + "enumDescriptions": [ + "", + "" + ], "type": "string" - }, - "result": { - "$ref": "RouterStatus" - } - }, - "type": "object" - }, - "RoutersPreviewResponse": { - "id": "RoutersPreviewResponse", - "properties": { - "resource": { - "$ref": "Router", - "description": "Preview of given router." } }, "type": "object" }, - "RoutersScopedList": { - "id": "RoutersScopedList", + "SecurityPolicyList": { + "id": "SecurityPolicyList", "properties": { - "routers": { - "description": "A list of routers contained in this scope.", + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of SecurityPolicy resources.", "items": { - "$ref": "Router" + "$ref": "SecurityPolicy" }, "type": "array" }, + "kind": { + "default": "compute#securityPolicyList", + "description": "[Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, "warning": { - "description": "Informational warning which replaces the list of routers when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -69045,458 +71512,978 @@ "type": "string" } }, - "type": "object" + "type": "object" + } + }, + "type": "object" + }, + "SecurityPolicyRecaptchaOptionsConfig": { + "id": "SecurityPolicyRecaptchaOptionsConfig", + "properties": { + "redirectSiteKey": { + "description": "An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", + "type": "string" + } + }, + "type": "object" + }, + "SecurityPolicyReference": { + "id": "SecurityPolicyReference", + "properties": { + "securityPolicy": { + "type": "string" + } + }, + "type": "object" + }, + "SecurityPolicyRule": { + "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).", + "id": "SecurityPolicyRule", + "properties": { + "action": { + "description": "The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. ", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "headerAction": { + "$ref": "SecurityPolicyRuleHttpHeaderAction", + "description": "Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR." + }, + "kind": { + "default": "compute#securityPolicyRule", + "description": "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules", + "type": "string" + }, + "match": { + "$ref": "SecurityPolicyRuleMatcher", + "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." + }, + "networkMatch": { + "$ref": "SecurityPolicyRuleNetworkMatcher", + "description": "A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - \"192.0.2.0/24\" - \"198.51.100.0/24\" userDefinedFields: - name: \"ipv4_fragment_offset\" values: - \"1-0x1fff\" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named \"ipv4_fragment_offset\" with a value between 1 and 0x1fff inclusive." + }, + "preconfiguredWafConfig": { + "$ref": "SecurityPolicyRulePreconfiguredWafConfig", + "description": "Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect." + }, + "preview": { + "description": "If set to true, the specified action is not enforced.", + "type": "boolean" + }, + "priority": { + "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.", + "format": "int32", + "type": "integer" + }, + "rateLimitOptions": { + "$ref": "SecurityPolicyRuleRateLimitOptions", + "description": "Must be specified if the action is \"rate_based_ban\" or \"throttle\". Cannot be specified for any other actions." + }, + "redirectOptions": { + "$ref": "SecurityPolicyRuleRedirectOptions", + "description": "Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR." + } + }, + "type": "object" + }, + "SecurityPolicyRuleHttpHeaderAction": { + "id": "SecurityPolicyRuleHttpHeaderAction", + "properties": { + "requestHeadersToAdds": { + "description": "The list of request headers to add or overwrite if they're already present.", + "items": { + "$ref": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption": { + "id": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption", + "properties": { + "headerName": { + "description": "The name of the header to set.", + "type": "string" + }, + "headerValue": { + "description": "The value to set the named header to.", + "type": "string" + } + }, + "type": "object" + }, + "SecurityPolicyRuleMatcher": { + "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", + "id": "SecurityPolicyRuleMatcher", + "properties": { + "config": { + "$ref": "SecurityPolicyRuleMatcherConfig", + "description": "The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified." + }, + "expr": { + "$ref": "Expr", + "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies." + }, + "exprOptions": { + "$ref": "SecurityPolicyRuleMatcherExprOptions", + "description": "The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr')." + }, + "versionedExpr": { + "description": "Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.", + "enum": [ + "SRC_IPS_V1" + ], + "enumDescriptions": [ + "Matches the source IP address of a request to the IP ranges supplied in config." + ], + "type": "string" + } + }, + "type": "object" + }, + "SecurityPolicyRuleMatcherConfig": { + "id": "SecurityPolicyRuleMatcherConfig", + "properties": { + "srcIpRanges": { + "description": "CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityPolicyRuleMatcherExprOptions": { + "id": "SecurityPolicyRuleMatcherExprOptions", + "properties": { + "recaptchaOptions": { + "$ref": "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions", + "description": "reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect." + } + }, + "type": "object" + }, + "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions": { + "id": "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions", + "properties": { + "actionTokenSiteKeys": { + "description": "A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sessionTokenSiteKeys": { + "description": "A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityPolicyRuleNetworkMatcher": { + "description": "Represents a match condition that incoming network traffic is evaluated against.", + "id": "SecurityPolicyRuleNetworkMatcher", + "properties": { + "destIpRanges": { + "description": "Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.", + "items": { + "type": "string" + }, + "type": "array" + }, + "destPorts": { + "description": "Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. \"80\") or range (e.g. \"0-1023\").", + "items": { + "type": "string" + }, + "type": "array" + }, + "ipProtocols": { + "description": "IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. \"6\"), range (e.g. \"253-254\"), or one of the following protocol names: \"tcp\", \"udp\", \"icmp\", \"esp\", \"ah\", \"ipip\", or \"sctp\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "srcAsns": { + "description": "BGP Autonomous System Number associated with the source IP address.", + "items": { + "format": "uint32", + "type": "integer" + }, + "type": "array" + }, + "srcIpRanges": { + "description": "Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.", + "items": { + "type": "string" + }, + "type": "array" + }, + "srcPorts": { + "description": "Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. \"80\") or range (e.g. \"0-1023\").", + "items": { + "type": "string" + }, + "type": "array" + }, + "srcRegionCodes": { + "description": "Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.", + "items": { + "type": "string" + }, + "type": "array" + }, + "userDefinedFields": { + "description": "User-defined fields. Each element names a defined field and lists the matching values for that field.", + "items": { + "$ref": "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch" + }, + "type": "array" } }, "type": "object" }, - "Rule": { - "description": "This is deprecated and has no effect. Do not use.", - "id": "Rule", + "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch": { + "id": "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch", "properties": { - "action": { - "description": "This is deprecated and has no effect. Do not use.", - "enum": [ - "ALLOW", - "ALLOW_WITH_LOG", - "DENY", - "DENY_WITH_LOG", - "LOG", - "NO_ACTION" - ], - "enumDescriptions": [ - "This is deprecated and has no effect. Do not use.", - "This is deprecated and has no effect. Do not use.", - "This is deprecated and has no effect. Do not use.", - "This is deprecated and has no effect. Do not use.", - "This is deprecated and has no effect. Do not use.", - "This is deprecated and has no effect. Do not use." - ], + "name": { + "description": "Name of the user-defined field, as given in the definition.", "type": "string" }, - "conditions": { - "description": "This is deprecated and has no effect. Do not use.", + "values": { + "description": "Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with \"0x\") number (e.g. \"64\") or range (e.g. \"0x400-0x7ff\").", "items": { - "$ref": "Condition" + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityPolicyRulePreconfiguredWafConfig": { + "id": "SecurityPolicyRulePreconfiguredWafConfig", + "properties": { + "exclusions": { + "description": "A list of exclusions to apply during preconfigured WAF evaluation.", + "items": { + "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusion" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityPolicyRulePreconfiguredWafConfigExclusion": { + "id": "SecurityPolicyRulePreconfiguredWafConfigExclusion", + "properties": { + "requestCookiesToExclude": { + "description": "A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.", + "items": { + "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" }, "type": "array" }, - "description": { - "description": "This is deprecated and has no effect. Do not use.", - "type": "string" - }, - "ins": { - "description": "This is deprecated and has no effect. Do not use.", + "requestHeadersToExclude": { + "description": "A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.", "items": { - "type": "string" + "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" }, "type": "array" }, - "logConfigs": { - "description": "This is deprecated and has no effect. Do not use.", + "requestQueryParamsToExclude": { + "description": "A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.", "items": { - "$ref": "LogConfig" + "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" }, "type": "array" }, - "notIns": { - "description": "This is deprecated and has no effect. Do not use.", + "requestUrisToExclude": { + "description": "A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.", "items": { - "type": "string" + "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" }, "type": "array" }, - "permissions": { - "description": "This is deprecated and has no effect. Do not use.", + "targetRuleIds": { + "description": "A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.", "items": { "type": "string" }, "type": "array" + }, + "targetRuleSet": { + "description": "Target WAF rule set to apply the preconfigured WAF exclusion.", + "type": "string" } }, "type": "object" }, - "SSLHealthCheck": { - "id": "SSLHealthCheck", + "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams": { + "id": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams", "properties": { - "port": { - "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.", + "op": { + "description": "The match operator for the field.", + "enum": [ + "CONTAINS", + "ENDS_WITH", + "EQUALS", + "EQUALS_ANY", + "STARTS_WITH" + ], + "enumDescriptions": [ + "The operator matches if the field value contains the specified value.", + "The operator matches if the field value ends with the specified value.", + "The operator matches if the field value equals the specified value.", + "The operator matches if the field value is any value.", + "The operator matches if the field value starts with the specified value." + ], + "type": "string" + }, + "val": { + "description": "The value of the field.", + "type": "string" + } + }, + "type": "object" + }, + "SecurityPolicyRuleRateLimitOptions": { + "id": "SecurityPolicyRuleRateLimitOptions", + "properties": { + "banDurationSec": { + "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.", "format": "int32", "type": "integer" }, - "portName": { - "description": "Not supported.", + "banThreshold": { + "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold", + "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'." + }, + "conformAction": { + "description": "Action to take for requests that are under the configured rate limit threshold. Valid option is \"allow\" only.", "type": "string" }, - "portSpecification": { - "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", + "enforceOnKey": { + "description": "Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if \"enforceOnKey\" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on \"userIpRequestHeaders\" configured with the security policy. If there is no \"userIpRequestHeaders\" configuration or an IP address cannot be resolved from it, the key type defaults to IP. ", "enum": [ - "USE_FIXED_PORT", - "USE_NAMED_PORT", - "USE_SERVING_PORT" + "ALL", + "HTTP_COOKIE", + "HTTP_HEADER", + "HTTP_PATH", + "IP", + "REGION_CODE", + "SNI", + "TLS_JA3_FINGERPRINT", + "USER_IP", + "XFF_IP" ], "enumDescriptions": [ - "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", - "Not supported.", - "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" ], "type": "string" }, - "proxyHeader": { - "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", + "enforceOnKeyConfigs": { + "description": "If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.", + "items": { + "$ref": "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig" + }, + "type": "array" + }, + "enforceOnKeyName": { + "description": "Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.", + "type": "string" + }, + "exceedAction": { + "description": "Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.", + "type": "string" + }, + "exceedRedirectOptions": { + "$ref": "SecurityPolicyRuleRedirectOptions", + "description": "Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR." + }, + "rateLimitThreshold": { + "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold", + "description": "Threshold at which to begin ratelimiting." + } + }, + "type": "object" + }, + "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig": { + "id": "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig", + "properties": { + "enforceOnKeyName": { + "description": "Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.", + "type": "string" + }, + "enforceOnKeyType": { + "description": "Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if \"enforceOnKeyConfigs\" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on \"userIpRequestHeaders\" configured with the security policy. If there is no \"userIpRequestHeaders\" configuration or an IP address cannot be resolved from it, the key type defaults to IP. ", "enum": [ - "NONE", - "PROXY_V1" + "ALL", + "HTTP_COOKIE", + "HTTP_HEADER", + "HTTP_PATH", + "IP", + "REGION_CODE", + "SNI", + "TLS_JA3_FINGERPRINT", + "USER_IP", + "XFF_IP" ], "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", "", "" ], "type": "string" + } + }, + "type": "object" + }, + "SecurityPolicyRuleRateLimitOptionsThreshold": { + "id": "SecurityPolicyRuleRateLimitOptionsThreshold", + "properties": { + "count": { + "description": "Number of HTTP(S) requests for calculating the threshold.", + "format": "int32", + "type": "integer" }, - "request": { - "description": "Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake.", + "intervalSec": { + "description": "Interval over which the threshold is computed.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SecurityPolicyRuleRedirectOptions": { + "id": "SecurityPolicyRuleRedirectOptions", + "properties": { + "target": { + "description": "Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.", "type": "string" }, - "response": { - "description": "Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp", + "type": { + "description": "Type of the redirect action.", + "enum": [ + "EXTERNAL_302", + "GOOGLE_RECAPTCHA" + ], + "enumDescriptions": [ + "", + "" + ], "type": "string" } }, "type": "object" }, - "SavedAttachedDisk": { - "description": "DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.", - "id": "SavedAttachedDisk", + "SecurityPolicyUserDefinedField": { + "id": "SecurityPolicyUserDefinedField", "properties": { - "autoDelete": { - "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", - "type": "boolean" + "base": { + "description": "The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required", + "enum": [ + "IPV4", + "IPV6", + "TCP", + "UDP" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" }, - "boot": { - "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.", - "type": "boolean" + "mask": { + "description": "If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with \"0x\"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.", + "type": "string" }, - "deviceName": { - "description": "Specifies the name of the disk attached to the source instance.", + "name": { + "description": "The name of this field. Must be unique within the policy.", "type": "string" }, - "diskEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The encryption key for the disk." + "offset": { + "description": "Offset of the first byte of the field (in network byte order) relative to 'base'.", + "format": "int32", + "type": "integer" }, - "diskSizeGb": { - "description": "The size of the disk in base-2 GB.", - "format": "int64", - "type": "string" + "size": { + "description": "Size of the field in bytes. Valid values: 1-4.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SecuritySettings": { + "description": "The authentication and authorization settings for a BackendService.", + "id": "SecuritySettings", + "properties": { + "awsV4Authentication": { + "$ref": "AWSV4Signature", + "description": "The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends." }, - "diskType": { - "description": "[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd", + "clientTlsPolicy": { + "description": "Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.", "type": "string" }, - "guestOsFeatures": { - "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", + "subjectAltNames": { + "description": "Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).", "items": { - "$ref": "GuestOsFeature" + "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "SerialPortOutput": { + "description": "An instance serial console output.", + "id": "SerialPortOutput", + "properties": { + "contents": { + "description": "[Output Only] The contents of the console output.", + "type": "string" }, - "index": { - "description": "Specifies zero-based index of the disk that is attached to the source instance.", - "format": "int32", - "type": "integer" + "kind": { + "default": "compute#serialPortOutput", + "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.", + "type": "string" }, - "interface": { - "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.", + "next": { + "description": "[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.", + "format": "int64", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "start": { + "description": "The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ServerBinding": { + "id": "ServerBinding", + "properties": { + "type": { "enum": [ - "NVME", - "SCSI" + "RESTART_NODE_ON_ANY_SERVER", + "RESTART_NODE_ON_MINIMAL_SERVERS", + "SERVER_BINDING_TYPE_UNSPECIFIED" ], "enumDescriptions": [ - "", + "Node may associate with any physical server over its lifetime.", + "Node may associate with minimal physical servers over its lifetime.", "" ], "type": "string" - }, - "kind": { - "default": "compute#savedAttachedDisk", - "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.", + } + }, + "type": "object" + }, + "ServiceAccount": { + "description": "A service account.", + "id": "ServiceAccount", + "properties": { + "email": { + "description": "Email address of the service account.", "type": "string" }, - "licenses": { - "description": "[Output Only] Any valid publicly visible licenses.", + "scopes": { + "description": "The list of scopes to be made available for this service account.", "items": { "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "ServiceAttachment": { + "description": "Represents a ServiceAttachment resource. A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service.", + "id": "ServiceAttachment", + "properties": { + "connectedEndpoints": { + "description": "[Output Only] An array of connections for all the consumers connected to this service attachment.", + "items": { + "$ref": "ServiceAttachmentConnectedEndpoint" + }, + "type": "array" }, - "mode": { - "description": "The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.", + "connectionPreference": { + "description": "The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.", "enum": [ - "READ_ONLY", - "READ_WRITE" + "ACCEPT_AUTOMATIC", + "ACCEPT_MANUAL", + "CONNECTION_PREFERENCE_UNSPECIFIED" ], "enumDescriptions": [ - "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.", - "*[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode." + "", + "", + "" ], "type": "string" }, - "source": { - "description": "Specifies a URL of the disk attached to the source instance.", - "type": "string" + "consumerAcceptLists": { + "description": "Projects that are allowed to connect to this service attachment.", + "items": { + "$ref": "ServiceAttachmentConsumerProjectLimit" + }, + "type": "array" }, - "storageBytes": { - "description": "[Output Only] A size of the storage used by the disk's snapshot by this machine image.", - "format": "int64", + "consumerRejectLists": { + "description": "Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.", + "items": { + "type": "string" + }, + "type": "array" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "storageBytesStatus": { - "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", - "enum": [ - "UPDATING", - "UP_TO_DATE" - ], - "enumDescriptions": [ - "", - "" - ], + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "type": { - "description": "Specifies the type of the attached disk, either SCRATCH or PERSISTENT.", - "enum": [ - "PERSISTENT", - "SCRATCH" - ], - "enumDescriptions": [ - "", - "" - ], + "domainNames": { + "description": "If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com.\". Current max number of domain names supported is 1.", + "items": { + "type": "string" + }, + "type": "array" + }, + "enableProxyProtocol": { + "description": "If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.", + "type": "boolean" + }, + "fingerprint": { + "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.", + "format": "byte", "type": "string" - } - }, - "type": "object" - }, - "SavedDisk": { - "description": "An instance-attached disk resource.", - "id": "SavedDisk", - "properties": { - "architecture": { - "description": "[Output Only] The architecture of the attached disk.", - "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" - ], - "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" - ], + }, + "id": { + "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "format": "uint64", "type": "string" }, "kind": { - "default": "compute#savedDisk", - "description": "[Output Only] Type of the resource. Always compute#savedDisk for attached disks.", + "default": "compute#serviceAttachment", + "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.", "type": "string" }, - "sourceDisk": { - "description": "Specifies a URL of the disk attached to the source instance.", + "name": { + "annotations": { + "required": [ + "compute.serviceAttachments.insert" + ] + }, + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "storageBytes": { - "description": "[Output Only] Size of the individual disk snapshot used by this machine image.", - "format": "int64", - "type": "string" + "natSubnets": { + "description": "An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.", + "items": { + "type": "string" + }, + "type": "array" }, - "storageBytesStatus": { - "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", - "enum": [ - "UPDATING", - "UP_TO_DATE" - ], - "enumDescriptions": [ - "", - "" - ], + "producerForwardingRule": { + "deprecated": true, + "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.", "type": "string" - } - }, - "type": "object" - }, - "ScalingScheduleStatus": { - "id": "ScalingScheduleStatus", - "properties": { - "lastStartTime": { - "description": "[Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format.", + }, + "pscServiceAttachmentId": { + "$ref": "Uint128", + "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment." + }, + "reconcileConnections": { + "description": "This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.", + "type": "boolean" + }, + "region": { + "description": "[Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, - "nextStartTime": { - "description": "[Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format.", + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "state": { - "description": "[Output Only] The current state of a scaling schedule.", - "enum": [ - "ACTIVE", - "DISABLED", - "OBSOLETE", - "READY" - ], - "enumDescriptions": [ - "The current autoscaling recommendation is influenced by this scaling schedule.", - "This scaling schedule has been disabled by the user.", - "This scaling schedule will never become active again.", - "The current autoscaling recommendation is not influenced by this scaling schedule." - ], + "targetService": { + "description": "The URL of a service serving the endpoint identified by this service attachment.", "type": "string" } }, "type": "object" }, - "Scheduling": { - "description": "Sets the scheduling options for an Instance.", - "id": "Scheduling", + "ServiceAttachmentAggregatedList": { + "description": "Contains a list of ServiceAttachmentsScopedList.", + "id": "ServiceAttachmentAggregatedList", "properties": { - "automaticRestart": { - "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", - "type": "boolean" - }, - "instanceTerminationAction": { - "description": "Specifies the termination action for the instance.", - "enum": [ - "DELETE", - "INSTANCE_TERMINATION_ACTION_UNSPECIFIED", - "STOP" - ], - "enumDescriptions": [ - "Delete the VM.", - "Default value. This value is unused.", - "Stop the VM without storing in-memory content. default action." - ], + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "localSsdRecoveryTimeout": { - "$ref": "Duration", - "description": "Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour." + "items": { + "additionalProperties": { + "$ref": "ServiceAttachmentsScopedList", + "description": "Name of the scope containing this set of ServiceAttachments." + }, + "description": "A list of ServiceAttachmentsScopedList resources.", + "type": "object" }, - "locationHint": { - "description": "An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.", + "kind": { + "default": "compute#serviceAttachmentAggregatedList", + "description": "Type of resource.", "type": "string" }, - "minNodeCpus": { - "description": "The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.", - "format": "int32", - "type": "integer" + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" }, - "nodeAffinities": { - "description": "A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.", + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", "items": { - "$ref": "SchedulingNodeAffinity" + "type": "string" }, "type": "array" }, - "onHostMaintenance": { - "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.", - "enum": [ - "MIGRATE", - "TERMINATE" - ], - "enumDescriptions": [ - "*[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.", - "Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events." - ], - "type": "string" - }, - "preemptible": { - "description": "Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.", - "type": "boolean" - }, - "provisioningModel": { - "description": "Specifies the provisioning model of the instance.", - "enum": [ - "SPOT", - "STANDARD" - ], - "enumDescriptions": [ - "Heavily discounted, no guaranteed runtime.", - "Standard provisioning with user controlled runtime, no discounts." - ], - "type": "string" + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "SchedulingNodeAffinity": { - "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.", - "id": "SchedulingNodeAffinity", + "ServiceAttachmentConnectedEndpoint": { + "description": "[Output Only] A connection connected to this service attachment.", + "id": "ServiceAttachmentConnectedEndpoint", "properties": { - "key": { - "description": "Corresponds to the label key of Node resource.", + "consumerNetwork": { + "description": "The url of the consumer network.", "type": "string" }, - "operator": { - "description": "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.", + "endpoint": { + "description": "The url of a connected endpoint.", + "type": "string" + }, + "pscConnectionId": { + "description": "The PSC connection id of the connected endpoint.", + "format": "uint64", + "type": "string" + }, + "status": { + "description": "The status of a connected endpoint to this service attachment.", "enum": [ - "IN", - "NOT_IN", - "OPERATOR_UNSPECIFIED" + "ACCEPTED", + "CLOSED", + "NEEDS_ATTENTION", + "PENDING", + "REJECTED", + "STATUS_UNSPECIFIED" ], "enumDescriptions": [ - "Requires Compute Engine to seek for matched nodes.", - "Requires Compute Engine to avoid certain nodes.", + "The connection has been accepted by the producer.", + "The connection has been closed by the producer.", + "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.", + "The connection is pending acceptance by the producer.", + "The consumer is still connected but not using the connection.", "" ], "type": "string" - }, - "values": { - "description": "Corresponds to the label values of Node resource.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "Screenshot": { - "description": "An instance's screenshot.", - "id": "Screenshot", + "ServiceAttachmentConsumerProjectLimit": { + "id": "ServiceAttachmentConsumerProjectLimit", "properties": { - "contents": { - "description": "[Output Only] The Base64-encoded screenshot data.", + "connectionLimit": { + "description": "The value of the limit to set.", + "format": "uint32", + "type": "integer" + }, + "networkUrl": { + "description": "The network URL for the network to set the limit for.", "type": "string" }, - "kind": { - "default": "compute#screenshot", - "description": "[Output Only] Type of the resource. Always compute#screenshot for the screenshots.", + "projectIdOrNum": { + "description": "The project id or number for the project to set the limit for.", "type": "string" } }, "type": "object" }, - "SecurityPoliciesAggregatedList": { - "id": "SecurityPoliciesAggregatedList", + "ServiceAttachmentList": { + "id": "ServiceAttachmentList", "properties": { - "etag": { - "type": "string" - }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "SecurityPoliciesScopedList", - "description": "Name of the scope containing this set of security policies." + "description": "A list of ServiceAttachment resources.", + "items": { + "$ref": "ServiceAttachment" }, - "description": "A list of SecurityPoliciesScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#securityPoliciesAggregatedList", - "description": "[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies.", + "default": "compute#serviceAttachmentList", + "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.", "type": "string" }, "nextPageToken": { @@ -69507,13 +72494,6 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -69638,27 +72618,18 @@ }, "type": "object" }, - "SecurityPoliciesListPreconfiguredExpressionSetsResponse": { - "id": "SecurityPoliciesListPreconfiguredExpressionSetsResponse", - "properties": { - "preconfiguredExpressionSets": { - "$ref": "SecurityPoliciesWafConfig" - } - }, - "type": "object" - }, - "SecurityPoliciesScopedList": { - "id": "SecurityPoliciesScopedList", + "ServiceAttachmentsScopedList": { + "id": "ServiceAttachmentsScopedList", "properties": { - "securityPolicies": { - "description": "A list of SecurityPolicies contained in this scope.", + "serviceAttachments": { + "description": "A list of ServiceAttachments contained in this scope.", "items": { - "$ref": "SecurityPolicy" + "$ref": "ServiceAttachment" }, "type": "array" }, "warning": { - "description": "Informational warning which replaces the list of security policies when the list is empty.", + "description": "Informational warning which replaces the list of service attachments when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -69781,53 +72752,247 @@ }, "type": "object" }, - "SecurityPoliciesWafConfig": { - "id": "SecurityPoliciesWafConfig", + "SetCommonInstanceMetadataOperationMetadata": { + "id": "SetCommonInstanceMetadataOperationMetadata", + "properties": { + "clientOperationId": { + "description": "[Output Only] The client operation id.", + "type": "string" + }, + "perLocationOperations": { + "additionalProperties": { + "$ref": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo" + }, + "description": "[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a", + "type": "object" + } + }, + "type": "object" + }, + "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo": { + "id": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo", + "properties": { + "error": { + "$ref": "Status", + "description": "[Output Only] If state is `ABANDONED` or `FAILED`, this field is populated." + }, + "state": { + "description": "[Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.", + "enum": [ + "ABANDONED", + "DONE", + "FAILED", + "PROPAGATED", + "PROPAGATING", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Operation not tracked in this location e.g. zone is marked as DOWN.", + "Operation has completed successfully.", + "Operation is in an error state.", + "Operation is confirmed to be in the location.", + "Operation is not yet confirmed to have been created in the location.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "ShareSettings": { + "description": "The share setting for reservations and sole tenancy node groups.", + "id": "ShareSettings", + "properties": { + "projectMap": { + "additionalProperties": { + "$ref": "ShareSettingsProjectConfig" + }, + "description": "A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.", + "type": "object" + }, + "shareType": { + "description": "Type of sharing for this shared-reservation", + "enum": [ + "LOCAL", + "ORGANIZATION", + "SHARE_TYPE_UNSPECIFIED", + "SPECIFIC_PROJECTS" + ], + "enumDescriptions": [ + "Default value.", + "Shared-reservation is open to entire Organization", + "Default value. This value is unused.", + "Shared-reservation is open to specific projects" + ], + "type": "string" + } + }, + "type": "object" + }, + "ShareSettingsProjectConfig": { + "description": "Config for each project in the share settings.", + "id": "ShareSettingsProjectConfig", + "properties": { + "projectId": { + "description": "The project ID, should be same as the key of this project config in the parent map.", + "type": "string" + } + }, + "type": "object" + }, + "ShieldedInstanceConfig": { + "description": "A set of Shielded Instance options.", + "id": "ShieldedInstanceConfig", + "properties": { + "enableIntegrityMonitoring": { + "description": "Defines whether the instance has integrity monitoring enabled. Enabled by default.", + "type": "boolean" + }, + "enableSecureBoot": { + "description": "Defines whether the instance has Secure Boot enabled. Disabled by default.", + "type": "boolean" + }, + "enableVtpm": { + "description": "Defines whether the instance has the vTPM enabled. Enabled by default.", + "type": "boolean" + } + }, + "type": "object" + }, + "ShieldedInstanceIdentity": { + "description": "A Shielded Instance Identity.", + "id": "ShieldedInstanceIdentity", "properties": { - "wafRules": { - "$ref": "PreconfiguredWafSet" + "encryptionKey": { + "$ref": "ShieldedInstanceIdentityEntry", + "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM." + }, + "kind": { + "default": "compute#shieldedInstanceIdentity", + "description": "[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.", + "type": "string" + }, + "signingKey": { + "$ref": "ShieldedInstanceIdentityEntry", + "description": "An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM." } }, "type": "object" }, - "SecurityPolicy": { - "description": "Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.", - "id": "SecurityPolicy", + "ShieldedInstanceIdentityEntry": { + "description": "A Shielded Instance Identity Entry.", + "id": "ShieldedInstanceIdentityEntry", "properties": { - "adaptiveProtectionConfig": { - "$ref": "SecurityPolicyAdaptiveProtectionConfig" + "ekCert": { + "description": "A PEM-encoded X.509 certificate. This field can be empty.", + "type": "string" }, - "advancedOptionsConfig": { - "$ref": "SecurityPolicyAdvancedOptionsConfig" + "ekPub": { + "description": "A PEM-encoded public key.", + "type": "string" + } + }, + "type": "object" + }, + "ShieldedInstanceIntegrityPolicy": { + "description": "The policy describes the baseline against which Instance boot integrity is measured.", + "id": "ShieldedInstanceIntegrityPolicy", + "properties": { + "updateAutoLearnPolicy": { + "description": "Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.", + "type": "boolean" + } + }, + "type": "object" + }, + "SignedUrlKey": { + "description": "Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs", + "id": "SignedUrlKey", + "properties": { + "keyName": { + "description": "Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "keyValue": { + "description": "128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.", + "type": "string" + } + }, + "type": "object" + }, + "Snapshot": { + "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", + "id": "Snapshot", + "properties": { + "architecture": { + "description": "[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" + ], + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" + ], + "type": "string" + }, + "autoCreated": { + "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.", + "type": "boolean" + }, + "chainName": { + "description": "Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.", + "type": "string" + }, + "creationSizeBytes": { + "description": "[Output Only] Size in bytes of the snapshot at creation time.", + "format": "int64", + "type": "string" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "ddosProtectionConfig": { - "$ref": "SecurityPolicyDdosProtectionConfig" - }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "fingerprint": { - "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.", - "format": "byte", + "diskSizeGb": { + "description": "[Output Only] Size of the source disk, specified in GB.", + "format": "int64", + "type": "string" + }, + "downloadBytes": { + "description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk.", + "format": "int64", "type": "string" }, + "enableConfidentialCompute": { + "description": "Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", + "type": "boolean" + }, + "guestOsFeatures": { + "description": "[Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", + "items": { + "$ref": "GuestOsFeature" + }, + "type": "array" + }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", "type": "string" }, "kind": { - "default": "compute#securityPolicy", - "description": "[Output only] Type of the resource. Always compute#securityPolicyfor security policies", + "default": "compute#snapshot", + "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.", "type": "string" }, "labelFingerprint": { - "description": "A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.", + "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.", "format": "byte", "type": "string" }, @@ -69835,148 +73000,132 @@ "additionalProperties": { "type": "string" }, - "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.", + "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.", "type": "object" }, - "name": { - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" + "licenseCodes": { + "description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" }, - "recaptchaOptionsConfig": { - "$ref": "SecurityPolicyRecaptchaOptionsConfig" + "licenses": { + "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).", + "items": { + "type": "string" + }, + "type": "array" }, - "region": { - "description": "[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.", + "locationHint": { + "description": "An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.", "type": "string" }, - "rules": { - "description": "A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"*\" for srcIpRanges and for the networkMatch condition every field must be either match \"*\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added.", - "items": { - "$ref": "SecurityPolicyRule" + "name": { + "annotations": { + "required": [ + "compute.disks.createSnapshot", + "compute.snapshots.insert" + ] }, - "type": "array" + "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "type": { - "description": "The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.", + "snapshotEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later." + }, + "snapshotType": { + "description": "Indicates the type of the snapshot.", "enum": [ - "CLOUD_ARMOR", - "CLOUD_ARMOR_EDGE", - "CLOUD_ARMOR_NETWORK" + "ARCHIVE", + "STANDARD" ], "enumDescriptions": [ - "", "", "" ], "type": "string" }, - "userDefinedFields": { - "description": "Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: \"ipv4_fragment_offset\" base: IPV4 offset: 6 size: 2 mask: \"0x1fff\"", - "items": { - "$ref": "SecurityPolicyUserDefinedField" - }, - "type": "array" - } - }, - "type": "object" - }, - "SecurityPolicyAdaptiveProtectionConfig": { - "description": "Configuration options for Cloud Armor Adaptive Protection (CAAP).", - "id": "SecurityPolicyAdaptiveProtectionConfig", - "properties": { - "layer7DdosDefenseConfig": { - "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig", - "description": "If set to true, enables Cloud Armor Machine Learning." - } - }, - "type": "object" - }, - "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig": { - "description": "Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", - "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig", - "properties": { - "enable": { - "description": "If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", - "type": "boolean" + "sourceDisk": { + "description": "The source disk used to create this snapshot.", + "type": "string" }, - "ruleVisibility": { - "description": "Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", - "enum": [ - "PREMIUM", - "STANDARD" - ], - "enumDescriptions": [ - "", - "" - ], + "sourceDiskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." + }, + "sourceDiskForRecoveryCheckpoint": { + "description": "The source disk whose recovery checkpoint will be used to create this snapshot.", "type": "string" }, - "thresholdConfigs": { - "description": "Configuration options for layer7 adaptive protection for various customizable thresholds.", - "items": { - "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig" - }, - "type": "array" - } - }, - "type": "object" - }, - "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig": { - "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig", - "properties": { - "autoDeployConfidenceThreshold": { - "format": "float", - "type": "number" + "sourceDiskId": { + "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.", + "type": "string" }, - "autoDeployExpirationSec": { - "format": "int32", - "type": "integer" + "sourceInstantSnapshot": { + "description": "The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot ", + "type": "string" }, - "autoDeployImpactedBaselineThreshold": { - "format": "float", - "type": "number" + "sourceInstantSnapshotEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." }, - "autoDeployLoadThreshold": { - "format": "float", - "type": "number" + "sourceInstantSnapshotId": { + "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", + "type": "string" }, - "name": { - "description": "The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "sourceSnapshotSchedulePolicy": { + "description": "[Output Only] URL of the resource policy which created this scheduled snapshot.", "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyAdvancedOptionsConfig": { - "id": "SecurityPolicyAdvancedOptionsConfig", - "properties": { - "jsonCustomConfig": { - "$ref": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig", - "description": "Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD." }, - "jsonParsing": { + "sourceSnapshotSchedulePolicyId": { + "description": "[Output Only] ID of the resource policy which created this scheduled snapshot.", + "type": "string" + }, + "status": { + "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.", "enum": [ - "DISABLED", - "STANDARD", - "STANDARD_WITH_GRAPHQL" + "CREATING", + "DELETING", + "FAILED", + "READY", + "UPLOADING" ], "enumDescriptions": [ - "", - "", - "" + "Snapshot creation is in progress.", + "Snapshot is currently being deleted.", + "Snapshot creation failed.", + "Snapshot has been created successfully.", + "Snapshot is being uploaded." ], "type": "string" }, - "logLevel": { + "storageBytes": { + "description": "[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.", + "format": "int64", + "type": "string" + }, + "storageBytesStatus": { + "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", "enum": [ - "NORMAL", - "VERBOSE" + "UPDATING", + "UP_TO_DATE" ], "enumDescriptions": [ "", @@ -69984,21 +73133,8 @@ ], "type": "string" }, - "userIpRequestHeaders": { - "description": "An optional list of case-insensitive request header names to use for resolving the callers client IP address.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig": { - "id": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig", - "properties": { - "contentTypes": { - "description": "A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type \"/\" subtype *[\";\" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.", + "storageLocations": { + "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).", "items": { "type": "string" }, @@ -70007,46 +73143,34 @@ }, "type": "object" }, - "SecurityPolicyDdosProtectionConfig": { - "id": "SecurityPolicyDdosProtectionConfig", - "properties": { - "ddosProtection": { - "enum": [ - "ADVANCED", - "STANDARD" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyList": { - "id": "SecurityPolicyList", + "SnapshotList": { + "description": "Contains a list of Snapshot resources.", + "id": "SnapshotList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of SecurityPolicy resources.", + "description": "A list of Snapshot resources.", "items": { - "$ref": "SecurityPolicy" + "$ref": "Snapshot" }, "type": "array" }, "kind": { - "default": "compute#securityPolicyList", - "description": "[Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies", + "default": "compute#snapshotList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -70171,483 +73295,244 @@ }, "type": "object" }, - "SecurityPolicyRecaptchaOptionsConfig": { - "id": "SecurityPolicyRecaptchaOptionsConfig", - "properties": { - "redirectSiteKey": { - "description": "An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", - "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyReference": { - "id": "SecurityPolicyReference", - "properties": { - "securityPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyRule": { - "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).", - "id": "SecurityPolicyRule", + "SnapshotSettings": { + "id": "SnapshotSettings", "properties": { - "action": { - "description": "The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. ", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "headerAction": { - "$ref": "SecurityPolicyRuleHttpHeaderAction", - "description": "Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR." - }, - "kind": { - "default": "compute#securityPolicyRule", - "description": "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules", - "type": "string" - }, - "match": { - "$ref": "SecurityPolicyRuleMatcher", - "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." - }, - "networkMatch": { - "$ref": "SecurityPolicyRuleNetworkMatcher", - "description": "A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - \"192.0.2.0/24\" - \"198.51.100.0/24\" userDefinedFields: - name: \"ipv4_fragment_offset\" values: - \"1-0x1fff\" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named \"ipv4_fragment_offset\" with a value between 1 and 0x1fff inclusive." - }, - "preconfiguredWafConfig": { - "$ref": "SecurityPolicyRulePreconfiguredWafConfig", - "description": "Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect." - }, - "preview": { - "description": "If set to true, the specified action is not enforced.", - "type": "boolean" - }, - "priority": { - "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.", - "format": "int32", - "type": "integer" - }, - "rateLimitOptions": { - "$ref": "SecurityPolicyRuleRateLimitOptions", - "description": "Must be specified if the action is \"rate_based_ban\" or \"throttle\". Cannot be specified for any other actions." - }, - "redirectOptions": { - "$ref": "SecurityPolicyRuleRedirectOptions", - "description": "Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR." + "storageLocation": { + "$ref": "SnapshotSettingsStorageLocationSettings", + "description": "Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out." } }, "type": "object" }, - "SecurityPolicyRuleHttpHeaderAction": { - "id": "SecurityPolicyRuleHttpHeaderAction", + "SnapshotSettingsStorageLocationSettings": { + "id": "SnapshotSettingsStorageLocationSettings", "properties": { - "requestHeadersToAdds": { - "description": "The list of request headers to add or overwrite if they're already present.", - "items": { - "$ref": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption" + "locations": { + "additionalProperties": { + "$ref": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference" }, - "type": "array" - } - }, - "type": "object" - }, - "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption": { - "id": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption", - "properties": { - "headerName": { - "description": "The name of the header to set.", - "type": "string" - }, - "headerValue": { - "description": "The value to set the named header to.", - "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyRuleMatcher": { - "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", - "id": "SecurityPolicyRuleMatcher", - "properties": { - "config": { - "$ref": "SecurityPolicyRuleMatcherConfig", - "description": "The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified." - }, - "expr": { - "$ref": "Expr", - "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies." - }, - "exprOptions": { - "$ref": "SecurityPolicyRuleMatcherExprOptions", - "description": "The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr')." + "description": "When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are GCS bucket locations.", + "type": "object" }, - "versionedExpr": { - "description": "Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.", + "policy": { + "description": "The chosen location policy.", "enum": [ - "SRC_IPS_V1" + "LOCAL_REGION", + "NEAREST_MULTI_REGION", + "SPECIFIC_LOCATIONS", + "STORAGE_LOCATION_POLICY_UNSPECIFIED" ], "enumDescriptions": [ - "Matches the source IP address of a request to the IP ranges supplied in config." + "Store snapshot in the same region as with the originating disk. No additional parameters are needed.", + "Store snapshot to the nearest multi region GCS bucket, relative to the originating disk. No additional parameters are needed.", + "Store snapshot in the specific locations, as specified by the user. The list of regions to store must be defined under the `locations` field.", + "" ], "type": "string" } }, "type": "object" }, - "SecurityPolicyRuleMatcherConfig": { - "id": "SecurityPolicyRuleMatcherConfig", + "SnapshotSettingsStorageLocationSettingsStorageLocationPreference": { + "description": "A structure for specifying storage locations.", + "id": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference", "properties": { - "srcIpRanges": { - "description": "CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.", - "items": { - "type": "string" - }, - "type": "array" + "name": { + "description": "Name of the location. It should be one of the GCS buckets.", + "type": "string" } }, "type": "object" }, - "SecurityPolicyRuleMatcherExprOptions": { - "id": "SecurityPolicyRuleMatcherExprOptions", + "SourceDiskEncryptionKey": { + "id": "SourceDiskEncryptionKey", "properties": { - "recaptchaOptions": { - "$ref": "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions", - "description": "reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect." + "diskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." + }, + "sourceDisk": { + "description": "URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ", + "type": "string" } }, "type": "object" }, - "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions": { - "id": "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions", + "SourceInstanceParams": { + "description": "A specification of the parameters to use when creating the instance template from a source instance.", + "id": "SourceInstanceParams", "properties": { - "actionTokenSiteKeys": { - "description": "A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.", - "items": { - "type": "string" - }, - "type": "array" - }, - "sessionTokenSiteKeys": { - "description": "A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.", + "diskConfigs": { + "description": "Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.", "items": { - "type": "string" + "$ref": "DiskInstantiationConfig" }, "type": "array" } }, "type": "object" }, - "SecurityPolicyRuleNetworkMatcher": { - "description": "Represents a match condition that incoming network traffic is evaluated against.", - "id": "SecurityPolicyRuleNetworkMatcher", + "SourceInstanceProperties": { + "description": "DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.", + "id": "SourceInstanceProperties", "properties": { - "destIpRanges": { - "description": "Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.", - "items": { - "type": "string" - }, - "type": "array" + "canIpForward": { + "description": "Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", + "type": "boolean" }, - "destPorts": { - "description": "Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. \"80\") or range (e.g. \"0-1023\").", - "items": { - "type": "string" - }, - "type": "array" + "deletionProtection": { + "description": "Whether the instance created from this machine image should be protected against deletion.", + "type": "boolean" }, - "ipProtocols": { - "description": "IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. \"6\"), range (e.g. \"253-254\"), or one of the following protocol names: \"tcp\", \"udp\", \"icmp\", \"esp\", \"ah\", \"ipip\", or \"sctp\".", - "items": { - "type": "string" - }, - "type": "array" + "description": { + "description": "An optional text description for the instances that are created from this machine image.", + "type": "string" }, - "srcAsns": { - "description": "BGP Autonomous System Number associated with the source IP address.", + "disks": { + "description": "An array of disks that are associated with the instances that are created from this machine image.", "items": { - "format": "uint32", - "type": "integer" + "$ref": "SavedAttachedDisk" }, "type": "array" }, - "srcIpRanges": { - "description": "Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.", + "guestAccelerators": { + "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image.", "items": { - "type": "string" + "$ref": "AcceleratorConfig" }, "type": "array" }, - "srcPorts": { - "description": "Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. \"80\") or range (e.g. \"0-1023\").", - "items": { - "type": "string" - }, - "type": "array" + "keyRevocationActionType": { + "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", + "enum": [ + "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "NONE", + "STOP" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Indicates user chose no operation.", + "Indicates user chose to opt for VM shutdown on key revocation." + ], + "type": "string" }, - "srcRegionCodes": { - "description": "Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.", - "items": { + "labels": { + "additionalProperties": { "type": "string" }, - "type": "array" + "description": "Labels to apply to instances that are created from this machine image.", + "type": "object" }, - "userDefinedFields": { - "description": "User-defined fields. Each element names a defined field and lists the matching values for that field.", - "items": { - "$ref": "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch" - }, - "type": "array" - } - }, - "type": "object" - }, - "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch": { - "id": "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch", - "properties": { - "name": { - "description": "Name of the user-defined field, as given in the definition.", + "machineType": { + "description": "The machine type to use for instances that are created from this machine image.", "type": "string" }, - "values": { - "description": "Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with \"0x\") number (e.g. \"64\") or range (e.g. \"0x400-0x7ff\").", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "SecurityPolicyRulePreconfiguredWafConfig": { - "id": "SecurityPolicyRulePreconfiguredWafConfig", - "properties": { - "exclusions": { - "description": "A list of exclusions to apply during preconfigured WAF evaluation.", - "items": { - "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusion" - }, - "type": "array" - } - }, - "type": "object" - }, - "SecurityPolicyRulePreconfiguredWafConfigExclusion": { - "id": "SecurityPolicyRulePreconfiguredWafConfigExclusion", - "properties": { - "requestCookiesToExclude": { - "description": "A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.", - "items": { - "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" - }, - "type": "array" + "metadata": { + "$ref": "Metadata", + "description": "The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information." }, - "requestHeadersToExclude": { - "description": "A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.", - "items": { - "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" - }, - "type": "array" + "minCpuPlatform": { + "description": "Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.", + "type": "string" }, - "requestQueryParamsToExclude": { - "description": "A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.", + "networkInterfaces": { + "description": "An array of network access configurations for this interface.", "items": { - "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" + "$ref": "NetworkInterface" }, "type": "array" }, - "requestUrisToExclude": { - "description": "A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.", - "items": { - "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" - }, - "type": "array" + "scheduling": { + "$ref": "Scheduling", + "description": "Specifies the scheduling options for the instances that are created from this machine image." }, - "targetRuleIds": { - "description": "A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.", + "serviceAccounts": { + "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.", "items": { - "type": "string" + "$ref": "ServiceAccount" }, "type": "array" }, - "targetRuleSet": { - "description": "Target WAF rule set to apply the preconfigured WAF exclusion.", - "type": "string" + "tags": { + "$ref": "Tags", + "description": "A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035." } }, "type": "object" }, - "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams": { - "id": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams", + "SslCertificate": { + "description": "Represents an SSL certificate resource. Google Compute Engine has two SSL certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The global SSL certificates (sslCertificates) are used by: - Global external Application Load Balancers - Classic Application Load Balancers - Proxy Network Load Balancers (with target SSL proxies) The regional SSL certificates (regionSslCertificates) are used by: - Regional external Application Load Balancers - Regional internal Application Load Balancers Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.", + "id": "SslCertificate", "properties": { - "op": { - "description": "The match operator for the field.", - "enum": [ - "CONTAINS", - "ENDS_WITH", - "EQUALS", - "EQUALS_ANY", - "STARTS_WITH" - ], - "enumDescriptions": [ - "The operator matches if the field value contains the specified value.", - "The operator matches if the field value ends with the specified value.", - "The operator matches if the field value equals the specified value.", - "The operator matches if the field value is any value.", - "The operator matches if the field value starts with the specified value." - ], + "certificate": { + "description": "A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", "type": "string" }, - "val": { - "description": "The value of the field.", + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyRuleRateLimitOptions": { - "id": "SecurityPolicyRuleRateLimitOptions", - "properties": { - "banDurationSec": { - "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.", - "format": "int32", - "type": "integer" - }, - "banThreshold": { - "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold", - "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'." }, - "conformAction": { - "description": "Action to take for requests that are under the configured rate limit threshold. Valid option is \"allow\" only.", + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "enforceOnKey": { - "description": "Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if \"enforceOnKey\" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on \"userIpRequestHeaders\" configured with the security policy. If there is no \"userIpRequestHeaders\" configuration or an IP address cannot be resolved from it, the key type defaults to IP. ", - "enum": [ - "ALL", - "HTTP_COOKIE", - "HTTP_HEADER", - "HTTP_PATH", - "IP", - "REGION_CODE", - "SNI", - "TLS_JA3_FINGERPRINT", - "USER_IP", - "XFF_IP" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], + "expireTime": { + "description": "[Output Only] Expire time of the certificate. RFC3339", "type": "string" }, - "enforceOnKeyConfigs": { - "description": "If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.", - "items": { - "$ref": "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig" - }, - "type": "array" - }, - "enforceOnKeyName": { - "description": "Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.", + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", "type": "string" }, - "exceedAction": { - "description": "Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.", + "kind": { + "default": "compute#sslCertificate", + "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.", "type": "string" }, - "exceedRedirectOptions": { - "$ref": "SecurityPolicyRuleRedirectOptions", - "description": "Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR." + "managed": { + "$ref": "SslCertificateManagedSslCertificate", + "description": "Configuration and status of a managed SSL certificate." }, - "rateLimitThreshold": { - "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold", - "description": "Threshold at which to begin ratelimiting." - } - }, - "type": "object" - }, - "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig": { - "id": "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig", - "properties": { - "enforceOnKeyName": { - "description": "Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.", + "name": { + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "enforceOnKeyType": { - "description": "Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if \"enforceOnKeyConfigs\" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on \"userIpRequestHeaders\" configured with the security policy. If there is no \"userIpRequestHeaders\" configuration or an IP address cannot be resolved from it, the key type defaults to IP. ", - "enum": [ - "ALL", - "HTTP_COOKIE", - "HTTP_HEADER", - "HTTP_PATH", - "IP", - "REGION_CODE", - "SNI", - "TLS_JA3_FINGERPRINT", - "USER_IP", - "XFF_IP" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], + "privateKey": { + "description": "A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.", "type": "string" - } - }, - "type": "object" - }, - "SecurityPolicyRuleRateLimitOptionsThreshold": { - "id": "SecurityPolicyRuleRateLimitOptionsThreshold", - "properties": { - "count": { - "description": "Number of HTTP(S) requests for calculating the threshold.", - "format": "int32", - "type": "integer" }, - "intervalSec": { - "description": "Interval over which the threshold is computed.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "SecurityPolicyRuleRedirectOptions": { - "id": "SecurityPolicyRuleRedirectOptions", - "properties": { - "target": { - "description": "Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.", + "region": { + "description": "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.", + "type": "string" + }, + "selfLink": { + "description": "[Output only] Server-defined URL for the resource.", "type": "string" }, + "selfManaged": { + "$ref": "SslCertificateSelfManagedSslCertificate", + "description": "Configuration and status of a self-managed SSL certificate." + }, + "subjectAlternativeNames": { + "description": "[Output Only] Domains associated with the certificate via Subject Alternative Name.", + "items": { + "type": "string" + }, + "type": "array" + }, "type": { - "description": "Type of the redirect action.", + "description": "(Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or \"MANAGED\". If not specified, the certificate is self-managed and the fields certificate and private_key are used.", "enum": [ - "EXTERNAL_302", - "GOOGLE_RECAPTCHA" + "MANAGED", + "SELF_MANAGED", + "TYPE_UNSPECIFIED" ], "enumDescriptions": [ - "", + "Google-managed SSLCertificate.", + "Certificate uploaded by user.", "" ], "type": "string" @@ -70655,272 +73540,546 @@ }, "type": "object" }, - "SecurityPolicyUserDefinedField": { - "id": "SecurityPolicyUserDefinedField", + "SslCertificateAggregatedList": { + "id": "SslCertificateAggregatedList", "properties": { - "base": { - "description": "The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required", - "enum": [ - "IPV4", - "IPV6", - "TCP", - "UDP" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "mask": { - "description": "If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with \"0x\"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.", + "items": { + "additionalProperties": { + "$ref": "SslCertificatesScopedList", + "description": "Name of the scope containing this set of SslCertificates." + }, + "description": "A list of SslCertificatesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#sslCertificateAggregatedList", + "description": "[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.", "type": "string" }, - "name": { - "description": "The name of this field. Must be unique within the policy.", + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, - "offset": { - "description": "Offset of the first byte of the field (in network byte order) relative to 'base'.", - "format": "int32", - "type": "integer" + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" }, - "size": { - "description": "Size of the field in bytes. Valid values: 1-4.", - "format": "int32", - "type": "integer" + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "SecuritySettings": { - "description": "The authentication and authorization settings for a BackendService.", - "id": "SecuritySettings", + "SslCertificateList": { + "description": "Contains a list of SslCertificate resources.", + "id": "SslCertificateList", "properties": { - "awsV4Authentication": { - "$ref": "AWSV4Signature", - "description": "The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends." - }, - "clientTlsPolicy": { - "description": "Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.", + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "subjectAltNames": { - "description": "Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).", + "items": { + "description": "A list of SslCertificate resources.", "items": { - "type": "string" + "$ref": "SslCertificate" }, "type": "array" - } - }, - "type": "object" - }, - "SerialPortOutput": { - "description": "An instance serial console output.", - "id": "SerialPortOutput", - "properties": { - "contents": { - "description": "[Output Only] The contents of the console output.", - "type": "string" }, "kind": { - "default": "compute#serialPortOutput", - "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.", + "default": "compute#sslCertificateList", + "description": "Type of resource.", "type": "string" }, - "next": { - "description": "[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.", - "format": "int64", + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "start": { - "description": "The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.", - "format": "int64", - "type": "string" + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "ServerBinding": { - "id": "ServerBinding", + "SslCertificateManagedSslCertificate": { + "description": "Configuration and status of a managed SSL certificate.", + "id": "SslCertificateManagedSslCertificate", "properties": { - "type": { + "domainStatus": { + "additionalProperties": { + "enum": [ + "ACTIVE", + "DOMAIN_STATUS_UNSPECIFIED", + "FAILED_CAA_CHECKING", + "FAILED_CAA_FORBIDDEN", + "FAILED_NOT_VISIBLE", + "FAILED_RATE_LIMITED", + "PROVISIONING" + ], + "enumDescriptions": [ + "A managed certificate can be provisioned, no issues for this domain.", + "", + "Failed to check CAA records for the domain.", + "Certificate issuance forbidden by an explicit CAA record for the domain.", + "There seems to be problem with the user's DNS or load balancer configuration for this domain.", + "Reached rate-limit for certificates per top-level private domain.", + "Certificate provisioning for this domain is under way. GCP will attempt to provision the first certificate." + ], + "type": "string" + }, + "description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.", + "type": "object" + }, + "domains": { + "description": "The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).", + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "[Output only] Status of the managed certificate resource.", "enum": [ - "RESTART_NODE_ON_ANY_SERVER", - "RESTART_NODE_ON_MINIMAL_SERVERS", - "SERVER_BINDING_TYPE_UNSPECIFIED" + "ACTIVE", + "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED", + "PROVISIONING", + "PROVISIONING_FAILED", + "PROVISIONING_FAILED_PERMANENTLY", + "RENEWAL_FAILED" ], "enumDescriptions": [ - "Node may associate with any physical server over its lifetime.", - "Node may associate with minimal physical servers over its lifetime.", - "" + "The certificate management is working, and a certificate has been provisioned.", + "", + "The certificate management is working. GCP will attempt to provision the first certificate.", + "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.", + "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won't be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.", + "Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field." ], "type": "string" } }, "type": "object" }, - "ServiceAccount": { - "description": "A service account.", - "id": "ServiceAccount", + "SslCertificateSelfManagedSslCertificate": { + "description": "Configuration and status of a self-managed SSL certificate.", + "id": "SslCertificateSelfManagedSslCertificate", "properties": { - "email": { - "description": "Email address of the service account.", + "certificate": { + "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", "type": "string" }, - "scopes": { - "description": "The list of scopes to be made available for this service account.", - "items": { - "type": "string" - }, - "type": "array" + "privateKey": { + "description": "A write-only private key in PEM format. Only insert requests will include this field.", + "type": "string" } }, "type": "object" }, - "ServiceAttachment": { - "description": "Represents a ServiceAttachment resource. A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service.", - "id": "ServiceAttachment", + "SslCertificatesScopedList": { + "id": "SslCertificatesScopedList", "properties": { - "connectedEndpoints": { - "description": "[Output Only] An array of connections for all the consumers connected to this service attachment.", - "items": { - "$ref": "ServiceAttachmentConnectedEndpoint" - }, - "type": "array" - }, - "connectionPreference": { - "description": "The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.", - "enum": [ - "ACCEPT_AUTOMATIC", - "ACCEPT_MANUAL", - "CONNECTION_PREFERENCE_UNSPECIFIED" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "type": "string" - }, - "consumerAcceptLists": { - "description": "Projects that are allowed to connect to this service attachment.", - "items": { - "$ref": "ServiceAttachmentConsumerProjectLimit" - }, - "type": "array" - }, - "consumerRejectLists": { - "description": "Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.", - "items": { - "type": "string" - }, - "type": "array" - }, - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "domainNames": { - "description": "If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com.\". Current max number of domain names supported is 1.", + "sslCertificates": { + "description": "List of SslCertificates contained in this scope.", "items": { - "type": "string" + "$ref": "SslCertificate" }, "type": "array" }, - "enableProxyProtocol": { - "description": "If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.", - "type": "boolean" - }, - "fingerprint": { - "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.", - "format": "byte", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#serviceAttachment", - "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.", - "type": "string" - }, - "name": { - "annotations": { - "required": [ - "compute.serviceAttachments.insert" - ] - }, - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "natSubnets": { - "description": "An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.", - "items": { - "type": "string" + "warning": { + "description": "Informational warning which replaces the list of backend services when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } }, - "type": "array" - }, - "producerForwardingRule": { - "deprecated": true, - "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.", - "type": "string" - }, - "pscServiceAttachmentId": { - "$ref": "Uint128", - "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment." - }, - "reconcileConnections": { - "description": "This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.", - "type": "boolean" - }, - "region": { - "description": "[Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "targetService": { - "description": "The URL of a service serving the endpoint identified by this service attachment.", - "type": "string" + "type": "object" } }, "type": "object" }, - "ServiceAttachmentAggregatedList": { - "description": "Contains a list of ServiceAttachmentsScopedList.", - "id": "ServiceAttachmentAggregatedList", + "SslPoliciesAggregatedList": { + "id": "SslPoliciesAggregatedList", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "additionalProperties": { - "$ref": "ServiceAttachmentsScopedList", - "description": "Name of the scope containing this set of ServiceAttachments." + "$ref": "SslPoliciesScopedList", + "description": "Name of the scope containing this set of SSL policies." }, - "description": "A list of ServiceAttachmentsScopedList resources.", + "description": "A list of SslPoliciesScopedList resources.", "type": "object" }, "kind": { - "default": "compute#serviceAttachmentAggregatedList", - "description": "Type of resource.", + "default": "compute#sslPoliciesAggregatedList", + "description": "[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies.", "type": "string" }, "nextPageToken": { @@ -71062,82 +74221,23 @@ }, "type": "object" }, - "ServiceAttachmentConnectedEndpoint": { - "description": "[Output Only] A connection connected to this service attachment.", - "id": "ServiceAttachmentConnectedEndpoint", - "properties": { - "consumerNetwork": { - "description": "The url of the consumer network.", - "type": "string" - }, - "endpoint": { - "description": "The url of a connected endpoint.", - "type": "string" - }, - "pscConnectionId": { - "description": "The PSC connection id of the connected endpoint.", - "format": "uint64", - "type": "string" - }, - "status": { - "description": "The status of a connected endpoint to this service attachment.", - "enum": [ - "ACCEPTED", - "CLOSED", - "NEEDS_ATTENTION", - "PENDING", - "REJECTED", - "STATUS_UNSPECIFIED" - ], - "enumDescriptions": [ - "The connection has been accepted by the producer.", - "The connection has been closed by the producer.", - "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.", - "The connection is pending acceptance by the producer.", - "The consumer is still connected but not using the connection.", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "ServiceAttachmentConsumerProjectLimit": { - "id": "ServiceAttachmentConsumerProjectLimit", - "properties": { - "connectionLimit": { - "description": "The value of the limit to set.", - "format": "uint32", - "type": "integer" - }, - "networkUrl": { - "description": "The network URL for the network to set the limit for.", - "type": "string" - }, - "projectIdOrNum": { - "description": "The project id or number for the project to set the limit for.", - "type": "string" - } - }, - "type": "object" - }, - "ServiceAttachmentList": { - "id": "ServiceAttachmentList", + "SslPoliciesList": { + "id": "SslPoliciesList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of ServiceAttachment resources.", + "description": "A list of SslPolicy resources.", "items": { - "$ref": "ServiceAttachment" + "$ref": "SslPolicy" }, "type": "array" }, "kind": { - "default": "compute#serviceAttachmentList", - "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.", + "default": "compute#sslPoliciesList", + "description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.", "type": "string" }, "nextPageToken": { @@ -71272,18 +74372,30 @@ }, "type": "object" }, - "ServiceAttachmentsScopedList": { - "id": "ServiceAttachmentsScopedList", + "SslPoliciesListAvailableFeaturesResponse": { + "id": "SslPoliciesListAvailableFeaturesResponse", "properties": { - "serviceAttachments": { - "description": "A list of ServiceAttachments contained in this scope.", + "features": { "items": { - "$ref": "ServiceAttachment" + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SslPoliciesScopedList": { + "id": "SslPoliciesScopedList", + "properties": { + "sslPolicies": { + "description": "A list of SslPolicies contained in this scope.", + "items": { + "$ref": "SslPolicy" }, "type": "array" }, "warning": { - "description": "Informational warning which replaces the list of service attachments when the list is empty.", + "description": "Informational warning which replaces the list of SSL policies when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -71406,206 +74518,345 @@ }, "type": "object" }, - "SetCommonInstanceMetadataOperationMetadata": { - "id": "SetCommonInstanceMetadataOperationMetadata", + "SslPolicy": { + "description": "Represents an SSL Policy resource. Use SSL policies to control SSL features, such as versions and cipher suites, that are offered by Application Load Balancers and proxy Network Load Balancers. For more information, read SSL policies overview.", + "id": "SslPolicy", "properties": { - "clientOperationId": { - "description": "[Output Only] The client operation id.", + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "perLocationOperations": { - "additionalProperties": { - "$ref": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo" + "customFeatures": { + "description": "A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.", + "items": { + "type": "string" }, - "description": "[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a", - "type": "object" - } - }, - "type": "object" - }, - "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo": { - "id": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo", - "properties": { - "error": { - "$ref": "Status", - "description": "[Output Only] If state is `ABANDONED` or `FAILED`, this field is populated." + "type": "array" }, - "state": { - "description": "[Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.", + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "enabledFeatures": { + "description": "[Output Only] The list of features enabled in the SSL policy.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fingerprint": { + "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.", + "format": "byte", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#sslPolicy", + "description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.", + "type": "string" + }, + "minTlsVersion": { + "description": "The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.", "enum": [ - "ABANDONED", - "DONE", - "FAILED", - "PROPAGATED", - "PROPAGATING", - "UNSPECIFIED" + "TLS_1_0", + "TLS_1_1", + "TLS_1_2" ], "enumDescriptions": [ - "Operation not tracked in this location e.g. zone is marked as DOWN.", - "Operation has completed successfully.", - "Operation is in an error state.", - "Operation is confirmed to be in the location.", - "Operation is not yet confirmed to have been created in the location.", - "" + "TLS 1.0", + "TLS 1.1", + "TLS 1.2" ], "type": "string" - } - }, - "type": "object" - }, - "ShareSettings": { - "description": "The share setting for reservations and sole tenancy node groups.", - "id": "ShareSettings", - "properties": { - "projectMap": { - "additionalProperties": { - "$ref": "ShareSettingsProjectConfig" - }, - "description": "A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.", - "type": "object" }, - "shareType": { - "description": "Type of sharing for this shared-reservation", + "name": { + "description": "Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "profile": { + "description": "Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.", "enum": [ - "LOCAL", - "ORGANIZATION", - "SHARE_TYPE_UNSPECIFIED", - "SPECIFIC_PROJECTS" + "COMPATIBLE", + "CUSTOM", + "MODERN", + "RESTRICTED" ], "enumDescriptions": [ - "Default value.", - "Shared-reservation is open to entire Organization", - "Default value. This value is unused.", - "Shared-reservation is open to specific projects" + "Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.", + "Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.", + "Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.", + "Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements." ], "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "warnings": { + "description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.", + "items": { + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" } }, "type": "object" }, - "ShareSettingsProjectConfig": { - "description": "Config for each project in the share settings.", - "id": "ShareSettingsProjectConfig", + "SslPolicyReference": { + "id": "SslPolicyReference", "properties": { - "projectId": { - "description": "The project ID, should be same as the key of this project config in the parent map.", + "sslPolicy": { + "description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.", "type": "string" } }, "type": "object" }, - "ShieldedInstanceConfig": { - "description": "A set of Shielded Instance options.", - "id": "ShieldedInstanceConfig", + "StatefulPolicy": { + "id": "StatefulPolicy", "properties": { - "enableIntegrityMonitoring": { - "description": "Defines whether the instance has integrity monitoring enabled. Enabled by default.", - "type": "boolean" - }, - "enableSecureBoot": { - "description": "Defines whether the instance has Secure Boot enabled. Disabled by default.", - "type": "boolean" - }, - "enableVtpm": { - "description": "Defines whether the instance has the vTPM enabled. Enabled by default.", - "type": "boolean" + "preservedState": { + "$ref": "StatefulPolicyPreservedState" } }, "type": "object" }, - "ShieldedInstanceIdentity": { - "description": "A Shielded Instance Identity.", - "id": "ShieldedInstanceIdentity", + "StatefulPolicyPreservedState": { + "description": "Configuration of preserved resources.", + "id": "StatefulPolicyPreservedState", "properties": { - "encryptionKey": { - "$ref": "ShieldedInstanceIdentityEntry", - "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM." + "disks": { + "additionalProperties": { + "$ref": "StatefulPolicyPreservedStateDiskDevice" + }, + "description": "Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.", + "type": "object" }, - "kind": { - "default": "compute#shieldedInstanceIdentity", - "description": "[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.", - "type": "string" + "externalIPs": { + "additionalProperties": { + "$ref": "StatefulPolicyPreservedStateNetworkIp" + }, + "description": "External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", + "type": "object" }, - "signingKey": { - "$ref": "ShieldedInstanceIdentityEntry", - "description": "An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM." + "internalIPs": { + "additionalProperties": { + "$ref": "StatefulPolicyPreservedStateNetworkIp" + }, + "description": "Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", + "type": "object" } }, "type": "object" }, - "ShieldedInstanceIdentityEntry": { - "description": "A Shielded Instance Identity Entry.", - "id": "ShieldedInstanceIdentityEntry", + "StatefulPolicyPreservedStateDiskDevice": { + "id": "StatefulPolicyPreservedStateDiskDevice", "properties": { - "ekCert": { - "description": "A PEM-encoded X.509 certificate. This field can be empty.", - "type": "string" - }, - "ekPub": { - "description": "A PEM-encoded public key.", + "autoDelete": { + "description": "These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", + "enum": [ + "NEVER", + "ON_PERMANENT_INSTANCE_DELETION" + ], + "enumDescriptions": [ + "", + "" + ], "type": "string" } }, "type": "object" }, - "ShieldedInstanceIntegrityPolicy": { - "description": "The policy describes the baseline against which Instance boot integrity is measured.", - "id": "ShieldedInstanceIntegrityPolicy", + "StatefulPolicyPreservedStateNetworkIp": { + "id": "StatefulPolicyPreservedStateNetworkIp", "properties": { - "updateAutoLearnPolicy": { - "description": "Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.", - "type": "boolean" + "autoDelete": { + "description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", + "enum": [ + "NEVER", + "ON_PERMANENT_INSTANCE_DELETION" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" } }, "type": "object" }, - "SignedUrlKey": { - "description": "Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs", - "id": "SignedUrlKey", + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", "properties": { - "keyName": { - "description": "Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" }, - "keyValue": { - "description": "128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.", + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, - "Snapshot": { - "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", - "id": "Snapshot", + "StoragePool": { + "description": "Represents a zonal storage pool resource.", + "id": "StoragePool", "properties": { - "architecture": { - "description": "[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.", + "capacityProvisioningType": { + "description": "Provisioning type of the byte capacity of the pool.", "enum": [ - "ARCHITECTURE_UNSPECIFIED", - "ARM64", - "X86_64" + "ADVANCED", + "STANDARD", + "UNSPECIFIED" ], "enumDescriptions": [ - "Default value indicating Architecture is not set.", - "Machines with architecture ARM64", - "Machines with architecture X86_64" + "Advanced provisioning \"thinly\" allocates the related resource.", + "Standard provisioning allocates the related resource for the pool disks' exclusive use.", + "" ], "type": "string" }, - "autoCreated": { - "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.", - "type": "boolean" - }, - "chainName": { - "description": "Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.", - "type": "string" - }, - "creationSizeBytes": { - "description": "[Output Only] Size in bytes of the snapshot at creation time.", - "format": "int64", - "type": "string" - }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -71614,39 +74865,18 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "diskSizeGb": { - "description": "[Output Only] Size of the source disk, specified in GB.", - "format": "int64", - "type": "string" - }, - "downloadBytes": { - "description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk.", - "format": "int64", - "type": "string" - }, - "enableConfidentialCompute": { - "description": "Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", - "type": "boolean" - }, - "guestOsFeatures": { - "description": "[Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", - "items": { - "$ref": "GuestOsFeature" - }, - "type": "array" - }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", "type": "string" }, "kind": { - "default": "compute#snapshot", - "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.", + "default": "compute#storagePool", + "description": "[Output Only] Type of the resource. Always compute#storagePool for storage pools.", "type": "string" }, "labelFingerprint": { - "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.", + "description": "A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.", "format": "byte", "type": "string" }, @@ -71654,167 +74884,112 @@ "additionalProperties": { "type": "string" }, - "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.", + "description": "Labels to apply to this storage pool. These can be later modified by the setLabels method.", "type": "object" }, - "licenseCodes": { - "description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.", - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - }, - "licenses": { - "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).", - "items": { - "type": "string" - }, - "type": "array" - }, - "locationHint": { - "description": "An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.", - "type": "string" - }, "name": { "annotations": { "required": [ - "compute.disks.createSnapshot", - "compute.snapshots.insert" + "compute.storagePools.insert" ] }, - "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzs": { - "description": "[Output Only] Reserved for future use.", - "type": "boolean" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "snapshotEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later." - }, - "snapshotType": { - "description": "Indicates the type of the snapshot.", + "performanceProvisioningType": { + "description": "Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.", "enum": [ - "ARCHIVE", - "STANDARD" + "ADVANCED", + "STANDARD", + "UNSPECIFIED" ], "enumDescriptions": [ - "", + "Advanced provisioning \"thinly\" allocates the related resource.", + "Standard provisioning allocates the related resource for the pool disks' exclusive use.", "" ], "type": "string" }, - "sourceDisk": { - "description": "The source disk used to create this snapshot.", - "type": "string" - }, - "sourceDiskEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." - }, - "sourceDiskForRecoveryCheckpoint": { - "description": "The source disk whose recovery checkpoint will be used to create this snapshot.", + "poolProvisionedCapacityGb": { + "description": "Size, in GiB, of the storage pool.", + "format": "int64", "type": "string" }, - "sourceDiskId": { - "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.", + "poolProvisionedIops": { + "description": "Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.", + "format": "int64", "type": "string" }, - "sourceInstantSnapshot": { - "description": "The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot ", + "poolProvisionedThroughput": { + "description": "Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.", + "format": "int64", "type": "string" }, - "sourceInstantSnapshotEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." - }, - "sourceInstantSnapshotId": { - "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", - "type": "string" + "resourceStatus": { + "$ref": "StoragePoolResourceStatus", + "description": "[Output Only] Status information for the storage pool resource." }, - "sourceSnapshotSchedulePolicy": { - "description": "[Output Only] URL of the resource policy which created this scheduled snapshot.", + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" }, - "sourceSnapshotSchedulePolicyId": { - "description": "[Output Only] ID of the resource policy which created this scheduled snapshot.", + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", "type": "string" }, - "status": { - "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.", + "state": { + "description": "[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. ", "enum": [ "CREATING", "DELETING", "FAILED", - "READY", - "UPLOADING" + "READY" ], "enumDescriptions": [ - "Snapshot creation is in progress.", - "Snapshot is currently being deleted.", - "Snapshot creation failed.", - "Snapshot has been created successfully.", - "Snapshot is being uploaded." + "StoragePool is provisioning", + "StoragePool is deleting.", + "StoragePool creation failed.", + "StoragePool is ready for use." ], "type": "string" }, - "storageBytes": { - "description": "[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.", - "format": "int64", - "type": "string" + "status": { + "$ref": "StoragePoolResourceStatus", + "description": "[Output Only] Status information for the storage pool resource." }, - "storageBytesStatus": { - "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", - "enum": [ - "UPDATING", - "UP_TO_DATE" - ], - "enumDescriptions": [ - "", - "" - ], + "storagePoolType": { + "description": "Type of the storage pool.", "type": "string" }, - "storageLocations": { - "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).", - "items": { - "type": "string" - }, - "type": "array" + "zone": { + "description": "[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" } }, "type": "object" }, - "SnapshotList": { - "description": "Contains a list of Snapshot resources.", - "id": "SnapshotList", + "StoragePoolAggregatedList": { + "id": "StoragePoolAggregatedList", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of Snapshot resources.", - "items": { - "$ref": "Snapshot" + "additionalProperties": { + "$ref": "StoragePoolsScopedList", + "description": "[Output Only] Name of the scope containing this set of storage pool." }, - "type": "array" + "description": "A list of StoragePoolsScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#snapshotList", - "description": "Type of resource.", + "default": "compute#storagePoolAggregatedList", + "description": "[Output Only] Type of resource. Always compute#storagePoolAggregatedList for aggregated lists of storage pools.", "type": "string" }, "nextPageToken": { @@ -71825,6 +75000,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -71949,269 +75131,103 @@ }, "type": "object" }, - "SnapshotSettings": { - "id": "SnapshotSettings", - "properties": { - "storageLocation": { - "$ref": "SnapshotSettingsStorageLocationSettings", - "description": "Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out." - } - }, - "type": "object" - }, - "SnapshotSettingsStorageLocationSettings": { - "id": "SnapshotSettingsStorageLocationSettings", - "properties": { - "locations": { - "additionalProperties": { - "$ref": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference" - }, - "description": "When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are GCS bucket locations.", - "type": "object" - }, - "policy": { - "description": "The chosen location policy.", - "enum": [ - "LOCAL_REGION", - "NEAREST_MULTI_REGION", - "SPECIFIC_LOCATIONS", - "STORAGE_LOCATION_POLICY_UNSPECIFIED" - ], - "enumDescriptions": [ - "Store snapshot in the same region as with the originating disk. No additional parameters are needed.", - "Store snapshot to the nearest multi region GCS bucket, relative to the originating disk. No additional parameters are needed.", - "Store snapshot in the specific locations, as specified by the user. The list of regions to store must be defined under the `locations` field.", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "SnapshotSettingsStorageLocationSettingsStorageLocationPreference": { - "description": "A structure for specifying storage locations.", - "id": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference", - "properties": { - "name": { - "description": "Name of the location. It should be one of the GCS buckets.", - "type": "string" - } - }, - "type": "object" - }, - "SourceDiskEncryptionKey": { - "id": "SourceDiskEncryptionKey", - "properties": { - "diskEncryptionKey": { - "$ref": "CustomerEncryptionKey", - "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." - }, - "sourceDisk": { - "description": "URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ", - "type": "string" - } - }, - "type": "object" - }, - "SourceInstanceParams": { - "description": "A specification of the parameters to use when creating the instance template from a source instance.", - "id": "SourceInstanceParams", - "properties": { - "diskConfigs": { - "description": "Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.", - "items": { - "$ref": "DiskInstantiationConfig" - }, - "type": "array" - } - }, - "type": "object" - }, - "SourceInstanceProperties": { - "description": "DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.", - "id": "SourceInstanceProperties", + "StoragePoolDisk": { + "id": "StoragePoolDisk", "properties": { - "canIpForward": { - "description": "Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", - "type": "boolean" - }, - "deletionProtection": { - "description": "Whether the instance created from this machine image should be protected against deletion.", - "type": "boolean" - }, - "description": { - "description": "An optional text description for the instances that are created from this machine image.", - "type": "string" - }, - "disks": { - "description": "An array of disks that are associated with the instances that are created from this machine image.", - "items": { - "$ref": "SavedAttachedDisk" - }, - "type": "array" - }, - "guestAccelerators": { - "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image.", + "attachedInstances": { + "description": "[Output Only] Instances this disk is attached to.", "items": { - "$ref": "AcceleratorConfig" - }, - "type": "array" - }, - "keyRevocationActionType": { - "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", - "enum": [ - "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", - "NONE", - "STOP" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "Indicates user chose no operation.", - "Indicates user chose to opt for VM shutdown on key revocation." - ], - "type": "string" - }, - "labels": { - "additionalProperties": { "type": "string" }, - "description": "Labels to apply to instances that are created from this machine image.", - "type": "object" - }, - "machineType": { - "description": "The machine type to use for instances that are created from this machine image.", - "type": "string" - }, - "metadata": { - "$ref": "Metadata", - "description": "The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information." - }, - "minCpuPlatform": { - "description": "Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.", - "type": "string" - }, - "networkInterfaces": { - "description": "An array of network access configurations for this interface.", - "items": { - "$ref": "NetworkInterface" - }, - "type": "array" - }, - "scheduling": { - "$ref": "Scheduling", - "description": "Specifies the scheduling options for the instances that are created from this machine image." - }, - "serviceAccounts": { - "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.", - "items": { - "$ref": "ServiceAccount" - }, "type": "array" }, - "tags": { - "$ref": "Tags", - "description": "A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035." - } - }, - "type": "object" - }, - "SslCertificate": { - "description": "Represents an SSL certificate resource. Google Compute Engine has two SSL certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The global SSL certificates (sslCertificates) are used by: - Global external Application Load Balancers - Classic Application Load Balancers - Proxy Network Load Balancers (with target SSL proxies) The regional SSL certificates (regionSslCertificates) are used by: - Regional external Application Load Balancers - Regional internal Application Load Balancers Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.", - "id": "SslCertificate", - "properties": { - "certificate": { - "description": "A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", - "type": "string" - }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "expireTime": { - "description": "[Output Only] Expire time of the certificate. RFC3339", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#sslCertificate", - "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.", + "disk": { + "description": "[Output Only] The URL of the disk.", "type": "string" }, - "managed": { - "$ref": "SslCertificateManagedSslCertificate", - "description": "Configuration and status of a managed SSL certificate." - }, "name": { - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "privateKey": { - "description": "A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.", + "description": "[Output Only] The name of the disk.", "type": "string" }, - "region": { - "description": "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.", + "provisionedIops": { + "description": "[Output Only] The number of IOPS provisioned for the disk.", + "format": "int64", "type": "string" }, - "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", + "provisionedThroughput": { + "description": "[Output Only] The throughput provisioned for the disk.", + "format": "int64", "type": "string" }, - "selfManaged": { - "$ref": "SslCertificateSelfManagedSslCertificate", - "description": "Configuration and status of a self-managed SSL certificate." - }, - "subjectAlternativeNames": { - "description": "[Output Only] Domains associated with the certificate via Subject Alternative Name.", + "resourcePolicies": { + "description": "[Output Only] Resource policies applied to disk for automatic snapshot creations.", "items": { "type": "string" }, "type": "array" }, - "type": { - "description": "(Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or \"MANAGED\". If not specified, the certificate is self-managed and the fields certificate and private_key are used.", + "sizeGb": { + "description": "[Output Only] The disk size, in GB.", + "format": "int64", + "type": "string" + }, + "status": { + "description": "[Output Only] The disk status.", "enum": [ - "MANAGED", - "SELF_MANAGED", - "TYPE_UNSPECIFIED" + "CREATING", + "DELETING", + "FAILED", + "READY", + "RESTORING", + "UNAVAILABLE" ], "enumDescriptions": [ - "Google-managed SSLCertificate.", - "Certificate uploaded by user.", - "" + "Disk is provisioning", + "Disk is deleting.", + "Disk creation failed.", + "Disk is ready for use.", + "Source data is being copied into the disk.", + "Disk is currently unavailable and cannot be accessed, attached or detached." ], "type": "string" + }, + "type": { + "description": "[Output Only] The disk type.", + "type": "string" + }, + "usedBytes": { + "description": "[Output Only] Amount of disk space used.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "SslCertificateAggregatedList": { - "id": "SslCertificateAggregatedList", + "StoragePoolList": { + "description": "A list of StoragePool resources.", + "id": "StoragePoolList", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "SslCertificatesScopedList", - "description": "Name of the scope containing this set of SslCertificates." + "description": "A list of StoragePool resources.", + "items": { + "$ref": "StoragePool" }, - "description": "A list of SslCertificatesScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#sslCertificateAggregatedList", - "description": "[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.", + "default": "compute#storagePoolList", + "description": "[Output Only] Type of resource. Always compute#storagePoolList for lists of storagePools.", "type": "string" }, "nextPageToken": { @@ -72223,7 +75239,7 @@ "type": "string" }, "unreachables": { - "description": "[Output Only] Unreachable resources.", + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", "items": { "type": "string" }, @@ -72353,24 +75369,26 @@ }, "type": "object" }, - "SslCertificateList": { - "description": "Contains a list of SslCertificate resources.", - "id": "SslCertificateList", + "StoragePoolListDisks": { + "id": "StoragePoolListDisks", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of SslCertificate resources.", + "description": "A list of StoragePoolDisk resources.", "items": { - "$ref": "SslCertificate" + "$ref": "StoragePoolDisk" }, "type": "array" }, "kind": { - "default": "compute#sslCertificateList", - "description": "Type of resource.", + "default": "compute#storagePoolListDisks", + "description": "[Output Only] Type of resource. Always compute#storagePoolListDisks for lists of disks in a storagePool.", "type": "string" }, "nextPageToken": { @@ -72381,6 +75399,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -72505,92 +75530,179 @@ }, "type": "object" }, - "SslCertificateManagedSslCertificate": { - "description": "Configuration and status of a managed SSL certificate.", - "id": "SslCertificateManagedSslCertificate", + "StoragePoolResourceStatus": { + "description": "[Output Only] Contains output only fields.", + "id": "StoragePoolResourceStatus", "properties": { - "domainStatus": { - "additionalProperties": { - "enum": [ - "ACTIVE", - "DOMAIN_STATUS_UNSPECIFIED", - "FAILED_CAA_CHECKING", - "FAILED_CAA_FORBIDDEN", - "FAILED_NOT_VISIBLE", - "FAILED_RATE_LIMITED", - "PROVISIONING" - ], - "enumDescriptions": [ - "A managed certificate can be provisioned, no issues for this domain.", - "", - "Failed to check CAA records for the domain.", - "Certificate issuance forbidden by an explicit CAA record for the domain.", - "There seems to be problem with the user's DNS or load balancer configuration for this domain.", - "Reached rate-limit for certificates per top-level private domain.", - "Certificate provisioning for this domain is under way. GCP will attempt to provision the first certificate." - ], - "type": "string" - }, - "description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.", - "type": "object" + "diskCount": { + "description": "[Output Only] Number of disks used.", + "format": "int64", + "type": "string" + }, + "lastResizeTimestamp": { + "description": "[Output Only] Timestamp of the last successful resize in RFC3339 text format.", + "type": "string" + }, + "maxTotalProvisionedDiskCapacityGb": { + "description": "[Output Only] Maximum allowed aggregate disk size in gigabytes.", + "format": "int64", + "type": "string" + }, + "poolUsedCapacityBytes": { + "description": "[Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks.", + "format": "int64", + "type": "string" + }, + "poolUsedIops": { + "description": "Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity.", + "format": "int64", + "type": "string" }, - "domains": { - "description": "The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).", - "items": { - "type": "string" - }, - "type": "array" + "poolUsedThroughput": { + "description": "[Output Only] Sum of all the disks' provisioned throughput in MB/s.", + "format": "int64", + "type": "string" }, - "status": { - "description": "[Output only] Status of the managed certificate resource.", - "enum": [ - "ACTIVE", - "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED", - "PROVISIONING", - "PROVISIONING_FAILED", - "PROVISIONING_FAILED_PERMANENTLY", - "RENEWAL_FAILED" - ], - "enumDescriptions": [ - "The certificate management is working, and a certificate has been provisioned.", - "", - "The certificate management is working. GCP will attempt to provision the first certificate.", - "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.", - "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won't be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.", - "Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field." - ], + "poolUserWrittenBytes": { + "description": "[Output Only] Amount of data written into the pool, before it is compacted.", + "format": "int64", + "type": "string" + }, + "totalProvisionedDiskCapacityGb": { + "description": "[Output Only] Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.", + "format": "int64", + "type": "string" + }, + "totalProvisionedDiskIops": { + "description": "[Output Only] Sum of all the disks' provisioned IOPS.", + "format": "int64", + "type": "string" + }, + "totalProvisionedDiskThroughput": { + "description": "[Output Only] Sum of all the disks' provisioned throughput in MB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity.", + "format": "int64", "type": "string" } }, "type": "object" }, - "SslCertificateSelfManagedSslCertificate": { - "description": "Configuration and status of a self-managed SSL certificate.", - "id": "SslCertificateSelfManagedSslCertificate", + "StoragePoolType": { + "id": "StoragePoolType", "properties": { - "certificate": { - "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "privateKey": { - "description": "A write-only private key in PEM format. Only insert requests will include this field.", + "deprecated": { + "$ref": "DeprecationStatus", + "description": "[Output Only] The deprecation status associated with this storage pool type." + }, + "description": { + "description": "[Output Only] An optional description of this resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#storagePoolType", + "description": "[Output Only] Type of the resource. Always compute#storagePoolType for storage pool types.", + "type": "string" + }, + "maxPoolProvisionedCapacityGb": { + "description": "[Output Only] Maximum storage pool size in GB.", + "format": "int64", + "type": "string" + }, + "maxPoolProvisionedIops": { + "description": "[Output Only] Maximum provisioned IOPS.", + "format": "int64", + "type": "string" + }, + "maxPoolProvisionedThroughput": { + "description": "[Output Only] Maximum provisioned throughput.", + "format": "int64", + "type": "string" + }, + "minPoolProvisionedCapacityGb": { + "description": "[Output Only] Minimum storage pool size in GB.", + "format": "int64", + "type": "string" + }, + "minPoolProvisionedIops": { + "description": "[Output Only] Minimum provisioned IOPS.", + "format": "int64", + "type": "string" + }, + "minPoolProvisionedThroughput": { + "description": "[Output Only] Minimum provisioned throughput.", + "format": "int64", + "type": "string" + }, + "minSizeGb": { + "description": "[Deprecated] This field is deprecated. Use minPoolProvisionedCapacityGb instead.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "[Output Only] Name of the resource.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "supportedDiskTypes": { + "description": "[Output Only] The list of disk types supported in this storage pool type.", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone": { + "description": "[Output Only] URL of the zone where the storage pool type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" } }, "type": "object" }, - "SslCertificatesScopedList": { - "id": "SslCertificatesScopedList", + "StoragePoolTypeAggregatedList": { + "id": "StoragePoolTypeAggregatedList", "properties": { - "sslCertificates": { - "description": "List of SslCertificates contained in this scope.", - "items": { - "$ref": "SslCertificate" + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "StoragePoolTypesScopedList", + "description": "[Output Only] Name of the scope containing this set of storage pool types." }, - "type": "array" + "description": "A list of StoragePoolTypesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#storagePoolTypeAggregatedList", + "description": "[Output Only] Type of resource. Always compute#storagePoolTypeAggregatedList .", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" }, "warning": { - "description": "Informational warning which replaces the list of backend services when the list is empty.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -72713,27 +75825,24 @@ }, "type": "object" }, - "SslPoliciesAggregatedList": { - "id": "SslPoliciesAggregatedList", + "StoragePoolTypeList": { + "description": "Contains a list of storage pool types.", + "id": "StoragePoolTypeList", "properties": { - "etag": { - "type": "string" - }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "additionalProperties": { - "$ref": "SslPoliciesScopedList", - "description": "Name of the scope containing this set of SSL policies." + "description": "A list of StoragePoolType resources.", + "items": { + "$ref": "StoragePoolType" }, - "description": "A list of SslPoliciesScopedList resources.", - "type": "object" + "type": "array" }, "kind": { - "default": "compute#sslPoliciesAggregatedList", - "description": "[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies.", + "default": "compute#storagePoolTypeList", + "description": "[Output Only] Type of resource. Always compute#storagePoolTypeList for storage pool types.", "type": "string" }, "nextPageToken": { @@ -72744,13 +75853,6 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -72875,35 +75977,18 @@ }, "type": "object" }, - "SslPoliciesList": { - "id": "SslPoliciesList", + "StoragePoolTypesScopedList": { + "id": "StoragePoolTypesScopedList", "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of SslPolicy resources.", + "storagePoolTypes": { + "description": "[Output Only] A list of storage pool types contained in this scope.", "items": { - "$ref": "SslPolicy" + "$ref": "StoragePoolType" }, "type": "array" }, - "kind": { - "default": "compute#sslPoliciesList", - "description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "[Output Only] Informational warning which replaces the list of storage pool types when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -73026,30 +76111,18 @@ }, "type": "object" }, - "SslPoliciesListAvailableFeaturesResponse": { - "id": "SslPoliciesListAvailableFeaturesResponse", - "properties": { - "features": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "SslPoliciesScopedList": { - "id": "SslPoliciesScopedList", + "StoragePoolsScopedList": { + "id": "StoragePoolsScopedList", "properties": { - "sslPolicies": { - "description": "A list of SslPolicies contained in this scope.", + "storagePools": { + "description": "[Output Only] A list of storage pool contained in this scope.", "items": { - "$ref": "SslPolicy" + "$ref": "StoragePool" }, "type": "array" }, "warning": { - "description": "Informational warning which replaces the list of SSL policies when the list is empty.", + "description": "[Output Only] Informational warning which replaces the list of storage pool when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -73172,327 +76245,6 @@ }, "type": "object" }, - "SslPolicy": { - "description": "Represents an SSL Policy resource. Use SSL policies to control SSL features, such as versions and cipher suites, that are offered by Application Load Balancers and proxy Network Load Balancers. For more information, read SSL policies overview.", - "id": "SslPolicy", - "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "customFeatures": { - "description": "A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.", - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "enabledFeatures": { - "description": "[Output Only] The list of features enabled in the SSL policy.", - "items": { - "type": "string" - }, - "type": "array" - }, - "fingerprint": { - "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.", - "format": "byte", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#sslPolicy", - "description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.", - "type": "string" - }, - "minTlsVersion": { - "description": "The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.", - "enum": [ - "TLS_1_0", - "TLS_1_1", - "TLS_1_2" - ], - "enumDescriptions": [ - "TLS 1.0", - "TLS 1.1", - "TLS 1.2" - ], - "type": "string" - }, - "name": { - "description": "Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "profile": { - "description": "Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.", - "enum": [ - "COMPATIBLE", - "CUSTOM", - "MODERN", - "RESTRICTED" - ], - "enumDescriptions": [ - "Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.", - "Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.", - "Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.", - "Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements." - ], - "type": "string" - }, - "region": { - "description": "[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "warnings": { - "description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.", - "items": { - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "SslPolicyReference": { - "id": "SslPolicyReference", - "properties": { - "sslPolicy": { - "description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.", - "type": "string" - } - }, - "type": "object" - }, - "StatefulPolicy": { - "id": "StatefulPolicy", - "properties": { - "preservedState": { - "$ref": "StatefulPolicyPreservedState" - } - }, - "type": "object" - }, - "StatefulPolicyPreservedState": { - "description": "Configuration of preserved resources.", - "id": "StatefulPolicyPreservedState", - "properties": { - "disks": { - "additionalProperties": { - "$ref": "StatefulPolicyPreservedStateDiskDevice" - }, - "description": "Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.", - "type": "object" - }, - "externalIPs": { - "additionalProperties": { - "$ref": "StatefulPolicyPreservedStateNetworkIp" - }, - "description": "External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", - "type": "object" - }, - "internalIPs": { - "additionalProperties": { - "$ref": "StatefulPolicyPreservedStateNetworkIp" - }, - "description": "Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", - "type": "object" - } - }, - "type": "object" - }, - "StatefulPolicyPreservedStateDiskDevice": { - "id": "StatefulPolicyPreservedStateDiskDevice", - "properties": { - "autoDelete": { - "description": "These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", - "enum": [ - "NEVER", - "ON_PERMANENT_INSTANCE_DELETION" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "StatefulPolicyPreservedStateNetworkIp": { - "id": "StatefulPolicyPreservedStateNetworkIp", - "properties": { - "autoDelete": { - "description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", - "enum": [ - "NEVER", - "ON_PERMANENT_INSTANCE_DELETION" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, "Subnetwork": { "description": "Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.", "id": "Subnetwork", diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 3df416173ee..ea18b78878a 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -2463,10 +2463,6 @@ export namespace compute_alpha { * Network Layer Reachability Information (NLRI) for a route. */ export interface Schema$BgpRouteNetworkLayerReachabilityInformation { - /** - * Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16. Deprecated in favor of prefix. - */ - destination?: string | null; /** * If the BGP session supports multiple paths (RFC 7911), the path identifier for this route. */ @@ -3009,7 +3005,7 @@ export namespace compute_alpha { */ allowMethods?: string[] | null; /** - * Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. + * Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. */ allowOriginRegexes?: string[] | null; /** @@ -3017,7 +3013,7 @@ export namespace compute_alpha { */ allowOrigins?: string[] | null; /** - * If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. + * If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect. */ disabled?: boolean | null; /** @@ -4993,6 +4989,20 @@ export namespace compute_alpha { */ targetUri?: string | null; } + export interface Schema$GRPCTLSHealthCheck { + /** + * The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII. + */ + grpcServiceName?: string | null; + /** + * The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. + */ + portSpecification?: string | null; + } /** * A guest attributes entry. */ @@ -5050,7 +5060,7 @@ export namespace compute_alpha { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. + * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. */ type?: string | null; } @@ -5071,6 +5081,7 @@ export namespace compute_alpha { */ description?: string | null; grpcHealthCheck?: Schema$GRPCHealthCheck; + grpcTlsHealthCheck?: Schema$GRPCTLSHealthCheck; /** * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ @@ -7082,7 +7093,7 @@ export namespace compute_alpha { */ export interface Schema$InstanceGroupManagerResizeRequest { /** - * The count of instances to create as part of this resize request. + * This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request. */ count?: number | null; /** @@ -7106,7 +7117,7 @@ export namespace compute_alpha { */ name?: string | null; /** - * When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible. + * This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible. */ queuingPolicy?: Schema$QueuingPolicy; /** @@ -7193,7 +7204,7 @@ export namespace compute_alpha { */ lastAttempt?: Schema$InstanceGroupManagerResizeRequestStatusLastAttempt; /** - * Constraints for the time when the instances start provisioning. Always exposed as absolute time. + * This field is deprecated, setting queueing policy is no longer supported. Constraints for the time when the instances start provisioning. Always exposed as absolute time. */ queuingPolicy?: Schema$QueuingPolicy; } @@ -9276,7 +9287,7 @@ export namespace compute_alpha { } export interface Schema$InterconnectRemoteLocationConstraints { /** - * [Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. GCP's API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location. + * [Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location. */ portPairRemoteLocation?: string | null; /** @@ -10379,6 +10390,10 @@ export namespace compute_alpha { * The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. */ networkFirewallPolicyEnforcementOrder?: string | null; + /** + * A full or partial URL of the network placement to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/alpha/projects/{project_id\}/global/networkPlacements/{network_placement_name\} - projects/{project_id\}/global/networkPlacements/{network_placement_name\} + */ + networkPlacement?: string | null; /** * [Output Only] A list of network peerings for the resource. */ @@ -10941,6 +10956,10 @@ export namespace compute_alpha { * [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. */ consumerPscAddress?: string | null; + /** + * The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type + */ + producerPort?: number | null; /** * [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. */ @@ -13631,6 +13650,14 @@ export namespace compute_alpha { * [Output Only] Quotas assigned to this region. */ quotas?: Schema$Quota[]; + /** + * [Output Only] Warning of fetching the `quotas` field for this region. This field is populated only if fetching of the `quotas` field fails. + */ + quotaStatusWarning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; /** * [Output Only] Server-defined URL for the resource. */ @@ -14126,7 +14153,7 @@ export namespace compute_alpha { */ rules?: Schema$FirewallPolicyRule[]; /** - * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL. + * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. */ type?: string | null; } @@ -18897,6 +18924,20 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$SubnetworksScopedWarning { + /** + * Name of the scope containing this set of Subnetworks. + */ + scopeName?: string | null; + /** + * An informational warning about unreachable scope + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { privateIpGoogleAccess?: boolean | null; } @@ -20537,10 +20578,18 @@ export namespace compute_alpha { * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. In special cases listUsable may return 0 subnetworks and nextPageToken which still should be used to get the next page of results. */ nextPageToken?: string | null; + /** + * [Output Only] Informational warning messages for failures encountered from scopes. + */ + scoped_warnings?: Schema$SubnetworksScopedWarning[]; /** * [Output Only] Server-defined URL for this resource. */ selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; /** * [Output Only] Informational warning message. */ diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 2508d5f4acf..14a0eac9547 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -202,6 +202,8 @@ export namespace compute_beta { snapshotSettings: Resource$Snapshotsettings; sslCertificates: Resource$Sslcertificates; sslPolicies: Resource$Sslpolicies; + storagePools: Resource$Storagepools; + storagePoolTypes: Resource$Storagepooltypes; subnetworks: Resource$Subnetworks; targetGrpcProxies: Resource$Targetgrpcproxies; targetHttpProxies: Resource$Targethttpproxies; @@ -356,6 +358,8 @@ export namespace compute_beta { this.snapshotSettings = new Resource$Snapshotsettings(this.context); this.sslCertificates = new Resource$Sslcertificates(this.context); this.sslPolicies = new Resource$Sslpolicies(this.context); + this.storagePools = new Resource$Storagepools(this.context); + this.storagePoolTypes = new Resource$Storagepooltypes(this.context); this.subnetworks = new Resource$Subnetworks(this.context); this.targetGrpcProxies = new Resource$Targetgrpcproxies(this.context); this.targetHttpProxies = new Resource$Targethttpproxies(this.context); @@ -1049,6 +1053,10 @@ export namespace compute_beta { * The customer-supplied encryption key of the source snapshot. */ sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool + */ + storagePool?: 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. @@ -2704,7 +2712,7 @@ export namespace compute_beta { */ allowMethods?: string[] | null; /** - * Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. + * Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. */ allowOriginRegexes?: string[] | null; /** @@ -2712,7 +2720,7 @@ export namespace compute_beta { */ allowOrigins?: string[] | null; /** - * If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. + * If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect. */ disabled?: boolean | null; /** @@ -3017,6 +3025,10 @@ export namespace compute_beta { * [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. */ status?: string | null; + /** + * The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool + */ + storagePool?: string | null; /** * [Deprecated] Storage type of the persistent disk. */ @@ -4633,7 +4645,7 @@ export namespace compute_beta { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. + * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. */ type?: string | null; } @@ -4685,6 +4697,10 @@ export namespace compute_beta { * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; + /** + * The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of GCP regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. + */ + sourceRegions?: string[] | null; sslHealthCheck?: Schema$SSLHealthCheck; tcpHealthCheck?: Schema$TCPHealthCheck; /** @@ -6247,6 +6263,10 @@ export namespace compute_beta { * Named ports configured for the Instance Groups complementary to this Instance Group Manager. */ namedPorts?: Schema$NamedPort[]; + /** + * Input only. Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$InstanceGroupManagerParams; /** * [Output Only] The URL of the region where the managed instance group resides (for regional resources). */ @@ -6475,12 +6495,21 @@ export namespace compute_beta { message?: string; } | null; } + /** + * Input only additional params for instance group manager creation. + */ + export interface Schema$InstanceGroupManagerParams { + /** + * Resource manager tags to be bound to the instance group manager. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/123`, and values are in the format `tagValues/456`. The field is allowed for INSERT only. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager. */ export interface Schema$InstanceGroupManagerResizeRequest { /** - * The count of instances to create as part of this resize request. + * This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request. */ count?: number | null; /** @@ -8604,7 +8633,7 @@ export namespace compute_beta { } export interface Schema$InterconnectRemoteLocationConstraints { /** - * [Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. GCP's API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location. + * [Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location. */ portPairRemoteLocation?: string | null; /** @@ -12700,7 +12729,7 @@ export namespace compute_beta { */ rules?: Schema$FirewallPolicyRule[]; /** - * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL. + * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. */ type?: string | null; } @@ -15104,6 +15133,10 @@ export namespace compute_beta { * The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment. */ producerForwardingRule?: string | null; + /** + * The number of consumer Network Connectivity Center spokes that connected Private Service Connect endpoints can be propagated to. This limit lets a service producer indirectly limit how many propagated Private Service Connect connections can be established to the producer's service attachment. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250. + */ + propagatedConnectionLimit?: number | null; /** * [Output Only] An 128-bit global unique ID of the PSC service attachment. */ @@ -15178,6 +15211,10 @@ export namespace compute_beta { * The url of a connected endpoint. */ endpoint?: string | null; + /** + * The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to. + */ + propagatedConnectionCount?: number | null; /** * The PSC connection id of the connected endpoint. */ @@ -16138,6 +16175,447 @@ export namespace compute_beta { */ message?: string | null; } + /** + * Represents a zonal storage pool resource. + */ + export interface Schema$StoragePool { + /** + * Provisioning type of the byte capacity of the pool. + */ + capacityProvisioningType?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#storagePool for storage pools. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this storage pool. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. + */ + performanceProvisioningType?: string | null; + /** + * Size, in GiB, of the storage pool. + */ + poolProvisionedCapacityGb?: string | null; + /** + * Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced. + */ + poolProvisionedIops?: string | null; + /** + * Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + */ + poolProvisionedThroughput?: string | null; + /** + * [Output Only] Status information for the storage pool resource. + */ + resourceStatus?: Schema$StoragePoolResourceStatus; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. + */ + state?: string | null; + /** + * [Output Only] Status information for the storage pool resource. + */ + status?: Schema$StoragePoolResourceStatus; + /** + * Type of the storage pool. + */ + storagePoolType?: string | null; + /** + * [Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$StoragePoolAggregatedList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePoolsScopedList resources. + */ + items?: {[key: string]: Schema$StoragePoolsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#storagePoolAggregatedList for aggregated lists of storage pools. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$StoragePoolDisk { + /** + * [Output Only] Instances this disk is attached to. + */ + attachedInstances?: string[] | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The URL of the disk. + */ + disk?: string | null; + /** + * [Output Only] The name of the disk. + */ + name?: string | null; + /** + * [Output Only] The number of IOPS provisioned for the disk. + */ + provisionedIops?: string | null; + /** + * [Output Only] The throughput provisioned for the disk. + */ + provisionedThroughput?: string | null; + /** + * [Output Only] Resource policies applied to disk for automatic snapshot creations. + */ + resourcePolicies?: string[] | null; + /** + * [Output Only] The disk size, in GB. + */ + sizeGb?: string | null; + /** + * [Output Only] The disk status. + */ + status?: string | null; + /** + * [Output Only] The disk type. + */ + type?: string | null; + /** + * [Output Only] Amount of disk space used. + */ + usedBytes?: string | null; + } + /** + * A list of StoragePool resources. + */ + export interface Schema$StoragePoolList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePool resources. + */ + items?: Schema$StoragePool[]; + /** + * [Output Only] Type of resource. Always compute#storagePoolList for lists of storagePools. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$StoragePoolListDisks { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePoolDisk resources. + */ + items?: Schema$StoragePoolDisk[]; + /** + * [Output Only] Type of resource. Always compute#storagePoolListDisks for lists of disks in a storagePool. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * [Output Only] Contains output only fields. + */ + export interface Schema$StoragePoolResourceStatus { + /** + * [Output Only] Number of disks used. + */ + diskCount?: string | null; + /** + * [Output Only] Timestamp of the last successful resize in RFC3339 text format. + */ + lastResizeTimestamp?: string | null; + /** + * [Output Only] Maximum allowed aggregate disk size in gigabytes. + */ + maxTotalProvisionedDiskCapacityGb?: string | null; + /** + * [Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks. + */ + poolUsedCapacityBytes?: string | null; + /** + * Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. + */ + poolUsedIops?: string | null; + /** + * [Output Only] Sum of all the disks' provisioned throughput in MB/s. + */ + poolUsedThroughput?: string | null; + /** + * [Output Only] Amount of data written into the pool, before it is compacted. + */ + poolUserWrittenBytes?: string | null; + /** + * [Output Only] Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity. + */ + totalProvisionedDiskCapacityGb?: string | null; + /** + * [Output Only] Sum of all the disks' provisioned IOPS. + */ + totalProvisionedDiskIops?: string | null; + /** + * [Output Only] Sum of all the disks' provisioned throughput in MB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity. + */ + totalProvisionedDiskThroughput?: string | null; + } + export interface Schema$StoragePoolsScopedList { + /** + * [Output Only] A list of storage pool contained in this scope. + */ + storagePools?: Schema$StoragePool[]; + /** + * [Output Only] Informational warning which replaces the list of storage pool when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$StoragePoolType { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The deprecation status associated with this storage pool type. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] An optional description of this resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#storagePoolType for storage pool types. + */ + kind?: string | null; + /** + * [Output Only] Maximum storage pool size in GB. + */ + maxPoolProvisionedCapacityGb?: string | null; + /** + * [Output Only] Maximum provisioned IOPS. + */ + maxPoolProvisionedIops?: string | null; + /** + * [Output Only] Maximum provisioned throughput. + */ + maxPoolProvisionedThroughput?: string | null; + /** + * [Output Only] Minimum storage pool size in GB. + */ + minPoolProvisionedCapacityGb?: string | null; + /** + * [Output Only] Minimum provisioned IOPS. + */ + minPoolProvisionedIops?: string | null; + /** + * [Output Only] Minimum provisioned throughput. + */ + minPoolProvisionedThroughput?: string | null; + /** + * [Deprecated] This field is deprecated. Use minPoolProvisionedCapacityGb instead. + */ + minSizeGb?: string | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The list of disk types supported in this storage pool type. + */ + supportedDiskTypes?: string[] | null; + /** + * [Output Only] URL of the zone where the storage pool type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$StoragePoolTypeAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePoolTypesScopedList resources. + */ + items?: {[key: string]: Schema$StoragePoolTypesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#storagePoolTypeAggregatedList . + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Contains a list of storage pool types. + */ + export interface Schema$StoragePoolTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePoolType resources. + */ + items?: Schema$StoragePoolType[]; + /** + * [Output Only] Type of resource. Always compute#storagePoolTypeList for storage pool types. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$StoragePoolTypesScopedList { + /** + * [Output Only] A list of storage pool types contained in this scope. + */ + storagePoolTypes?: Schema$StoragePoolType[]; + /** + * [Output Only] Informational warning which replaces the list of storage pool types when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. */ @@ -31203,10 +31681,6 @@ export namespace compute_beta { * Name of the reservation to update. Name should conform to RFC1035. */ futureReservation?: string; - /** - * - */ - paths?: string[]; /** * Project ID for this request. */ @@ -38571,6 +39045,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + /** + * The zone query parameter. + */ + zone?: string; } export interface Params$Resource$Images$Patch extends StandardParameters { /** @@ -100235,6 +100713,1507 @@ export namespace compute_beta { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Storagepools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Storagepools$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Storagepools$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Storagepools$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Storagepools$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Storagepools$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Storagepools$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/aggregated/storagePools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified storage pool. Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Storagepools$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Storagepools$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Storagepools$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Storagepools$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Storagepools$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Storagepools$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools/{storagePool}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePool'], + pathParams: ['project', 'storagePool', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns a specified storage pool. Gets a list of available storage pools by making a list() request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Storagepools$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Storagepools$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Storagepools$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Storagepools$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Storagepools$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Storagepools$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Storagepools$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools/{storagePool}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePool'], + pathParams: ['project', 'storagePool', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Storagepools$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Storagepools$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Storagepools$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Storagepools$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Storagepools$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Storagepools$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a storage pool in the specified project using the data in the request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Storagepools$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Storagepools$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Storagepools$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Storagepools$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Storagepools$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Storagepools$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of storage pools contained within the specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Storagepools$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Storagepools$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Storagepools$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Storagepools$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Storagepools$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Storagepools$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the disks in a specified storage pool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listDisks( + params: Params$Resource$Storagepools$Listdisks, + options: StreamMethodOptions + ): GaxiosPromise; + listDisks( + params?: Params$Resource$Storagepools$Listdisks, + options?: MethodOptions + ): GaxiosPromise; + listDisks( + params: Params$Resource$Storagepools$Listdisks, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listDisks( + params: Params$Resource$Storagepools$Listdisks, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listDisks( + params: Params$Resource$Storagepools$Listdisks, + callback: BodyResponseCallback + ): void; + listDisks( + callback: BodyResponseCallback + ): void; + listDisks( + paramsOrCallback?: + | Params$Resource$Storagepools$Listdisks + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Listdisks; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Listdisks; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePool'], + pathParams: ['project', 'storagePool', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Storagepools$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Storagepools$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Storagepools$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Storagepools$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Storagepools$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Storagepools$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Storagepools$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Storagepools$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Storagepools$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Storagepools$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Storagepools$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Storagepools$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: size_tb and provisioned_iops. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Storagepools$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Storagepools$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Storagepools$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Storagepools$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Storagepools$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Storagepools$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePools/{storagePool}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePool'], + pathParams: ['project', 'storagePool', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Storagepools$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Storagepools$Delete + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the storage pool to delete. + */ + storagePool?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Get extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the storage pool to return. + */ + storagePool?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StoragePool; + } + export interface Params$Resource$Storagepools$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Listdisks + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name of the storage pool to list disks of. + */ + storagePool?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Storagepools$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Storagepools$Update + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The storagePool name for this request. + */ + storagePool?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StoragePool; + } + + export class Resource$Storagepooltypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of storage pool types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Storagepooltypes$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Storagepooltypes$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Storagepooltypes$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Storagepooltypes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Storagepooltypes$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Storagepooltypes$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepooltypes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepooltypes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/aggregated/storagePoolTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the specified storage pool type. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Storagepooltypes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Storagepooltypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Storagepooltypes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Storagepooltypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Storagepooltypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Storagepooltypes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepooltypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepooltypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePoolType'], + pathParams: ['project', 'storagePoolType', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of storage pool types available to the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Storagepooltypes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Storagepooltypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Storagepooltypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Storagepooltypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Storagepooltypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Storagepooltypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepooltypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepooltypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/storagePoolTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Storagepooltypes$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Storagepooltypes$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the storage pool type to return. + */ + storagePoolType?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepooltypes$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export class Resource$Subnetworks { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 00510ef1fb9..e6e764396f6 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -138,6 +138,7 @@ export namespace compute_v1 { httpsHealthChecks: Resource$Httpshealthchecks; imageFamilyViews: Resource$Imagefamilyviews; images: Resource$Images; + instanceGroupManagerResizeRequests: Resource$Instancegroupmanagerresizerequests; instanceGroupManagers: Resource$Instancegroupmanagers; instanceGroups: Resource$Instancegroups; instances: Resource$Instances; @@ -198,6 +199,8 @@ export namespace compute_v1 { snapshotSettings: Resource$Snapshotsettings; sslCertificates: Resource$Sslcertificates; sslPolicies: Resource$Sslpolicies; + storagePools: Resource$Storagepools; + storagePoolTypes: Resource$Storagepooltypes; subnetworks: Resource$Subnetworks; targetGrpcProxies: Resource$Targetgrpcproxies; targetHttpProxies: Resource$Targethttpproxies; @@ -246,6 +249,8 @@ export namespace compute_v1 { this.httpsHealthChecks = new Resource$Httpshealthchecks(this.context); this.imageFamilyViews = new Resource$Imagefamilyviews(this.context); this.images = new Resource$Images(this.context); + this.instanceGroupManagerResizeRequests = + new Resource$Instancegroupmanagerresizerequests(this.context); this.instanceGroupManagers = new Resource$Instancegroupmanagers( this.context ); @@ -346,6 +351,8 @@ export namespace compute_v1 { this.snapshotSettings = new Resource$Snapshotsettings(this.context); this.sslCertificates = new Resource$Sslcertificates(this.context); this.sslPolicies = new Resource$Sslpolicies(this.context); + this.storagePools = new Resource$Storagepools(this.context); + this.storagePoolTypes = new Resource$Storagepooltypes(this.context); this.subnetworks = new Resource$Subnetworks(this.context); this.targetGrpcProxies = new Resource$Targetgrpcproxies(this.context); this.targetHttpProxies = new Resource$Targethttpproxies(this.context); @@ -1011,6 +1018,10 @@ export namespace compute_v1 { * The customer-supplied encryption key of the source snapshot. */ sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool + */ + storagePool?: 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. @@ -2630,7 +2641,7 @@ export namespace compute_v1 { */ allowMethods?: string[] | null; /** - * Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. + * Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. */ allowOriginRegexes?: string[] | null; /** @@ -2638,7 +2649,7 @@ export namespace compute_v1 { */ allowOrigins?: string[] | null; /** - * If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. + * If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect. */ disabled?: boolean | null; /** @@ -2893,6 +2904,10 @@ export namespace compute_v1 { * [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. */ status?: string | null; + /** + * The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool + */ + storagePool?: string | null; /** * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. */ @@ -4236,7 +4251,7 @@ export namespace compute_v1 { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. + * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. */ type?: string | null; } @@ -5956,6 +5971,132 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager. + */ + export interface Schema$InstanceGroupManagerResizeRequest { + /** + * [Output Only] The creation timestamp for this resize request in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. + */ + description?: string | null; + /** + * [Output Only] A unique identifier for this resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests. + */ + kind?: string | null; + /** + * The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035. + */ + name?: string | null; + /** + * Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted. + */ + requestedRunDuration?: Schema$Duration; + /** + * The number of instances to be created by this resize request. The group's target size will be increased by this number. + */ + resizeBy?: number | null; + /** + * [Output Only] The URL for this resize request. The server defines this URL. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output only] Current state of the request. + */ + state?: string | null; + /** + * [Output only] Status of the request. + */ + status?: Schema$InstanceGroupManagerResizeRequestStatus; + /** + * [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests. + */ + zone?: string | null; + } + /** + * [Output Only] A list of resize requests. + */ + export interface Schema$InstanceGroupManagerResizeRequestsListResponse { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of resize request resources. + */ + items?: Schema$InstanceGroupManagerResizeRequest[]; + /** + * [Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$InstanceGroupManagerResizeRequestStatus { + /** + * [Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry. + */ + error?: { + errors?: Array<{ + code?: string; + errorDetails?: Array<{ + errorInfo?: Schema$ErrorInfo; + help?: Schema$Help; + localizedMessage?: Schema$LocalizedMessage; + quotaInfo?: Schema$QuotaExceededInfo; + }>; + location?: string; + message?: string; + }>; + } | null; + /** + * [Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the "error" field only. + */ + lastAttempt?: Schema$InstanceGroupManagerResizeRequestStatusLastAttempt; + } + export interface Schema$InstanceGroupManagerResizeRequestStatusLastAttempt { + /** + * Errors that prevented the ResizeRequest to be fulfilled. + */ + error?: { + errors?: Array<{ + code?: string; + errorDetails?: Array<{ + errorInfo?: Schema$ErrorInfo; + help?: Schema$Help; + localizedMessage?: Schema$LocalizedMessage; + quotaInfo?: Schema$QuotaExceededInfo; + }>; + location?: string; + message?: string; + }>; + } | null; + } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. @@ -7822,7 +7963,7 @@ export namespace compute_v1 { } export interface Schema$InterconnectRemoteLocationConstraints { /** - * [Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. GCP's API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location. + * [Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location. */ portPairRemoteLocation?: string | null; /** @@ -11705,7 +11846,7 @@ export namespace compute_v1 { */ rules?: Schema$FirewallPolicyRule[]; /** - * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL. + * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. */ type?: string | null; } @@ -14830,6 +14971,447 @@ export namespace compute_v1 { */ message?: string | null; } + /** + * Represents a zonal storage pool resource. + */ + export interface Schema$StoragePool { + /** + * Provisioning type of the byte capacity of the pool. + */ + capacityProvisioningType?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#storagePool for storage pools. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this storage pool. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. + */ + performanceProvisioningType?: string | null; + /** + * Size, in GiB, of the storage pool. + */ + poolProvisionedCapacityGb?: string | null; + /** + * Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced. + */ + poolProvisionedIops?: string | null; + /** + * Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + */ + poolProvisionedThroughput?: string | null; + /** + * [Output Only] Status information for the storage pool resource. + */ + resourceStatus?: Schema$StoragePoolResourceStatus; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. + */ + state?: string | null; + /** + * [Output Only] Status information for the storage pool resource. + */ + status?: Schema$StoragePoolResourceStatus; + /** + * Type of the storage pool. + */ + storagePoolType?: string | null; + /** + * [Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$StoragePoolAggregatedList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePoolsScopedList resources. + */ + items?: {[key: string]: Schema$StoragePoolsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#storagePoolAggregatedList for aggregated lists of storage pools. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$StoragePoolDisk { + /** + * [Output Only] Instances this disk is attached to. + */ + attachedInstances?: string[] | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The URL of the disk. + */ + disk?: string | null; + /** + * [Output Only] The name of the disk. + */ + name?: string | null; + /** + * [Output Only] The number of IOPS provisioned for the disk. + */ + provisionedIops?: string | null; + /** + * [Output Only] The throughput provisioned for the disk. + */ + provisionedThroughput?: string | null; + /** + * [Output Only] Resource policies applied to disk for automatic snapshot creations. + */ + resourcePolicies?: string[] | null; + /** + * [Output Only] The disk size, in GB. + */ + sizeGb?: string | null; + /** + * [Output Only] The disk status. + */ + status?: string | null; + /** + * [Output Only] The disk type. + */ + type?: string | null; + /** + * [Output Only] Amount of disk space used. + */ + usedBytes?: string | null; + } + /** + * A list of StoragePool resources. + */ + export interface Schema$StoragePoolList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePool resources. + */ + items?: Schema$StoragePool[]; + /** + * [Output Only] Type of resource. Always compute#storagePoolList for lists of storagePools. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$StoragePoolListDisks { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePoolDisk resources. + */ + items?: Schema$StoragePoolDisk[]; + /** + * [Output Only] Type of resource. Always compute#storagePoolListDisks for lists of disks in a storagePool. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * [Output Only] Contains output only fields. + */ + export interface Schema$StoragePoolResourceStatus { + /** + * [Output Only] Number of disks used. + */ + diskCount?: string | null; + /** + * [Output Only] Timestamp of the last successful resize in RFC3339 text format. + */ + lastResizeTimestamp?: string | null; + /** + * [Output Only] Maximum allowed aggregate disk size in gigabytes. + */ + maxTotalProvisionedDiskCapacityGb?: string | null; + /** + * [Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks. + */ + poolUsedCapacityBytes?: string | null; + /** + * Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. + */ + poolUsedIops?: string | null; + /** + * [Output Only] Sum of all the disks' provisioned throughput in MB/s. + */ + poolUsedThroughput?: string | null; + /** + * [Output Only] Amount of data written into the pool, before it is compacted. + */ + poolUserWrittenBytes?: string | null; + /** + * [Output Only] Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity. + */ + totalProvisionedDiskCapacityGb?: string | null; + /** + * [Output Only] Sum of all the disks' provisioned IOPS. + */ + totalProvisionedDiskIops?: string | null; + /** + * [Output Only] Sum of all the disks' provisioned throughput in MB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity. + */ + totalProvisionedDiskThroughput?: string | null; + } + export interface Schema$StoragePoolsScopedList { + /** + * [Output Only] A list of storage pool contained in this scope. + */ + storagePools?: Schema$StoragePool[]; + /** + * [Output Only] Informational warning which replaces the list of storage pool when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$StoragePoolType { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The deprecation status associated with this storage pool type. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] An optional description of this resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#storagePoolType for storage pool types. + */ + kind?: string | null; + /** + * [Output Only] Maximum storage pool size in GB. + */ + maxPoolProvisionedCapacityGb?: string | null; + /** + * [Output Only] Maximum provisioned IOPS. + */ + maxPoolProvisionedIops?: string | null; + /** + * [Output Only] Maximum provisioned throughput. + */ + maxPoolProvisionedThroughput?: string | null; + /** + * [Output Only] Minimum storage pool size in GB. + */ + minPoolProvisionedCapacityGb?: string | null; + /** + * [Output Only] Minimum provisioned IOPS. + */ + minPoolProvisionedIops?: string | null; + /** + * [Output Only] Minimum provisioned throughput. + */ + minPoolProvisionedThroughput?: string | null; + /** + * [Deprecated] This field is deprecated. Use minPoolProvisionedCapacityGb instead. + */ + minSizeGb?: string | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] The list of disk types supported in this storage pool type. + */ + supportedDiskTypes?: string[] | null; + /** + * [Output Only] URL of the zone where the storage pool type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$StoragePoolTypeAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePoolTypesScopedList resources. + */ + items?: {[key: string]: Schema$StoragePoolTypesScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#storagePoolTypeAggregatedList . + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Contains a list of storage pool types. + */ + export interface Schema$StoragePoolTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of StoragePoolType resources. + */ + items?: Schema$StoragePoolType[]; + /** + * [Output Only] Type of resource. Always compute#storagePoolTypeList for storage pool types. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$StoragePoolTypesScopedList { + /** + * [Output Only] A list of storage pool types contained in this scope. + */ + storagePoolTypes?: Schema$StoragePoolType[]; + /** + * [Output Only] Informational warning which replaces the list of storage pool types when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. */ @@ -35476,6 +36058,624 @@ export namespace compute_v1 { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Instancegroupmanagerresizerequests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagerresizerequests$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagerresizerequests$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Instancegroupmanagerresizerequests$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'resizeRequest', + 'zone', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Instancegroupmanagerresizerequests$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Instancegroupmanagerresizerequests$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Instancegroupmanagerresizerequests$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instancegroupmanagerresizerequests$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instancegroupmanagerresizerequests$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagerresizerequests$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagerresizerequests$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Instancegroupmanagerresizerequests$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'resizeRequest', + 'zone', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns all of the details about the specified resize request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Instancegroupmanagerresizerequests$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Instancegroupmanagerresizerequests$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instancegroupmanagerresizerequests$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancegroupmanagerresizerequests$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancegroupmanagerresizerequests$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagerresizerequests$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagerresizerequests$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagerresizerequests$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'resizeRequest', + 'zone', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new resize request that starts provisioning VMs immediately or queues VM creation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Instancegroupmanagerresizerequests$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Instancegroupmanagerresizerequests$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Instancegroupmanagerresizerequests$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instancegroupmanagerresizerequests$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instancegroupmanagerresizerequests$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagerresizerequests$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagerresizerequests$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Instancegroupmanagerresizerequests$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of resize requests that are contained in the managed instance group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Instancegroupmanagerresizerequests$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Instancegroupmanagerresizerequests$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Instancegroupmanagerresizerequests$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instancegroupmanagerresizerequests$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instancegroupmanagerresizerequests$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagerresizerequests$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagerresizerequests$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagerresizerequests$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Instancegroupmanagerresizerequests$Cancel + extends StandardParameters { + /** + * The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + /** + * The name of the zone where the managed instance group is located. The name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagerresizerequests$Delete + extends StandardParameters { + /** + * The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + /** + * The name of the zone where the managed instance group is located. The name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagerresizerequests$Get + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the resize request. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + /** + * Name of the href="/compute/docs/regions-zones/#available"\>zone scoping this request. Name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Instancegroupmanagerresizerequests$Insert + extends StandardParameters { + /** + * The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagerResizeRequest; + } + export interface Params$Resource$Instancegroupmanagerresizerequests$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The name of the managed instance group. The name should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone where the managed instance group is located. The name should conform to RFC1035. + */ + zone?: string; + } + export class Resource$Instancegroupmanagers { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -89713,6 +90913,1506 @@ export namespace compute_v1 { requestBody?: Schema$SslPolicy; } + export class Resource$Storagepools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Storagepools$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Storagepools$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Storagepools$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Storagepools$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Storagepools$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Storagepools$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/projects/{project}/aggregated/storagePools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified storage pool. Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Storagepools$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Storagepools$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Storagepools$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Storagepools$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Storagepools$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Storagepools$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools/{storagePool}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePool'], + pathParams: ['project', 'storagePool', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns a specified storage pool. Gets a list of available storage pools by making a list() request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Storagepools$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Storagepools$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Storagepools$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Storagepools$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Storagepools$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Storagepools$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Storagepools$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools/{storagePool}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePool'], + pathParams: ['project', 'storagePool', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Storagepools$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Storagepools$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Storagepools$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Storagepools$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Storagepools$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Storagepools$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a storage pool in the specified project using the data in the request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Storagepools$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Storagepools$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Storagepools$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Storagepools$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Storagepools$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Storagepools$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of storage pools contained within the specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Storagepools$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Storagepools$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Storagepools$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Storagepools$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Storagepools$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Storagepools$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the disks in a specified storage pool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listDisks( + params: Params$Resource$Storagepools$Listdisks, + options: StreamMethodOptions + ): GaxiosPromise; + listDisks( + params?: Params$Resource$Storagepools$Listdisks, + options?: MethodOptions + ): GaxiosPromise; + listDisks( + params: Params$Resource$Storagepools$Listdisks, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listDisks( + params: Params$Resource$Storagepools$Listdisks, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listDisks( + params: Params$Resource$Storagepools$Listdisks, + callback: BodyResponseCallback + ): void; + listDisks( + callback: BodyResponseCallback + ): void; + listDisks( + paramsOrCallback?: + | Params$Resource$Storagepools$Listdisks + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Listdisks; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Listdisks; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePool'], + pathParams: ['project', 'storagePool', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Storagepools$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Storagepools$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Storagepools$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Storagepools$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Storagepools$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Storagepools$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Storagepools$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Storagepools$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Storagepools$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Storagepools$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Storagepools$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Storagepools$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: size_tb and provisioned_iops. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Storagepools$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Storagepools$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Storagepools$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Storagepools$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Storagepools$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Storagepools$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepools$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepools$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePools/{storagePool}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePool'], + pathParams: ['project', 'storagePool', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Storagepools$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Storagepools$Delete + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the storage pool to delete. + */ + storagePool?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Get extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the storage pool to return. + */ + storagePool?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StoragePool; + } + export interface Params$Resource$Storagepools$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Listdisks + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name of the storage pool to list disks of. + */ + storagePool?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepools$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Storagepools$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Storagepools$Update + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The storagePool name for this request. + */ + storagePool?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StoragePool; + } + + export class Resource$Storagepooltypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of storage pool types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Storagepooltypes$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Storagepooltypes$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Storagepooltypes$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Storagepooltypes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Storagepooltypes$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Storagepooltypes$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepooltypes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepooltypes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/aggregated/storagePoolTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the specified storage pool type. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Storagepooltypes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Storagepooltypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Storagepooltypes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Storagepooltypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Storagepooltypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Storagepooltypes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepooltypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepooltypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'storagePoolType'], + pathParams: ['project', 'storagePoolType', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of storage pool types available to the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Storagepooltypes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Storagepooltypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Storagepooltypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Storagepooltypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Storagepooltypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Storagepooltypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Storagepooltypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Storagepooltypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/storagePoolTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Storagepooltypes$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Storagepooltypes$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the storage pool type to return. + */ + storagePoolType?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Storagepooltypes$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export class Resource$Subnetworks { context: APIRequestContext; constructor(context: APIRequestContext) { From d81f31d620c083d308ccf33c7de7128501f8b3a6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:49 +0000 Subject: [PATCH 26/78] feat(connectors)!: update the API BREAKING CHANGE: This release has breaking changes. #### connectors:v1 The following keys were deleted: - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.description - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.flatPath - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.httpMethod - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.id - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.parameterOrder - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.path - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.response.$ref - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.delete.scopes - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.description - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.flatPath - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.httpMethod - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.id - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameterOrder - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.path - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.request.$ref - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.response.$ref - resources.projects.resources.locations.resources.global.resources.customConnectors.resources.customConnectorVersions.methods.patch.scopes - schemas.EventingConfig.properties.triggerConfigVariables.description - schemas.EventingConfig.properties.triggerConfigVariables.items.$ref - schemas.EventingConfig.properties.triggerConfigVariables.type The following keys were added: - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.description - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.flatPath - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.httpMethod - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.id - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.parameterOrder - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.parameters.parent.description - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.parameters.parent.location - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.parameters.parent.pattern - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.parameters.parent.required - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.parameters.parent.type - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.path - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.request.$ref - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.response.$ref - resources.projects.resources.locations.resources.customConnectors.methods.validateCustomConnectorSpec.scopes - schemas.ConfigVariableTemplate.properties.enumSource.description - schemas.ConfigVariableTemplate.properties.enumSource.enum - schemas.ConfigVariableTemplate.properties.enumSource.enumDescriptions - schemas.ConfigVariableTemplate.properties.enumSource.type - schemas.CustomConnectorVersion.properties.specServerUrls.description - schemas.CustomConnectorVersion.properties.specServerUrls.items.type - schemas.CustomConnectorVersion.properties.specServerUrls.readOnly - schemas.CustomConnectorVersion.properties.specServerUrls.type - schemas.DestinationConfigTemplate.properties.autocompleteSuggestions.description - schemas.DestinationConfigTemplate.properties.autocompleteSuggestions.items.type - schemas.DestinationConfigTemplate.properties.autocompleteSuggestions.type - schemas.EventSubscription.properties.triggerConfigVariables.description - schemas.EventSubscription.properties.triggerConfigVariables.items.$ref - schemas.EventSubscription.properties.triggerConfigVariables.type - schemas.EventingRuntimeData.properties.webhookData.$ref - schemas.EventingRuntimeData.properties.webhookData.description - schemas.EventingRuntimeData.properties.webhookData.readOnly - schemas.ValidateCustomConnectorSpecRequest.description - schemas.ValidateCustomConnectorSpecRequest.id - schemas.ValidateCustomConnectorSpecRequest.properties.serviceAccount.description - schemas.ValidateCustomConnectorSpecRequest.properties.serviceAccount.type - schemas.ValidateCustomConnectorSpecRequest.properties.specLocation.description - schemas.ValidateCustomConnectorSpecRequest.properties.specLocation.type - schemas.ValidateCustomConnectorSpecRequest.properties.specType.description - schemas.ValidateCustomConnectorSpecRequest.properties.specType.enum - schemas.ValidateCustomConnectorSpecRequest.properties.specType.enumDescriptions - schemas.ValidateCustomConnectorSpecRequest.properties.specType.type - schemas.ValidateCustomConnectorSpecRequest.type - schemas.ValidateCustomConnectorSpecResponse.description - schemas.ValidateCustomConnectorSpecResponse.id - schemas.ValidateCustomConnectorSpecResponse.properties.errorMessage.description - schemas.ValidateCustomConnectorSpecResponse.properties.errorMessage.type - schemas.ValidateCustomConnectorSpecResponse.type - schemas.WebhookData.description - schemas.WebhookData.id - schemas.WebhookData.properties.additionalVariables.description - schemas.WebhookData.properties.additionalVariables.items.$ref - schemas.WebhookData.properties.additionalVariables.readOnly - schemas.WebhookData.properties.additionalVariables.type - schemas.WebhookData.properties.createTime.description - schemas.WebhookData.properties.createTime.format - schemas.WebhookData.properties.createTime.readOnly - schemas.WebhookData.properties.createTime.type - schemas.WebhookData.properties.id.description - schemas.WebhookData.properties.id.readOnly - schemas.WebhookData.properties.id.type - schemas.WebhookData.properties.name.description - schemas.WebhookData.properties.name.readOnly - schemas.WebhookData.properties.name.type - schemas.WebhookData.properties.nextRefreshTime.description - schemas.WebhookData.properties.nextRefreshTime.format - schemas.WebhookData.properties.nextRefreshTime.readOnly - schemas.WebhookData.properties.nextRefreshTime.type - schemas.WebhookData.properties.updateTime.description - schemas.WebhookData.properties.updateTime.format - schemas.WebhookData.properties.updateTime.readOnly - schemas.WebhookData.properties.updateTime.type - schemas.WebhookData.type --- discovery/connectors-v1.json | 222 ++++++++++++++------ src/apis/connectors/v1.ts | 393 +++++++++++++++++------------------ 2 files changed, 351 insertions(+), 264 deletions(-) diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index 3d28519244d..5469885d3a9 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -1113,6 +1113,38 @@ } } }, + "customConnectors": { + "methods": { + "validateCustomConnectorSpec": { + "description": "Validates a Custom Connector Spec.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customConnectors:validateCustomConnectorSpec", + "httpMethod": "POST", + "id": "connectors.projects.locations.customConnectors.validateCustomConnectorSpec", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Location at which the custom connector is being created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customConnectors:validateCustomConnectorSpec", + "request": { + "$ref": "ValidateCustomConnectorSpecRequest" + }, + "response": { + "$ref": "ValidateCustomConnectorSpecResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "endpointAttachments": { "methods": { "create": { @@ -1545,31 +1577,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes a single CustomConnectorVersion.", - "flatPath": "v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}/customConnectorVersions/{customConnectorVersionsId}", - "httpMethod": "DELETE", - "id": "connectors.projects.locations.global.customConnectors.customConnectorVersions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Resource name of the form: `projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/global/customConnectors/[^/]+/customConnectorVersions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { "description": "Gets details of a single CustomConnectorVersion.", "flatPath": "v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}/customConnectorVersions/{customConnectorVersionsId}", @@ -1630,40 +1637,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "patch": { - "description": "Updates the parameters of a CustomConnectorVersion.", - "flatPath": "v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}/customConnectorVersions/{customConnectorVersionsId}", - "httpMethod": "PATCH", - "id": "connectors.projects.locations.global.customConnectors.customConnectorVersions.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}", - "location": "path", - "pattern": "^projects/[^/]+/locations/global/customConnectors/[^/]+/customConnectorVersions/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the Connector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. Set the mask as \"*\" for full replacement, which means all fields will be overwritten.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "CustomConnectorVersion" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } } @@ -2354,7 +2327,7 @@ } } }, - "revision": "20240221", + "revision": "20240305", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2622,6 +2595,18 @@ }, "type": "array" }, + "enumSource": { + "description": "Optional. enum source denotes the source of api to fill the enum options", + "enum": [ + "ENUM_SOURCE_UNSPECIFIED", + "EVENT_TYPES_API" + ], + "enumDescriptions": [ + "Api type unspecified.", + "list event types." + ], + "type": "string" + }, "isAdvanced": { "description": "Indicates if current template is part of advanced settings", "type": "boolean" @@ -3448,6 +3433,14 @@ "description": "Optional. Location of the custom connector spec. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`", "type": "string" }, + "specServerUrls": { + "description": "Output only. Server URLs parsed from the spec.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "state": { "description": "Output only. State of the custom connector version.", "enum": [ @@ -3586,6 +3579,13 @@ "description": "DestinationConfigTemplate defines required destinations supported by the Connector.", "id": "DestinationConfigTemplate", "properties": { + "autocompleteSuggestions": { + "description": "Autocomplete suggestions for destination URL field.", + "items": { + "type": "string" + }, + "type": "array" + }, "defaultPort": { "description": "The default port.", "format": "int32", @@ -3826,6 +3826,13 @@ "description": "Optional. Link for Subscriber of the current EventSubscription.", "type": "string" }, + "triggerConfigVariables": { + "description": "Optional. Configuration for configuring the trigger", + "items": { + "$ref": "ConfigVariable" + }, + "type": "array" + }, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", @@ -3986,13 +3993,6 @@ "registrationDestinationConfig": { "$ref": "DestinationConfig", "description": "Registration endpoint for auto registration." - }, - "triggerConfigVariables": { - "description": "Optional. Additional eventing related field values", - "items": { - "$ref": "ConfigVariable" - }, - "type": "array" } }, "type": "object" @@ -4166,6 +4166,11 @@ "$ref": "EventingStatus", "description": "Output only. Current status of eventing.", "readOnly": true + }, + "webhookData": { + "$ref": "WebhookData", + "description": "Output only. Webhook data.", + "readOnly": true } }, "type": "object" @@ -6965,6 +6970,89 @@ }, "type": "object" }, + "ValidateCustomConnectorSpecRequest": { + "description": "Request message for ConnectorsService.ValidateCustomConnectorSpec", + "id": "ValidateCustomConnectorSpecRequest", + "properties": { + "serviceAccount": { + "description": "Required. Service account to access the spec from Google Cloud Storage.", + "type": "string" + }, + "specLocation": { + "description": "Required. Location of the custom connector spec. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`", + "type": "string" + }, + "specType": { + "description": "Required. Spec type of the custom connector spec.", + "enum": [ + "CUSTOM_CONNECTOR_TYPE_UNSPECIFIED", + "OPEN_API", + "PROTO" + ], + "enumDescriptions": [ + "Connector type is not specified.", + "OpenAPI connector.", + "Proto connector." + ], + "type": "string" + } + }, + "type": "object" + }, + "ValidateCustomConnectorSpecResponse": { + "description": "Response message for ConnectorsService.ValidateCustomConnectorSpec", + "id": "ValidateCustomConnectorSpecResponse", + "properties": { + "errorMessage": { + "description": "Error message. The spec is valid if the error message is empty.", + "type": "string" + } + }, + "type": "object" + }, + "WebhookData": { + "description": "WebhookData has details of webhook configuration.", + "id": "WebhookData", + "properties": { + "additionalVariables": { + "description": "Output only. Additional webhook related field values.", + "items": { + "$ref": "ConfigVariable" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. Timestamp when the webhook was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. ID to uniquely identify webhook.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Name of the Webhook", + "readOnly": true, + "type": "string" + }, + "nextRefreshTime": { + "description": "Output only. Next webhook refresh time. Will be null if refresh is not supported.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the webhook was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "WeeklyCycle": { "description": "Time window specified for weekly operations.", "id": "WeeklyCycle", diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index 4f380b808cc..8dcf605ced5 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -303,6 +303,10 @@ export namespace connectors_v1 { * Enum options. To be populated if `ValueType` is `ENUM` */ enumOptions?: Schema$EnumOption[]; + /** + * Optional. enum source denotes the source of api to fill the enum options + */ + enumSource?: string | null; /** * Indicates if current template is part of advanced settings */ @@ -793,6 +797,10 @@ export namespace connectors_v1 { * Optional. Location of the custom connector spec. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///` */ specLocation?: string | null; + /** + * Output only. Server URLs parsed from the spec. + */ + specServerUrls?: string[] | null; /** * Output only. State of the custom connector version. */ @@ -893,6 +901,10 @@ export namespace connectors_v1 { * DestinationConfigTemplate defines required destinations supported by the Connector. */ export interface Schema$DestinationConfigTemplate { + /** + * Autocomplete suggestions for destination URL field. + */ + autocompleteSuggestions?: string[] | null; /** * The default port. */ @@ -1072,10 +1084,6 @@ export namespace connectors_v1 { * Registration endpoint for auto registration. */ registrationDestinationConfig?: Schema$DestinationConfig; - /** - * Optional. Additional eventing related field values - */ - triggerConfigVariables?: Schema$ConfigVariable[]; } /** * Eventing Config details of a connector version. @@ -1183,6 +1191,10 @@ export namespace connectors_v1 { * Output only. Current status of eventing. */ status?: Schema$EventingStatus; + /** + * Output only. Webhook data. + */ + webhookData?: Schema$WebhookData; } /** * EventingStatus indicates the state of eventing. @@ -1233,6 +1245,10 @@ export namespace connectors_v1 { * Optional. Link for Subscriber of the current EventSubscription. */ subscriberLink?: string | null; + /** + * Optional. Configuration for configuring the trigger + */ + triggerConfigVariables?: Schema$ConfigVariable[]; /** * Output only. Updated time. */ @@ -2815,6 +2831,61 @@ export namespace connectors_v1 { */ username?: string | null; } + /** + * Request message for ConnectorsService.ValidateCustomConnectorSpec + */ + export interface Schema$ValidateCustomConnectorSpecRequest { + /** + * Required. Service account to access the spec from Google Cloud Storage. + */ + serviceAccount?: string | null; + /** + * Required. Location of the custom connector spec. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///` + */ + specLocation?: string | null; + /** + * Required. Spec type of the custom connector spec. + */ + specType?: string | null; + } + /** + * Response message for ConnectorsService.ValidateCustomConnectorSpec + */ + export interface Schema$ValidateCustomConnectorSpecResponse { + /** + * Error message. The spec is valid if the error message is empty. + */ + errorMessage?: string | null; + } + /** + * WebhookData has details of webhook configuration. + */ + export interface Schema$WebhookData { + /** + * Output only. Additional webhook related field values. + */ + additionalVariables?: Schema$ConfigVariable[]; + /** + * Output only. Timestamp when the webhook was created. + */ + createTime?: string | null; + /** + * Output only. ID to uniquely identify webhook. + */ + id?: string | null; + /** + * Output only. Name of the Webhook + */ + name?: string | null; + /** + * Output only. Next webhook refresh time. Will be null if refresh is not supported. + */ + nextRefreshTime?: string | null; + /** + * Output only. Timestamp when the webhook was last updated. + */ + updateTime?: string | null; + } /** * Time window specified for weekly operations. */ @@ -2837,6 +2908,7 @@ export namespace connectors_v1 { export class Resource$Projects$Locations { context: APIRequestContext; connections: Resource$Projects$Locations$Connections; + customConnectors: Resource$Projects$Locations$Customconnectors; endpointAttachments: Resource$Projects$Locations$Endpointattachments; global: Resource$Projects$Locations$Global; operations: Resource$Projects$Locations$Operations; @@ -2846,6 +2918,9 @@ export namespace connectors_v1 { this.connections = new Resource$Projects$Locations$Connections( this.context ); + this.customConnectors = new Resource$Projects$Locations$Customconnectors( + this.context + ); this.endpointAttachments = new Resource$Projects$Locations$Endpointattachments(this.context); this.global = new Resource$Projects$Locations$Global(this.context); @@ -5899,6 +5974,123 @@ export namespace connectors_v1 { parent?: string; } + export class Resource$Projects$Locations$Customconnectors { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Validates a Custom Connector Spec. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + validateCustomConnectorSpec( + params: Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec, + options: StreamMethodOptions + ): GaxiosPromise; + validateCustomConnectorSpec( + params?: Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec, + options?: MethodOptions + ): GaxiosPromise; + validateCustomConnectorSpec( + params: Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validateCustomConnectorSpec( + params: Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validateCustomConnectorSpec( + params: Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec, + callback: BodyResponseCallback + ): void; + validateCustomConnectorSpec( + callback: BodyResponseCallback + ): void; + validateCustomConnectorSpec( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://connectors.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/{+parent}/customConnectors:validateCustomConnectorSpec' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Customconnectors$Validatecustomconnectorspec + extends StandardParameters { + /** + * Required. Location at which the custom connector is being created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ValidateCustomConnectorSpecRequest; + } + export class Resource$Projects$Locations$Endpointattachments { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -7241,91 +7433,6 @@ export namespace connectors_v1 { } } - /** - * Deletes a single CustomConnectorVersion. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://connectors.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Gets details of a single CustomConnectorVersion. * @@ -7512,91 +7619,6 @@ export namespace connectors_v1 { ); } } - - /** - * Updates the parameters of a CustomConnectorVersion. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://connectors.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Create @@ -7615,13 +7637,6 @@ export namespace connectors_v1 { */ requestBody?: Schema$CustomConnectorVersion; } - export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete - extends StandardParameters { - /** - * Required. Resource name of the form: `projects/{project\}/locations/{location\}/customConnectors/{custom_connector\}/customConnectorVersions/{custom_connector_version\}` - */ - name?: string; - } export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Get extends StandardParameters { /** @@ -7644,22 +7659,6 @@ export namespace connectors_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch - extends StandardParameters { - /** - * Output only. Identifier. Resource name of the Version. Format: projects/{project\}/locations/{location\}/customConnectors/{custom_connector\}/customConnectorVersions/{custom_connector_version\} - */ - name?: string; - /** - * Required. Field mask is used to specify the fields to be overwritten in the Connector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. Set the mask as "*" for full replacement, which means all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CustomConnectorVersion; - } export class Resource$Projects$Locations$Global$Managedzones { context: APIRequestContext; From 318ae1a5989ce7b668985c87f03466660494b6bd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:49 +0000 Subject: [PATCH 27/78] fix(contactcenterinsights): update the API #### contactcenterinsights:v1 The following keys were changed: - schemas.GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig.properties.summarizationModel.enum - schemas.GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig.properties.summarizationModel.enumDescriptions - schemas.GoogleCloudContactcenterinsightsV1Settings.properties.pubsubNotificationSettings.description - schemas.GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig.properties.summarizationModel.enum - schemas.GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig.properties.summarizationModel.enumDescriptions --- discovery/contactcenterinsights-v1.json | 16 ++++++++++------ src/apis/contactcenterinsights/v1.ts | 2 +- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 052deb52806..ff1ee42ea3c 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -1473,7 +1473,7 @@ } } }, - "revision": "20240219", + "revision": "20240311", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -1656,11 +1656,13 @@ "description": "Default summarization model to be used.", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", - "BASELINE_MODEL" + "BASELINE_MODEL", + "BASELINE_MODEL_V2_0" ], "enumDescriptions": [ "Unspecified summarization model.", - "The CCAI baseline model." + "The CCAI baseline model.", + "The CCAI baseline model, V2.0." ], "type": "string" } @@ -3810,7 +3812,7 @@ "additionalProperties": { "type": "string" }, - "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", + "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"ingest-conversations\": Notify each time an IngestConversations LRO completes. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", "type": "object" }, "redactionConfig": { @@ -4234,11 +4236,13 @@ "description": "Default summarization model to be used.", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", - "BASELINE_MODEL" + "BASELINE_MODEL", + "BASELINE_MODEL_V2_0" ], "enumDescriptions": [ "Unspecified summarization model.", - "The CCAI baseline model." + "The CCAI baseline model.", + "The CCAI baseline model, V2.0." ], "type": "string" } diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index dedfdbeaedb..a48ae4c65ef 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -3412,7 +3412,7 @@ export namespace contactcenterinsights_v1 { */ name?: string | null; /** - * A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project\}/topics/{topic\} + * A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO completes. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project\}/topics/{topic\} */ pubsubNotificationSettings?: {[key: string]: string} | null; /** From 06429263aef3429e7e842f1c5242ed141414e82b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:49 +0000 Subject: [PATCH 28/78] feat(container): update the API #### container:v1beta1 The following keys were added: - schemas.Cluster.properties.secretManagerConfig.$ref - schemas.Cluster.properties.secretManagerConfig.description - schemas.ClusterUpdate.properties.desiredEnableCiliumClusterwideNetworkPolicy.description - schemas.ClusterUpdate.properties.desiredEnableCiliumClusterwideNetworkPolicy.type - schemas.ClusterUpdate.properties.desiredEnableMultiNetworking.description - schemas.ClusterUpdate.properties.desiredEnableMultiNetworking.type - schemas.ClusterUpdate.properties.desiredSecretManagerConfig.$ref - schemas.ClusterUpdate.properties.desiredSecretManagerConfig.description - schemas.NetworkConfig.properties.enableCiliumClusterwideNetworkPolicy.description - schemas.NetworkConfig.properties.enableCiliumClusterwideNetworkPolicy.type - schemas.NodeConfig.properties.secondaryBootDiskUpdateStrategy.$ref - schemas.NodeConfig.properties.secondaryBootDiskUpdateStrategy.description - schemas.NodeConfig.properties.secondaryBootDisks.description - schemas.NodeConfig.properties.secondaryBootDisks.items.$ref - schemas.NodeConfig.properties.secondaryBootDisks.type - schemas.SecondaryBootDisk.description - schemas.SecondaryBootDisk.id - schemas.SecondaryBootDisk.properties.diskImage.description - schemas.SecondaryBootDisk.properties.diskImage.type - schemas.SecondaryBootDisk.properties.mode.description - schemas.SecondaryBootDisk.properties.mode.enum - schemas.SecondaryBootDisk.properties.mode.enumDescriptions - schemas.SecondaryBootDisk.properties.mode.type - schemas.SecondaryBootDisk.type - schemas.SecondaryBootDiskUpdateStrategy.description - schemas.SecondaryBootDiskUpdateStrategy.id - schemas.SecondaryBootDiskUpdateStrategy.type - schemas.SecretManagerConfig.description - schemas.SecretManagerConfig.id - schemas.SecretManagerConfig.properties.enabled.description - schemas.SecretManagerConfig.properties.enabled.type - schemas.SecretManagerConfig.type #### container:v1 The following keys were added: - schemas.ClusterUpdate.properties.desiredEnableCiliumClusterwideNetworkPolicy.description - schemas.ClusterUpdate.properties.desiredEnableCiliumClusterwideNetworkPolicy.type - schemas.NetworkConfig.properties.enableCiliumClusterwideNetworkPolicy.description - schemas.NetworkConfig.properties.enableCiliumClusterwideNetworkPolicy.type --- discovery/container-v1.json | 10 ++++- discovery/container-v1beta1.json | 73 +++++++++++++++++++++++++++++++- src/apis/container/v1.ts | 8 ++++ src/apis/container/v1beta1.ts | 54 +++++++++++++++++++++++ 4 files changed, 143 insertions(+), 2 deletions(-) diff --git a/discovery/container-v1.json b/discovery/container-v1.json index e61e1e99c9f..a06c094554d 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20240214", + "revision": "20240213", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3534,6 +3534,10 @@ "$ref": "DNSConfig", "description": "DNSConfig contains clusterDNS config for this cluster." }, + "desiredEnableCiliumClusterwideNetworkPolicy": { + "description": "Enable/Disable Cilium Clusterwide Network Policy for the cluster.", + "type": "boolean" + }, "desiredEnableFqdnNetworkPolicy": { "description": "Enable/Disable FQDN Network Policy for the cluster.", "type": "boolean" @@ -4965,6 +4969,10 @@ "$ref": "DNSConfig", "description": "DNSConfig contains clusterDNS config for this cluster." }, + "enableCiliumClusterwideNetworkPolicy": { + "description": "Whether CiliumClusterwideNetworkPolicy is enabled on this cluster.", + "type": "boolean" + }, "enableFqdnNetworkPolicy": { "description": "Whether FQDN Network Policy is enabled on this cluster.", "type": "boolean" diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index 7aee91708b7..f817bad86e4 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20240206", + "revision": "20240229", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3479,6 +3479,10 @@ "$ref": "ResourceUsageExportConfig", "description": "Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified." }, + "secretManagerConfig": { + "$ref": "SecretManagerConfig", + "description": "Secret CSI driver configuration." + }, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture API features for the cluster." @@ -3705,10 +3709,18 @@ "$ref": "DNSConfig", "description": "DNSConfig contains clusterDNS config for this cluster." }, + "desiredEnableCiliumClusterwideNetworkPolicy": { + "description": "Enable/Disable Cilium Clusterwide Network Policy for the cluster.", + "type": "boolean" + }, "desiredEnableFqdnNetworkPolicy": { "description": "Enable/Disable FQDN Network Policy for the cluster.", "type": "boolean" }, + "desiredEnableMultiNetworking": { + "description": "Enable/Disable Multi-Networking for the cluster", + "type": "boolean" + }, "desiredEnablePrivateEndpoint": { "description": "Enable/Disable private endpoint for the cluster's master.", "type": "boolean" @@ -3875,6 +3887,10 @@ "$ref": "ResourceUsageExportConfig", "description": "The desired configuration for exporting resource usage." }, + "desiredSecretManagerConfig": { + "$ref": "SecretManagerConfig", + "description": "Enable/Disable Secret Manager Config." + }, "desiredSecurityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture API features for the cluster." @@ -5333,6 +5349,10 @@ "$ref": "DNSConfig", "description": "DNSConfig contains clusterDNS config for this cluster." }, + "enableCiliumClusterwideNetworkPolicy": { + "description": "Whether CiliumClusterWideNetworkPolicy is enabled on this cluster.", + "type": "boolean" + }, "enableFqdnNetworkPolicy": { "description": "Whether FQDN Network Policy is enabled on this cluster.", "type": "boolean" @@ -5654,6 +5674,17 @@ "$ref": "SandboxConfig", "description": "Sandbox configuration for this node." }, + "secondaryBootDiskUpdateStrategy": { + "$ref": "SecondaryBootDiskUpdateStrategy", + "description": "Secondary boot disk update strategy." + }, + "secondaryBootDisks": { + "description": "List of secondary boot disks attached to the nodes.", + "items": { + "$ref": "SecondaryBootDisk" + }, + "type": "array" + }, "serviceAccount": { "description": "The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the \"default\" service account is used.", "type": "string" @@ -6753,6 +6784,46 @@ }, "type": "object" }, + "SecondaryBootDisk": { + "description": "SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.", + "id": "SecondaryBootDisk", + "properties": { + "diskImage": { + "description": "Fully-qualified resource ID for an existing disk image.", + "type": "string" + }, + "mode": { + "description": "Disk mode (container image cache, etc.)", + "enum": [ + "MODE_UNSPECIFIED", + "CONTAINER_IMAGE_CACHE" + ], + "enumDescriptions": [ + "MODE_UNSPECIFIED is when mode is not set.", + "CONTAINER_IMAGE_CACHE is for using the secondary boot disk as a container image cache." + ], + "type": "string" + } + }, + "type": "object" + }, + "SecondaryBootDiskUpdateStrategy": { + "description": "SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks.", + "id": "SecondaryBootDiskUpdateStrategy", + "properties": {}, + "type": "object" + }, + "SecretManagerConfig": { + "description": "SecretManagerConfig is config for secret manager enablement.", + "id": "SecretManagerConfig", + "properties": { + "enabled": { + "description": "Whether the cluster is configured to use secret manager CSI component.", + "type": "boolean" + } + }, + "type": "object" + }, "SecurityBulletinEvent": { "description": "SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.", "id": "SecurityBulletinEvent", diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 4240e4eb88d..a9a2551528c 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -889,6 +889,10 @@ export namespace container_v1 { * DNSConfig contains clusterDNS config for this cluster. */ desiredDnsConfig?: Schema$DNSConfig; + /** + * Enable/Disable Cilium Clusterwide Network Policy for the cluster. + */ + desiredEnableCiliumClusterwideNetworkPolicy?: boolean | null; /** * Enable/Disable FQDN Network Policy for the cluster. */ @@ -1892,6 +1896,10 @@ export namespace container_v1 { * DNSConfig contains clusterDNS config for this cluster. */ dnsConfig?: Schema$DNSConfig; + /** + * Whether CiliumClusterwideNetworkPolicy is enabled on this cluster. + */ + enableCiliumClusterwideNetworkPolicy?: boolean | null; /** * Whether FQDN Network Policy is enabled on this cluster. */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index a439824553d..94ae84bde5d 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -836,6 +836,10 @@ export namespace container_v1beta1 { * Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified. */ resourceUsageExportConfig?: Schema$ResourceUsageExportConfig; + /** + * Secret CSI driver configuration. + */ + secretManagerConfig?: Schema$SecretManagerConfig; /** * Enable/Disable Security Posture API features for the cluster. */ @@ -988,10 +992,18 @@ export namespace container_v1beta1 { * DNSConfig contains clusterDNS config for this cluster. */ desiredDnsConfig?: Schema$DNSConfig; + /** + * Enable/Disable Cilium Clusterwide Network Policy for the cluster. + */ + desiredEnableCiliumClusterwideNetworkPolicy?: boolean | null; /** * Enable/Disable FQDN Network Policy for the cluster. */ desiredEnableFqdnNetworkPolicy?: boolean | null; + /** + * Enable/Disable Multi-Networking for the cluster + */ + desiredEnableMultiNetworking?: boolean | null; /** * Enable/Disable private endpoint for the cluster's master. */ @@ -1132,6 +1144,10 @@ export namespace container_v1beta1 { * The desired configuration for exporting resource usage. */ desiredResourceUsageExportConfig?: Schema$ResourceUsageExportConfig; + /** + * Enable/Disable Secret Manager Config. + */ + desiredSecretManagerConfig?: Schema$SecretManagerConfig; /** * Enable/Disable Security Posture API features for the cluster. */ @@ -2115,6 +2131,10 @@ export namespace container_v1beta1 { * DNSConfig contains clusterDNS config for this cluster. */ dnsConfig?: Schema$DNSConfig; + /** + * Whether CiliumClusterWideNetworkPolicy is enabled on this cluster. + */ + enableCiliumClusterwideNetworkPolicy?: boolean | null; /** * Whether FQDN Network Policy is enabled on this cluster. */ @@ -2345,6 +2365,14 @@ export namespace container_v1beta1 { * Sandbox configuration for this node. */ sandboxConfig?: Schema$SandboxConfig; + /** + * List of secondary boot disks attached to the nodes. + */ + secondaryBootDisks?: Schema$SecondaryBootDisk[]; + /** + * Secondary boot disk update strategy. + */ + secondaryBootDiskUpdateStrategy?: Schema$SecondaryBootDiskUpdateStrategy; /** * The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. */ @@ -3087,6 +3115,32 @@ export namespace container_v1beta1 { */ type?: string | null; } + /** + * SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode. + */ + export interface Schema$SecondaryBootDisk { + /** + * Fully-qualified resource ID for an existing disk image. + */ + diskImage?: string | null; + /** + * Disk mode (container image cache, etc.) + */ + mode?: string | null; + } + /** + * SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. + */ + export interface Schema$SecondaryBootDiskUpdateStrategy {} + /** + * SecretManagerConfig is config for secret manager enablement. + */ + export interface Schema$SecretManagerConfig { + /** + * Whether the cluster is configured to use secret manager CSI component. + */ + enabled?: boolean | null; + } /** * SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to. */ From 26dd8971179da3ea4456cdd86e382bd3a17d0576 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:49 +0000 Subject: [PATCH 29/78] feat(containeranalysis): update the API #### containeranalysis:v1alpha1 The following keys were added: - schemas.ComplianceNote.properties.impact.description - schemas.ComplianceNote.properties.impact.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enumDeprecated #### containeranalysis:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.notes.methods.get.description - resources.projects.resources.locations.resources.notes.methods.get.flatPath - resources.projects.resources.locations.resources.notes.methods.get.httpMethod - resources.projects.resources.locations.resources.notes.methods.get.id - resources.projects.resources.locations.resources.notes.methods.get.parameterOrder - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.description - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.location - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.required - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.type - resources.projects.resources.locations.resources.notes.methods.get.path - resources.projects.resources.locations.resources.notes.methods.get.response.$ref - resources.projects.resources.locations.resources.notes.methods.get.scopes - resources.projects.resources.locations.resources.notes.methods.list.description - resources.projects.resources.locations.resources.notes.methods.list.flatPath - resources.projects.resources.locations.resources.notes.methods.list.httpMethod - resources.projects.resources.locations.resources.notes.methods.list.id - resources.projects.resources.locations.resources.notes.methods.list.parameterOrder - resources.projects.resources.locations.resources.notes.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.notes.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.notes.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.notes.methods.list.path - resources.projects.resources.locations.resources.notes.methods.list.response.$ref - resources.projects.resources.locations.resources.notes.methods.list.scopes - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.flatPath - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.httpMethod - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.id - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameterOrder - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.location - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.required - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.type - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.path - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.response.$ref - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.scopes - resources.projects.resources.locations.resources.occurrences.methods.get.description - resources.projects.resources.locations.resources.occurrences.methods.get.flatPath - resources.projects.resources.locations.resources.occurrences.methods.get.httpMethod - resources.projects.resources.locations.resources.occurrences.methods.get.id - resources.projects.resources.locations.resources.occurrences.methods.get.parameterOrder - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.description - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.location - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.required - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.type - resources.projects.resources.locations.resources.occurrences.methods.get.path - resources.projects.resources.locations.resources.occurrences.methods.get.response.$ref - resources.projects.resources.locations.resources.occurrences.methods.get.scopes - resources.projects.resources.locations.resources.occurrences.methods.getNotes.description - resources.projects.resources.locations.resources.occurrences.methods.getNotes.flatPath - resources.projects.resources.locations.resources.occurrences.methods.getNotes.httpMethod - resources.projects.resources.locations.resources.occurrences.methods.getNotes.id - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameterOrder - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.description - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.location - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.pattern - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.required - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.type - resources.projects.resources.locations.resources.occurrences.methods.getNotes.path - resources.projects.resources.locations.resources.occurrences.methods.getNotes.response.$ref - resources.projects.resources.locations.resources.occurrences.methods.getNotes.scopes - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.description - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.flatPath - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.httpMethod - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.id - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameterOrder - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.filter.description - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.filter.location - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.filter.type - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.description - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.location - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.pattern - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.required - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.type - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.path - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.response.$ref - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.scopes - resources.projects.resources.locations.resources.occurrences.methods.list.description - resources.projects.resources.locations.resources.occurrences.methods.list.flatPath - resources.projects.resources.locations.resources.occurrences.methods.list.httpMethod - resources.projects.resources.locations.resources.occurrences.methods.list.id - resources.projects.resources.locations.resources.occurrences.methods.list.parameterOrder - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.occurrences.methods.list.path - resources.projects.resources.locations.resources.occurrences.methods.list.response.$ref - resources.projects.resources.locations.resources.occurrences.methods.list.scopes - resources.projects.resources.locations.resources.resources.methods.exportSBOM.description - resources.projects.resources.locations.resources.resources.methods.exportSBOM.flatPath - resources.projects.resources.locations.resources.resources.methods.exportSBOM.httpMethod - resources.projects.resources.locations.resources.resources.methods.exportSBOM.id - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameterOrder - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.description - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.location - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.pattern - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.required - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.type - resources.projects.resources.locations.resources.resources.methods.exportSBOM.path - resources.projects.resources.locations.resources.resources.methods.exportSBOM.request.$ref - resources.projects.resources.locations.resources.resources.methods.exportSBOM.response.$ref - resources.projects.resources.locations.resources.resources.methods.exportSBOM.scopes - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.description - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.flatPath - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.httpMethod - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.id - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.parameterOrder - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.parameters.name.description - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.parameters.name.location - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.parameters.name.pattern - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.parameters.name.required - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.parameters.name.type - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.path - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.request.$ref - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.response.$ref - resources.projects.resources.locations.resources.resources.methods.generatePackagesSummary.scopes - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enumDeprecated #### containeranalysis:v1 The following keys were added: - resources.projects.resources.locations.resources.notes.methods.get.description - resources.projects.resources.locations.resources.notes.methods.get.flatPath - resources.projects.resources.locations.resources.notes.methods.get.httpMethod - resources.projects.resources.locations.resources.notes.methods.get.id - resources.projects.resources.locations.resources.notes.methods.get.parameterOrder - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.description - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.location - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.required - resources.projects.resources.locations.resources.notes.methods.get.parameters.name.type - resources.projects.resources.locations.resources.notes.methods.get.path - resources.projects.resources.locations.resources.notes.methods.get.response.$ref - resources.projects.resources.locations.resources.notes.methods.get.scopes - resources.projects.resources.locations.resources.notes.methods.list.description - resources.projects.resources.locations.resources.notes.methods.list.flatPath - resources.projects.resources.locations.resources.notes.methods.list.httpMethod - resources.projects.resources.locations.resources.notes.methods.list.id - resources.projects.resources.locations.resources.notes.methods.list.parameterOrder - resources.projects.resources.locations.resources.notes.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.notes.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.notes.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.notes.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.notes.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.notes.methods.list.path - resources.projects.resources.locations.resources.notes.methods.list.response.$ref - resources.projects.resources.locations.resources.notes.methods.list.scopes - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.flatPath - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.httpMethod - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.id - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameterOrder - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.location - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.required - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.name.type - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.path - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.response.$ref - resources.projects.resources.locations.resources.notes.resources.occurrences.methods.list.scopes - resources.projects.resources.locations.resources.occurrences.methods.get.description - resources.projects.resources.locations.resources.occurrences.methods.get.flatPath - resources.projects.resources.locations.resources.occurrences.methods.get.httpMethod - resources.projects.resources.locations.resources.occurrences.methods.get.id - resources.projects.resources.locations.resources.occurrences.methods.get.parameterOrder - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.description - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.location - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.required - resources.projects.resources.locations.resources.occurrences.methods.get.parameters.name.type - resources.projects.resources.locations.resources.occurrences.methods.get.path - resources.projects.resources.locations.resources.occurrences.methods.get.response.$ref - resources.projects.resources.locations.resources.occurrences.methods.get.scopes - resources.projects.resources.locations.resources.occurrences.methods.getNotes.description - resources.projects.resources.locations.resources.occurrences.methods.getNotes.flatPath - resources.projects.resources.locations.resources.occurrences.methods.getNotes.httpMethod - resources.projects.resources.locations.resources.occurrences.methods.getNotes.id - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameterOrder - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.description - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.location - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.pattern - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.required - resources.projects.resources.locations.resources.occurrences.methods.getNotes.parameters.name.type - resources.projects.resources.locations.resources.occurrences.methods.getNotes.path - resources.projects.resources.locations.resources.occurrences.methods.getNotes.response.$ref - resources.projects.resources.locations.resources.occurrences.methods.getNotes.scopes - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.description - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.flatPath - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.httpMethod - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.id - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameterOrder - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.filter.description - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.filter.location - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.filter.type - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.description - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.location - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.pattern - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.required - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.parameters.parent.type - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.path - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.response.$ref - resources.projects.resources.locations.resources.occurrences.methods.getVulnerabilitySummary.scopes - resources.projects.resources.locations.resources.occurrences.methods.list.description - resources.projects.resources.locations.resources.occurrences.methods.list.flatPath - resources.projects.resources.locations.resources.occurrences.methods.list.httpMethod - resources.projects.resources.locations.resources.occurrences.methods.list.id - resources.projects.resources.locations.resources.occurrences.methods.list.parameterOrder - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.occurrences.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.occurrences.methods.list.path - resources.projects.resources.locations.resources.occurrences.methods.list.response.$ref - resources.projects.resources.locations.resources.occurrences.methods.list.scopes - resources.projects.resources.locations.resources.resources.methods.exportSBOM.description - resources.projects.resources.locations.resources.resources.methods.exportSBOM.flatPath - resources.projects.resources.locations.resources.resources.methods.exportSBOM.httpMethod - resources.projects.resources.locations.resources.resources.methods.exportSBOM.id - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameterOrder - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.description - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.location - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.pattern - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.required - resources.projects.resources.locations.resources.resources.methods.exportSBOM.parameters.name.type - resources.projects.resources.locations.resources.resources.methods.exportSBOM.path - resources.projects.resources.locations.resources.resources.methods.exportSBOM.request.$ref - resources.projects.resources.locations.resources.resources.methods.exportSBOM.response.$ref - resources.projects.resources.locations.resources.resources.methods.exportSBOM.scopes - schemas.ComplianceNote.properties.impact.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enumDeprecated --- discovery/containeranalysis-v1.json | 291 ++++++- discovery/containeranalysis-v1alpha1.json | 14 +- discovery/containeranalysis-v1beta1.json | 316 ++++++- src/apis/containeranalysis/v1.ts | 878 +++++++++++++++++++ src/apis/containeranalysis/v1alpha1.ts | 4 + src/apis/containeranalysis/v1beta1.ts | 988 ++++++++++++++++++++++ 6 files changed, 2488 insertions(+), 3 deletions(-) diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index fd09828055d..1e9334f9f20 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -107,6 +107,284 @@ "resources": { "projects": { "resources": { + "locations": { + "resources": { + "notes": { + "methods": { + "get": { + "description": "Gets the specified note.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.notes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists notes for the specified project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.notes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token to provide to skip to a particular spot in the list.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/notes", + "response": { + "$ref": "ListNotesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "occurrences": { + "methods": { + "list": { + "description": "Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.notes.occurrences.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The filter expression.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Number of occurrences to return in the list.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token to provide to skip to a particular spot in the list.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/occurrences", + "response": { + "$ref": "ListNoteOccurrencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "occurrences": { + "methods": { + "get": { + "description": "Gets the specified occurrence.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.occurrences.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Occurrence" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getNotes": { + "description": "Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.occurrences.getNotes", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/notes", + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getVulnerabilitySummary": { + "description": "Gets a summary of the number and severity of occurrences.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.occurrences.getVulnerabilitySummary", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/occurrences:vulnerabilitySummary", + "response": { + "$ref": "VulnerabilityOccurrencesSummary" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists occurrences for the specified project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.occurrences.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token to provide to skip to a particular spot in the list.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/occurrences", + "response": { + "$ref": "ListOccurrencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "resources": { + "methods": { + "exportSBOM": { + "description": "Generates an SBOM for the given resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.resources.exportSBOM", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/resources/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:exportSBOM", + "request": { + "$ref": "ExportSBOMRequest" + }, + "response": { + "$ref": "ExportSBOMResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "notes": { "methods": { "batchCreate": { @@ -787,7 +1065,7 @@ } } }, - "revision": "20240220", + "revision": "20240308", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -1766,6 +2044,9 @@ "description": "A description about this compliance check.", "type": "string" }, + "impact": { + "type": "string" + }, "rationale": { "description": "A rationale for the existence of this compliance check.", "type": "string" @@ -2347,6 +2628,14 @@ "E2_HIGHCPU_32", "E2_MEDIUM" ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "Standard machine type.", "Highcpu machine with 8 CPUs.", diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index 23d678cbbbe..26f2d5fa96a 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -1233,7 +1233,7 @@ } } }, - "revision": "20240220", + "revision": "20240308", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -2015,6 +2015,10 @@ "description": "A description about this compliance check.", "type": "string" }, + "impact": { + "description": "Potential impact of the suggested remediation", + "type": "string" + }, "rationale": { "description": "A rationale for the existence of this compliance check.", "type": "string" @@ -2598,6 +2602,14 @@ "E2_HIGHCPU_32", "E2_MEDIUM" ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "Standard machine type.", "Highcpu machine with 8 CPUs.", diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index 461a271bde7..998c3793669 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -107,6 +107,312 @@ "resources": { "projects": { "resources": { + "locations": { + "resources": { + "notes": { + "methods": { + "get": { + "description": "Gets the specified note.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.notes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists notes for the specified project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.notes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token to provide to skip to a particular spot in the list.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/notes", + "response": { + "$ref": "ListNotesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "occurrences": { + "methods": { + "list": { + "description": "Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.notes.occurrences.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The filter expression.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Number of occurrences to return in the list.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token to provide to skip to a particular spot in the list.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/occurrences", + "response": { + "$ref": "ListNoteOccurrencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "occurrences": { + "methods": { + "get": { + "description": "Gets the specified occurrence.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.occurrences.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Occurrence" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getNotes": { + "description": "Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.occurrences.getNotes", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/notes", + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getVulnerabilitySummary": { + "description": "Gets a summary of the number and severity of occurrences.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.occurrences.getVulnerabilitySummary", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/occurrences:vulnerabilitySummary", + "response": { + "$ref": "VulnerabilityOccurrencesSummary" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists occurrences for the specified project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences", + "httpMethod": "GET", + "id": "containeranalysis.projects.locations.occurrences.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token to provide to skip to a particular spot in the list.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/occurrences", + "response": { + "$ref": "ListOccurrencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "resources": { + "methods": { + "exportSBOM": { + "description": "Generates an SBOM and other dependency information for the given resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.resources.exportSBOM", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/resources/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:exportSBOM", + "request": { + "$ref": "ExportSBOMRequest" + }, + "response": { + "$ref": "ExportSBOMResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generatePackagesSummary": { + "description": "Gets a summary of the packages within a given resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:generatePackagesSummary", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.resources.generatePackagesSummary", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource to get a packages summary for in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/resources/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:generatePackagesSummary", + "request": { + "$ref": "GeneratePackagesSummaryRequest" + }, + "response": { + "$ref": "PackagesSummaryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "notes": { "methods": { "batchCreate": { @@ -815,7 +1121,7 @@ } } }, - "revision": "20240220", + "revision": "20240308", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2282,6 +2588,14 @@ "E2_HIGHCPU_32", "E2_MEDIUM" ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "Standard machine type.", "Highcpu machine with 8 CPUs.", diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index afb011e0a83..94968c7db0f 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -555,6 +555,7 @@ export namespace containeranalysis_v1 { * A description about this compliance check. */ description?: string | null; + impact?: string | null; /** * A rationale for the existence of this compliance check. */ @@ -3260,17 +3261,894 @@ export namespace containeranalysis_v1 { export class Resource$Projects { context: APIRequestContext; + locations: Resource$Projects$Locations; notes: Resource$Projects$Notes; occurrences: Resource$Projects$Occurrences; resources: Resource$Projects$Resources; constructor(context: APIRequestContext) { this.context = context; + this.locations = new Resource$Projects$Locations(this.context); this.notes = new Resource$Projects$Notes(this.context); this.occurrences = new Resource$Projects$Occurrences(this.context); this.resources = new Resource$Projects$Resources(this.context); } } + export class Resource$Projects$Locations { + context: APIRequestContext; + notes: Resource$Projects$Locations$Notes; + occurrences: Resource$Projects$Locations$Occurrences; + resources: Resource$Projects$Locations$Resources; + constructor(context: APIRequestContext) { + this.context = context; + this.notes = new Resource$Projects$Locations$Notes(this.context); + this.occurrences = new Resource$Projects$Locations$Occurrences( + this.context + ); + this.resources = new Resource$Projects$Locations$Resources(this.context); + } + } + + export class Resource$Projects$Locations$Notes { + context: APIRequestContext; + occurrences: Resource$Projects$Locations$Notes$Occurrences; + constructor(context: APIRequestContext) { + this.context = context; + this.occurrences = new Resource$Projects$Locations$Notes$Occurrences( + this.context + ); + } + + /** + * Gets the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Notes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists notes for the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/notes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Notes$Get + extends StandardParameters { + /** + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notes$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + /** + * Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Notes$Occurrences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Occurrences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Occurrences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notes$Occurrences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/occurrences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Notes$Occurrences$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + /** + * Number of occurrences to return in the list. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Occurrences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the specified occurrence. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Occurrences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getNotes( + params: Params$Resource$Projects$Locations$Occurrences$Getnotes, + options: StreamMethodOptions + ): GaxiosPromise; + getNotes( + params?: Params$Resource$Projects$Locations$Occurrences$Getnotes, + options?: MethodOptions + ): GaxiosPromise; + getNotes( + params: Params$Resource$Projects$Locations$Occurrences$Getnotes, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getNotes( + params: Params$Resource$Projects$Locations$Occurrences$Getnotes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getNotes( + params: Params$Resource$Projects$Locations$Occurrences$Getnotes, + callback: BodyResponseCallback + ): void; + getNotes(callback: BodyResponseCallback): void; + getNotes( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Getnotes + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Getnotes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Getnotes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/notes').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a summary of the number and severity of occurrences. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getVulnerabilitySummary( + params: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + options: StreamMethodOptions + ): GaxiosPromise; + getVulnerabilitySummary( + params?: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + options?: MethodOptions + ): GaxiosPromise; + getVulnerabilitySummary( + params: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getVulnerabilitySummary( + params: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getVulnerabilitySummary( + params: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + callback: BodyResponseCallback + ): void; + getVulnerabilitySummary( + callback: BodyResponseCallback + ): void; + getVulnerabilitySummary( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/occurrences:vulnerabilitySummary' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists occurrences for the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Occurrences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Occurrences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Occurrences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Occurrences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Occurrences$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/occurrences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Occurrences$Get + extends StandardParameters { + /** + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Occurrences$Getnotes + extends StandardParameters { + /** + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Occurrences$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + /** + * Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Resources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Generates an SBOM for the given resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + exportSBOM( + params: Params$Resource$Projects$Locations$Resources$Exportsbom, + options: StreamMethodOptions + ): GaxiosPromise; + exportSBOM( + params?: Params$Resource$Projects$Locations$Resources$Exportsbom, + options?: MethodOptions + ): GaxiosPromise; + exportSBOM( + params: Params$Resource$Projects$Locations$Resources$Exportsbom, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportSBOM( + params: Params$Resource$Projects$Locations$Resources$Exportsbom, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportSBOM( + params: Params$Resource$Projects$Locations$Resources$Exportsbom, + callback: BodyResponseCallback + ): void; + exportSBOM(callback: BodyResponseCallback): void; + exportSBOM( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Resources$Exportsbom + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Resources$Exportsbom; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Resources$Exportsbom; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:exportSBOM').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Resources$Exportsbom + extends StandardParameters { + /** + * Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportSBOMRequest; + } + export class Resource$Projects$Notes { context: APIRequestContext; occurrences: Resource$Projects$Notes$Occurrences; diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 892d727c0b7..1e625e6bbde 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -526,6 +526,10 @@ export namespace containeranalysis_v1alpha1 { * A description about this compliance check. */ description?: string | null; + /** + * Potential impact of the suggested remediation + */ + impact?: string | null; /** * A rationale for the existence of this compliance check. */ diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index 0d81bd36828..91c09f36f79 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -3316,17 +3316,1005 @@ export namespace containeranalysis_v1beta1 { export class Resource$Projects { context: APIRequestContext; + locations: Resource$Projects$Locations; notes: Resource$Projects$Notes; occurrences: Resource$Projects$Occurrences; resources: Resource$Projects$Resources; constructor(context: APIRequestContext) { this.context = context; + this.locations = new Resource$Projects$Locations(this.context); this.notes = new Resource$Projects$Notes(this.context); this.occurrences = new Resource$Projects$Occurrences(this.context); this.resources = new Resource$Projects$Resources(this.context); } } + export class Resource$Projects$Locations { + context: APIRequestContext; + notes: Resource$Projects$Locations$Notes; + occurrences: Resource$Projects$Locations$Occurrences; + resources: Resource$Projects$Locations$Resources; + constructor(context: APIRequestContext) { + this.context = context; + this.notes = new Resource$Projects$Locations$Notes(this.context); + this.occurrences = new Resource$Projects$Locations$Occurrences( + this.context + ); + this.resources = new Resource$Projects$Locations$Resources(this.context); + } + } + + export class Resource$Projects$Locations$Notes { + context: APIRequestContext; + occurrences: Resource$Projects$Locations$Notes$Occurrences; + constructor(context: APIRequestContext) { + this.context = context; + this.occurrences = new Resource$Projects$Locations$Notes$Occurrences( + this.context + ); + } + + /** + * Gets the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Notes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists notes for the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/notes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Notes$Get + extends StandardParameters { + /** + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notes$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + /** + * Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Notes$Occurrences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Occurrences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Occurrences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notes$Occurrences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/occurrences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Notes$Occurrences$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + /** + * Number of occurrences to return in the list. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Occurrences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the specified occurrence. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Occurrences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getNotes( + params: Params$Resource$Projects$Locations$Occurrences$Getnotes, + options: StreamMethodOptions + ): GaxiosPromise; + getNotes( + params?: Params$Resource$Projects$Locations$Occurrences$Getnotes, + options?: MethodOptions + ): GaxiosPromise; + getNotes( + params: Params$Resource$Projects$Locations$Occurrences$Getnotes, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getNotes( + params: Params$Resource$Projects$Locations$Occurrences$Getnotes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getNotes( + params: Params$Resource$Projects$Locations$Occurrences$Getnotes, + callback: BodyResponseCallback + ): void; + getNotes(callback: BodyResponseCallback): void; + getNotes( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Getnotes + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Getnotes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Getnotes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/notes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a summary of the number and severity of occurrences. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getVulnerabilitySummary( + params: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + options: StreamMethodOptions + ): GaxiosPromise; + getVulnerabilitySummary( + params?: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + options?: MethodOptions + ): GaxiosPromise; + getVulnerabilitySummary( + params: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getVulnerabilitySummary( + params: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getVulnerabilitySummary( + params: Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary, + callback: BodyResponseCallback + ): void; + getVulnerabilitySummary( + callback: BodyResponseCallback + ): void; + getVulnerabilitySummary( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/occurrences:vulnerabilitySummary' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists occurrences for the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Occurrences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Occurrences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Occurrences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Occurrences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Occurrences$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/occurrences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Occurrences$Get + extends StandardParameters { + /** + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Occurrences$Getnotes + extends StandardParameters { + /** + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Occurrences$Getvulnerabilitysummary + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Occurrences$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + /** + * Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Resources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Generates an SBOM and other dependency information for the given resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + exportSBOM( + params: Params$Resource$Projects$Locations$Resources$Exportsbom, + options: StreamMethodOptions + ): GaxiosPromise; + exportSBOM( + params?: Params$Resource$Projects$Locations$Resources$Exportsbom, + options?: MethodOptions + ): GaxiosPromise; + exportSBOM( + params: Params$Resource$Projects$Locations$Resources$Exportsbom, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportSBOM( + params: Params$Resource$Projects$Locations$Resources$Exportsbom, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportSBOM( + params: Params$Resource$Projects$Locations$Resources$Exportsbom, + callback: BodyResponseCallback + ): void; + exportSBOM(callback: BodyResponseCallback): void; + exportSBOM( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Resources$Exportsbom + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Resources$Exportsbom; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Resources$Exportsbom; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:exportSBOM').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a summary of the packages within a given resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generatePackagesSummary( + params: Params$Resource$Projects$Locations$Resources$Generatepackagessummary, + options: StreamMethodOptions + ): GaxiosPromise; + generatePackagesSummary( + params?: Params$Resource$Projects$Locations$Resources$Generatepackagessummary, + options?: MethodOptions + ): GaxiosPromise; + generatePackagesSummary( + params: Params$Resource$Projects$Locations$Resources$Generatepackagessummary, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generatePackagesSummary( + params: Params$Resource$Projects$Locations$Resources$Generatepackagessummary, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generatePackagesSummary( + params: Params$Resource$Projects$Locations$Resources$Generatepackagessummary, + callback: BodyResponseCallback + ): void; + generatePackagesSummary( + callback: BodyResponseCallback + ): void; + generatePackagesSummary( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Resources$Generatepackagessummary + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Resources$Generatepackagessummary; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Resources$Generatepackagessummary; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:generatePackagesSummary').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Resources$Exportsbom + extends StandardParameters { + /** + * Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportSBOMRequest; + } + export interface Params$Resource$Projects$Locations$Resources$Generatepackagessummary + extends StandardParameters { + /** + * Required. The name of the resource to get a packages summary for in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GeneratePackagesSummaryRequest; + } + export class Resource$Projects$Notes { context: APIRequestContext; occurrences: Resource$Projects$Notes$Occurrences; From 6a26ecc24d64e25562ba79ecd89dd8efc3f1aab6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:49 +0000 Subject: [PATCH 30/78] feat(content): update the API #### content:v2.1 The following keys were added: - schemas.MethodQuota.properties.method.readOnly - schemas.MethodQuota.properties.quotaLimit.readOnly - schemas.MethodQuota.properties.quotaMinuteLimit.description - schemas.MethodQuota.properties.quotaMinuteLimit.format - schemas.MethodQuota.properties.quotaMinuteLimit.readOnly - schemas.MethodQuota.properties.quotaMinuteLimit.type - schemas.MethodQuota.properties.quotaUsage.readOnly - schemas.ProductView.properties.clickPotential.description - schemas.ProductView.properties.clickPotential.enum - schemas.ProductView.properties.clickPotential.enumDescriptions - schemas.ProductView.properties.clickPotential.type - schemas.ProductView.properties.clickPotentialRank.description - schemas.ProductView.properties.clickPotentialRank.format - schemas.ProductView.properties.clickPotentialRank.type - schemas.ReportRow.properties.topicTrends.$ref - schemas.ReportRow.properties.topicTrends.description - schemas.TopicTrends.description - schemas.TopicTrends.id - schemas.TopicTrends.properties.customerCountryCode.description - schemas.TopicTrends.properties.customerCountryCode.type - schemas.TopicTrends.properties.date.$ref - schemas.TopicTrends.properties.date.description - schemas.TopicTrends.properties.last120DaysSearchInterest.description - schemas.TopicTrends.properties.last120DaysSearchInterest.format - schemas.TopicTrends.properties.last120DaysSearchInterest.type - schemas.TopicTrends.properties.last30DaysSearchInterest.description - schemas.TopicTrends.properties.last30DaysSearchInterest.format - schemas.TopicTrends.properties.last30DaysSearchInterest.type - schemas.TopicTrends.properties.last7DaysSearchInterest.description - schemas.TopicTrends.properties.last7DaysSearchInterest.format - schemas.TopicTrends.properties.last7DaysSearchInterest.type - schemas.TopicTrends.properties.last90DaysSearchInterest.description - schemas.TopicTrends.properties.last90DaysSearchInterest.format - schemas.TopicTrends.properties.last90DaysSearchInterest.type - schemas.TopicTrends.properties.next7DaysSearchInterest.description - schemas.TopicTrends.properties.next7DaysSearchInterest.format - schemas.TopicTrends.properties.next7DaysSearchInterest.type - schemas.TopicTrends.properties.searchInterest.description - schemas.TopicTrends.properties.searchInterest.format - schemas.TopicTrends.properties.searchInterest.type - schemas.TopicTrends.properties.topic.description - schemas.TopicTrends.properties.topic.type - schemas.TopicTrends.type The following keys were changed: - schemas.DatafeedTarget.properties.excludedDestinations.description - schemas.DatafeedTarget.properties.includedDestinations.description - schemas.MethodQuota.properties.method.description - schemas.MethodQuota.properties.quotaLimit.description - schemas.MethodQuota.properties.quotaUsage.description - schemas.Product.properties.excludedDestinations.description - schemas.Product.properties.includedDestinations.description --- discovery/content-v2.1.json | 99 ++++++++++++++++++++++++++++++++++--- src/apis/content/v2.1.ts | 71 +++++++++++++++++++++++--- 2 files changed, 155 insertions(+), 15 deletions(-) diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json index f1a1e02210a..fb36d110081 100644 --- a/discovery/content-v2.1.json +++ b/discovery/content-v2.1.json @@ -6186,7 +6186,7 @@ } } }, - "revision": "20240226", + "revision": "20240312", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -8841,7 +8841,7 @@ "type": "string" }, "excludedDestinations": { - "description": "The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.", + "description": "The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.", "items": { "type": "string" }, @@ -8852,7 +8852,7 @@ "type": "string" }, "includedDestinations": { - "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.", + "description": "The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.", "items": { "type": "string" }, @@ -10629,17 +10629,26 @@ "id": "MethodQuota", "properties": { "method": { - "description": "The method name, for example `products.list`. Method name does not contain version because quota can be shared between different API versions of the same method.", + "description": "Output only. The method name, for example `products.list`. Method name does not contain version because quota can be shared between different API versions of the same method.", + "readOnly": true, "type": "string" }, "quotaLimit": { - "description": "The current quota limit per day, meaning the maximum number of calls for the method.", + "description": "Output only. The maximum number of calls allowed per day for the method.", "format": "int64", + "readOnly": true, + "type": "string" + }, + "quotaMinuteLimit": { + "description": "Output only. The maximum number of calls allowed per minute for the method.", + "format": "int64", + "readOnly": true, "type": "string" }, "quotaUsage": { - "description": "The current quota usage, meaning the number of calls already made to the method.", + "description": "Output only. The current quota usage, meaning the number of calls already made to the method per day. Usage is reset every day at 12 PM midday UTC.", "format": "int64", + "readOnly": true, "type": "string" } }, @@ -13870,7 +13879,7 @@ "type": "string" }, "excludedDestinations": { - "description": "The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.", + "description": "The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.", "items": { "type": "string" }, @@ -13913,7 +13922,7 @@ "type": "string" }, "includedDestinations": { - "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.", + "description": "The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.", "items": { "type": "string" }, @@ -14804,6 +14813,27 @@ ], "type": "string" }, + "clickPotential": { + "description": "Estimated performance potential compared to highest performing products of the merchant.", + "enum": [ + "CLICK_POTENTIAL_UNSPECIFIED", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Unknown predicted clicks impact.", + "Potential to receive a low number of clicks compared to the highest performing products of the merchant.", + "Potential to receive a moderate number of clicks compared to the highest performing products of the merchant.", + "Potential to receive a similar number of clicks as the highest performing products of the merchant." + ], + "type": "string" + }, + "clickPotentialRank": { + "description": "Rank of the product based on its click potential. A product with `click_potential_rank` 1 has the highest click potential among the merchant's products that fulfill the search query conditions.", + "format": "int64", + "type": "string" + }, "condition": { "description": "Condition of the product.", "type": "string" @@ -16159,6 +16189,10 @@ "segments": { "$ref": "Segments", "description": "Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query." + }, + "topicTrends": { + "$ref": "TopicTrends", + "description": "Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. https://support.google.com/merchants/answer/13542370." } }, "type": "object" @@ -18033,6 +18067,55 @@ }, "type": "object" }, + "TopicTrends": { + "description": "Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`.", + "id": "TopicTrends", + "properties": { + "customerCountryCode": { + "description": "Country trends are calculated for. Must be a two-letter country code (ISO 3166-1-alpha-2 code), for example, `“US”`.", + "type": "string" + }, + "date": { + "$ref": "Date", + "description": "Date the trend score was retrieved." + }, + "last120DaysSearchInterest": { + "description": "Search interest in the last 120 days, with the same normalization as search_interest. This field is only present for a past date.", + "format": "double", + "type": "number" + }, + "last30DaysSearchInterest": { + "description": "Search interest in the last 30 days, with the same normalization as search_interest. This field is only present for a past date.", + "format": "double", + "type": "number" + }, + "last7DaysSearchInterest": { + "description": "Search interest in the last 7 days, with the same normalization as search_interest. This field is only present for a past date.", + "format": "double", + "type": "number" + }, + "last90DaysSearchInterest": { + "description": "Search interest in the last 90 days, with the same normalization as search_interest. This field is only present for a past date.", + "format": "double", + "type": "number" + }, + "next7DaysSearchInterest": { + "description": "Estimated search interest in the next 7 days, with the same normalization as search_interest. This field is only present for a future date.", + "format": "double", + "type": "number" + }, + "searchInterest": { + "description": "Daily search interest, normalized to the time and country to make comparisons easier, with 100 representing peak popularity (from 0 to 100) for the requested time period and location.", + "format": "double", + "type": "number" + }, + "topic": { + "description": "Google-provided topic trends are calculated for. Only top eight topics are returned. Topic is what shoppers are searching for on Google, grouped by the same concept.", + "type": "string" + } + }, + "type": "object" + }, "TransitTable": { "id": "TransitTable", "properties": { diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 8693b422851..b8c881a48de 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -2210,7 +2210,7 @@ export namespace content_v2_1 { */ country?: string | null; /** - * The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. + * The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. */ excludedDestinations?: string[] | null; /** @@ -2218,7 +2218,7 @@ export namespace content_v2_1 { */ feedLabel?: string | null; /** - * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. + * The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. */ includedDestinations?: string[] | null; /** @@ -3326,15 +3326,19 @@ export namespace content_v2_1 { */ export interface Schema$MethodQuota { /** - * The method name, for example `products.list`. Method name does not contain version because quota can be shared between different API versions of the same method. + * Output only. The method name, for example `products.list`. Method name does not contain version because quota can be shared between different API versions of the same method. */ method?: string | null; /** - * The current quota limit per day, meaning the maximum number of calls for the method. + * Output only. The maximum number of calls allowed per day for the method. */ quotaLimit?: string | null; /** - * The current quota usage, meaning the number of calls already made to the method. + * Output only. The maximum number of calls allowed per minute for the method. + */ + quotaMinuteLimit?: string | null; + /** + * Output only. The current quota usage, meaning the number of calls already made to the method per day. Usage is reset every day at 12 PM midday UTC. */ quotaUsage?: string | null; } @@ -5870,7 +5874,7 @@ export namespace content_v2_1 { */ energyEfficiencyClass?: string | null; /** - * The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. + * The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted. */ excludedDestinations?: string[] | null; /** @@ -5910,7 +5914,7 @@ export namespace content_v2_1 { */ imageLink?: string | null; /** - * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. + * The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. */ includedDestinations?: string[] | null; /** @@ -6749,6 +6753,14 @@ export namespace content_v2_1 { * Channel of the product (online versus local). */ channel?: string | null; + /** + * Estimated performance potential compared to highest performing products of the merchant. + */ + clickPotential?: string | null; + /** + * Rank of the product based on its click potential. A product with `click_potential_rank` 1 has the highest click potential among the merchant's products that fulfill the search query conditions. + */ + clickPotentialRank?: string | null; /** * Condition of the product. */ @@ -7521,6 +7533,10 @@ export namespace content_v2_1 { * Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query. */ segments?: Schema$Segments; + /** + * Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. https://support.google.com/merchants/answer/13542370. + */ + topicTrends?: Schema$TopicTrends; } /** * Request message for the RequestPhoneVerification method. @@ -8852,6 +8868,47 @@ export namespace content_v2_1 { */ version?: string | null; } + /** + * Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. + */ + export interface Schema$TopicTrends { + /** + * Country trends are calculated for. Must be a two-letter country code (ISO 3166-1-alpha-2 code), for example, `“US”`. + */ + customerCountryCode?: string | null; + /** + * Date the trend score was retrieved. + */ + date?: Schema$Date; + /** + * Search interest in the last 120 days, with the same normalization as search_interest. This field is only present for a past date. + */ + last120DaysSearchInterest?: number | null; + /** + * Search interest in the last 30 days, with the same normalization as search_interest. This field is only present for a past date. + */ + last30DaysSearchInterest?: number | null; + /** + * Search interest in the last 7 days, with the same normalization as search_interest. This field is only present for a past date. + */ + last7DaysSearchInterest?: number | null; + /** + * Search interest in the last 90 days, with the same normalization as search_interest. This field is only present for a past date. + */ + last90DaysSearchInterest?: number | null; + /** + * Estimated search interest in the next 7 days, with the same normalization as search_interest. This field is only present for a future date. + */ + next7DaysSearchInterest?: number | null; + /** + * Daily search interest, normalized to the time and country to make comparisons easier, with 100 representing peak popularity (from 0 to 100) for the requested time period and location. + */ + searchInterest?: number | null; + /** + * Google-provided topic trends are calculated for. Only top eight topics are returned. Topic is what shoppers are searching for on Google, grouped by the same concept. + */ + topic?: string | null; + } export interface Schema$TransitTable { /** * A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. From ad1b4a63cfdcb7cd0b0700798e7114cb8c3210b9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:50 +0000 Subject: [PATCH 31/78] feat(dataform)!: update the API BREAKING CHANGE: This release has breaking changes. #### dataform:v1beta1 The following keys were deleted: - schemas.ReleaseConfig.properties.name.readOnly - schemas.Repository.properties.name.readOnly - schemas.Workspace.properties.name.readOnly The following keys were changed: - resources.projects.resources.locations.resources.repositories.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.repositories.resources.releaseConfigs.methods.patch.parameters.name.description - schemas.ReleaseConfig.properties.name.description - schemas.Repository.properties.name.description - schemas.Workspace.properties.name.description --- discovery/dataform-v1beta1.json | 15 ++++++--------- src/apis/dataform/v1beta1.ts | 10 +++++----- 2 files changed, 11 insertions(+), 14 deletions(-) diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index 6d72397d55f..5dd4480f850 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -558,7 +558,7 @@ ], "parameters": { "name": { - "description": "Output only. The repository's name.", + "description": "Identifier. The repository's name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", "required": true, @@ -991,7 +991,7 @@ ], "parameters": { "name": { - "description": "Output only. The release config's name.", + "description": "Identifier. The release config's name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", "required": true, @@ -2103,7 +2103,7 @@ } } }, - "revision": "20240203", + "revision": "20240310", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { @@ -3431,8 +3431,7 @@ "type": "string" }, "name": { - "description": "Output only. The release config's name.", - "readOnly": true, + "description": "Identifier. The release config's name.", "type": "string" }, "recentScheduledReleaseRecords": { @@ -3502,8 +3501,7 @@ "type": "object" }, "name": { - "description": "Output only. The repository's name.", - "readOnly": true, + "description": "Identifier. The repository's name.", "type": "string" }, "npmrcEnvironmentVariablesSecretVersion": { @@ -3896,8 +3894,7 @@ "id": "Workspace", "properties": { "name": { - "description": "Output only. The workspace's name.", - "readOnly": true, + "description": "Identifier. The workspace's name.", "type": "string" } }, diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index bdc5987de85..edbeeb1f03f 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -1114,7 +1114,7 @@ export namespace dataform_v1beta1 { */ gitCommitish?: string | null; /** - * Output only. The release config's name. + * Identifier. The release config's name. */ name?: string | null; /** @@ -1169,7 +1169,7 @@ export namespace dataform_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Output only. The repository's name. + * Identifier. The repository's name. */ name?: string | null; /** @@ -1445,7 +1445,7 @@ export namespace dataform_v1beta1 { */ export interface Schema$Workspace { /** - * Output only. The workspace's name. + * Identifier. The workspace's name. */ name?: string | null; } @@ -3445,7 +3445,7 @@ export namespace dataform_v1beta1 { export interface Params$Resource$Projects$Locations$Repositories$Patch extends StandardParameters { /** - * Output only. The repository's name. + * Identifier. The repository's name. */ name?: string; /** @@ -4452,7 +4452,7 @@ export namespace dataform_v1beta1 { export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch extends StandardParameters { /** - * Output only. The release config's name. + * Identifier. The release config's name. */ name?: string; /** From 14a6f0e581e9be4d14b43b02769711e4e3020c00 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:50 +0000 Subject: [PATCH 32/78] feat(dataplex): update the API #### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActions.properties.notificationReport.$ref - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActions.properties.notificationReport.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger.id - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger.type - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger.id - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger.type - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.id - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.properties.jobEndTrigger.$ref - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.properties.jobEndTrigger.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.properties.jobFailureTrigger.$ref - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.properties.jobFailureTrigger.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.properties.recipients.$ref - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.properties.recipients.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.properties.scoreThresholdTrigger.$ref - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.properties.scoreThresholdTrigger.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport.type - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients.id - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients.properties.emails.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients.properties.emails.items.type - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients.properties.emails.type - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients.type - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger.id - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger.properties.scoreThreshold.description - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger.properties.scoreThreshold.format - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger.properties.scoreThreshold.type - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger.type --- discovery/dataplex-v1.json | 67 +++++++++++++++++++++++++++++++++++++- src/apis/dataplex/v1.ts | 51 +++++++++++++++++++++++++++++ 2 files changed, 117 insertions(+), 1 deletion(-) diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index a7c09f9d102..3d77505fb5e 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -4360,7 +4360,7 @@ } } }, - "revision": "20240124", + "revision": "20240304", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -6027,6 +6027,10 @@ "bigqueryExport": { "$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport", "description": "Optional. If set, results will be exported to the provided BigQuery table." + }, + "notificationReport": { + "$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport", + "description": "Optional. If set, results will be sent to the provided notification receipts upon triggers." } }, "type": "object" @@ -6042,6 +6046,67 @@ }, "type": "object" }, + "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger": { + "description": "This trigger is triggered whenever a scan job run ends, regardless of the result.", + "id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger": { + "description": "This trigger is triggered when the scan job itself fails, regardless of the result.", + "id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport": { + "description": "The configuration of notification report post scan action.", + "id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport", + "properties": { + "jobEndTrigger": { + "$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger", + "description": "Optional. If set, report will be sent when a scan job ends." + }, + "jobFailureTrigger": { + "$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger", + "description": "Optional. If set, report will be sent when a scan job fails." + }, + "recipients": { + "$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients", + "description": "Required. The recipients who will receive the notification report." + }, + "scoreThresholdTrigger": { + "$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger", + "description": "Optional. If set, report will be sent when score threshold is met." + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients": { + "description": "The individuals or groups who are designated to receive notifications upon triggers.", + "id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients", + "properties": { + "emails": { + "description": "Optional. The email recipients who will receive the DataQualityScan results report.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger": { + "description": "This trigger is triggered when the DQ score in the job result is less than a specified input score.", + "id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger", + "properties": { + "scoreThreshold": { + "description": "Optional. The score range is in 0,100.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1DataScan": { "description": "Represents a user-visible job which provides the insights for the related data source.For example: Data Quality: generates queries based on the rules and runs against the data to get data quality check results. Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).", "id": "GoogleCloudDataplexV1DataScan", diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index 9527e4a9e81..94a9adb5cc1 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -1308,6 +1308,10 @@ export namespace dataplex_v1 { * Optional. If set, results will be exported to the provided BigQuery table. */ bigqueryExport?: Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport; + /** + * Optional. If set, results will be sent to the provided notification receipts upon triggers. + */ + notificationReport?: Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport; } /** * The configuration of BigQuery export post scan action. @@ -1318,6 +1322,53 @@ export namespace dataplex_v1 { */ resultsTable?: string | null; } + /** + * This trigger is triggered whenever a scan job run ends, regardless of the result. + */ + export interface Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger {} + /** + * This trigger is triggered when the scan job itself fails, regardless of the result. + */ + export interface Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger {} + /** + * The configuration of notification report post scan action. + */ + export interface Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport { + /** + * Optional. If set, report will be sent when a scan job ends. + */ + jobEndTrigger?: Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger; + /** + * Optional. If set, report will be sent when a scan job fails. + */ + jobFailureTrigger?: Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger; + /** + * Required. The recipients who will receive the notification report. + */ + recipients?: Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients; + /** + * Optional. If set, report will be sent when score threshold is met. + */ + scoreThresholdTrigger?: Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger; + } + /** + * The individuals or groups who are designated to receive notifications upon triggers. + */ + export interface Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients { + /** + * Optional. The email recipients who will receive the DataQualityScan results report. + */ + emails?: string[] | null; + } + /** + * This trigger is triggered when the DQ score in the job result is less than a specified input score. + */ + export interface Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger { + /** + * Optional. The score range is in 0,100. + */ + scoreThreshold?: number | null; + } /** * Represents a user-visible job which provides the insights for the related data source.For example: Data Quality: generates queries based on the rules and runs against the data to get data quality check results. Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). */ From 28a4af46a4efb429294c194fe94eb3cf0f0b41eb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:50 +0000 Subject: [PATCH 33/78] feat(dataportability): update the API #### dataportability:v1beta The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.chrome.autofill.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.chrome.bookmarks.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.chrome.dictionary.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.chrome.extensions.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.chrome.history.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.chrome.reading_list.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.chrome.settings.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.saved.collections.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.youtube.playable.description - auth.oauth2.scopes.https://www.googleapis.com/auth/dataportability.youtube.posts.description The following keys were changed: - resources.archiveJobs.methods.getPortabilityArchiveState.scopes - resources.archiveJobs.methods.retry.scopes - resources.authorization.methods.reset.scopes - resources.portabilityArchive.methods.initiate.scopes --- discovery/dataportability-v1.json | 553 +++++++++++++++++++++++ discovery/dataportability-v1beta.json | 72 ++- src/apis/dataportability/index.ts | 21 +- src/apis/dataportability/v1.ts | 615 ++++++++++++++++++++++++++ 4 files changed, 1258 insertions(+), 3 deletions(-) create mode 100644 discovery/dataportability-v1.json create mode 100644 src/apis/dataportability/v1.ts diff --git a/discovery/dataportability-v1.json b/discovery/dataportability-v1.json new file mode 100644 index 00000000000..a8f4490ff9d --- /dev/null +++ b/discovery/dataportability-v1.json @@ -0,0 +1,553 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": { + "description": "Move a copy of messages between you and the businesses you have conversations with across Google services." + }, + "https://www.googleapis.com/auth/dataportability.chrome.autofill": { + "description": "Move a copy of the information you entered into online forms in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks": { + "description": "Move a copy of pages you bookmarked in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.chrome.dictionary": { + "description": "Move a copy of words you added to Chrome's dictionary." + }, + "https://www.googleapis.com/auth/dataportability.chrome.extensions": { + "description": "Move a copy of extensions you installed from the Chrome Web Store." + }, + "https://www.googleapis.com/auth/dataportability.chrome.history": { + "description": "Move a copy of sites you visited in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.chrome.reading_list": { + "description": "Move a copy of pages you added to your reading list in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.chrome.settings": { + "description": "Move a copy of your settings in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.maps.commute_routes": { + "description": "Move a copy of your pinned trips on Maps." + }, + "https://www.googleapis.com/auth/dataportability.maps.commute_settings": { + "description": "Move a copy of your commute settings on Maps." + }, + "https://www.googleapis.com/auth/dataportability.maps.ev_profile": { + "description": "Move a copy of your electric vehicle profile on Maps." + }, + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions": { + "description": "Move a copy of your updates to places on Maps." + }, + "https://www.googleapis.com/auth/dataportability.maps.photos_videos": { + "description": "Move a copy of the photos and videos you posted on Maps." + }, + "https://www.googleapis.com/auth/dataportability.maps.reviews": { + "description": "Move a copy of your reviews and posts on Maps." + }, + "https://www.googleapis.com/auth/dataportability.maps.starred_places": { + "description": "Move a copy of your Starred places list on Maps." + }, + "https://www.googleapis.com/auth/dataportability.myactivity.maps": { + "description": "Move a copy of your Maps activity." + }, + "https://www.googleapis.com/auth/dataportability.myactivity.search": { + "description": "Move a copy of your Google Search activity." + }, + "https://www.googleapis.com/auth/dataportability.myactivity.shopping": { + "description": "Move a copy of your Shopping activity." + }, + "https://www.googleapis.com/auth/dataportability.myactivity.youtube": { + "description": "Move a copy of your YouTube activity." + }, + "https://www.googleapis.com/auth/dataportability.saved.collections": { + "description": "Move a copy of your saved links, images, places, and collections from your use of Google services." + }, + "https://www.googleapis.com/auth/dataportability.shopping.addresses": { + "description": "Move a copy of your shipping information on Shopping." + }, + "https://www.googleapis.com/auth/dataportability.shopping.reviews": { + "description": "Move a copy of reviews you wrote about products or online stores on Google Search." + }, + "https://www.googleapis.com/auth/dataportability.youtube.channel": { + "description": "Move a copy of information about your YouTube channel." + }, + "https://www.googleapis.com/auth/dataportability.youtube.comments": { + "description": "Move a copy of your YouTube comments." + }, + "https://www.googleapis.com/auth/dataportability.youtube.live_chat": { + "description": "Move a copy of your YouTube messages in live chat." + }, + "https://www.googleapis.com/auth/dataportability.youtube.music": { + "description": "Move a copy of your uploaded YouTube music tracks and your YouTube music library." + }, + "https://www.googleapis.com/auth/dataportability.youtube.playable": { + "description": "Move a copy of your YouTube playables saved game progress files." + }, + "https://www.googleapis.com/auth/dataportability.youtube.posts": { + "description": "Move a copy of your YouTube posts." + }, + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists": { + "description": "Move a copy of your YouTube private playlists." + }, + "https://www.googleapis.com/auth/dataportability.youtube.private_videos": { + "description": "Move a copy of your private YouTube videos and information about them." + }, + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists": { + "description": "Move a copy of your public YouTube playlists." + }, + "https://www.googleapis.com/auth/dataportability.youtube.public_videos": { + "description": "Move a copy of your public YouTube videos and information about them." + }, + "https://www.googleapis.com/auth/dataportability.youtube.shopping": { + "description": "Move a copy of your YouTube shopping wishlists, and wishlist items." + }, + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions": { + "description": "Move a copy of your YouTube channel subscriptions, even if they're private." + }, + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists": { + "description": "Move a copy of your unlisted YouTube playlists." + }, + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos": { + "description": "Move a copy of your unlisted YouTube videos and information about them." + } + } + } + }, + "basePath": "", + "baseUrl": "https://dataportability.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Data Portability", + "description": "The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/data-portability", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "dataportability:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://dataportability.mtls.googleapis.com/", + "name": "dataportability", + "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": { + "archiveJobs": { + "methods": { + "getPortabilityArchiveState": { + "description": "Retrieves the state of an Archive job for the Portability API.", + "flatPath": "v1/archiveJobs/{archiveJobsId}/portabilityArchiveState", + "httpMethod": "GET", + "id": "dataportability.archiveJobs.getPortabilityArchiveState", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse.", + "location": "path", + "pattern": "^archiveJobs/[^/]+/portabilityArchiveState$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "PortabilityArchiveState" + }, + "scopes": [ + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.maps.commute_routes", + "https://www.googleapis.com/auth/dataportability.maps.commute_settings", + "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", + "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.reviews", + "https://www.googleapis.com/auth/dataportability.maps.starred_places", + "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.search", + "https://www.googleapis.com/auth/dataportability.myactivity.shopping", + "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.shopping.addresses", + "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.youtube.channel", + "https://www.googleapis.com/auth/dataportability.youtube.comments", + "https://www.googleapis.com/auth/dataportability.youtube.live_chat", + "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.private_videos", + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.public_videos", + "https://www.googleapis.com/auth/dataportability.youtube.shopping", + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos" + ] + }, + "retry": { + "description": "Retries a failed Portability Archive job.", + "flatPath": "v1/archiveJobs/{archiveJobsId}:retry", + "httpMethod": "POST", + "id": "dataportability.archiveJobs.retry", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed.", + "location": "path", + "pattern": "^archiveJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:retry", + "request": { + "$ref": "RetryPortabilityArchiveRequest" + }, + "response": { + "$ref": "RetryPortabilityArchiveResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.maps.commute_routes", + "https://www.googleapis.com/auth/dataportability.maps.commute_settings", + "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", + "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.reviews", + "https://www.googleapis.com/auth/dataportability.maps.starred_places", + "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.search", + "https://www.googleapis.com/auth/dataportability.myactivity.shopping", + "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.shopping.addresses", + "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.youtube.channel", + "https://www.googleapis.com/auth/dataportability.youtube.comments", + "https://www.googleapis.com/auth/dataportability.youtube.live_chat", + "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.private_videos", + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.public_videos", + "https://www.googleapis.com/auth/dataportability.youtube.shopping", + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos" + ] + } + } + }, + "authorization": { + "methods": { + "reset": { + "description": "Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job.", + "flatPath": "v1/authorization:reset", + "httpMethod": "POST", + "id": "dataportability.authorization.reset", + "parameterOrder": [], + "parameters": {}, + "path": "v1/authorization:reset", + "request": { + "$ref": "ResetAuthorizationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.maps.commute_routes", + "https://www.googleapis.com/auth/dataportability.maps.commute_settings", + "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", + "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.reviews", + "https://www.googleapis.com/auth/dataportability.maps.starred_places", + "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.search", + "https://www.googleapis.com/auth/dataportability.myactivity.shopping", + "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.shopping.addresses", + "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.youtube.channel", + "https://www.googleapis.com/auth/dataportability.youtube.comments", + "https://www.googleapis.com/auth/dataportability.youtube.live_chat", + "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.private_videos", + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.public_videos", + "https://www.googleapis.com/auth/dataportability.youtube.shopping", + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos" + ] + } + } + }, + "portabilityArchive": { + "methods": { + "initiate": { + "description": "Initiates a new Archive job for the Portability API.", + "flatPath": "v1/portabilityArchive:initiate", + "httpMethod": "POST", + "id": "dataportability.portabilityArchive.initiate", + "parameterOrder": [], + "parameters": {}, + "path": "v1/portabilityArchive:initiate", + "request": { + "$ref": "InitiatePortabilityArchiveRequest" + }, + "response": { + "$ref": "InitiatePortabilityArchiveResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.maps.commute_routes", + "https://www.googleapis.com/auth/dataportability.maps.commute_settings", + "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", + "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.reviews", + "https://www.googleapis.com/auth/dataportability.maps.starred_places", + "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.search", + "https://www.googleapis.com/auth/dataportability.myactivity.shopping", + "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.shopping.addresses", + "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.youtube.channel", + "https://www.googleapis.com/auth/dataportability.youtube.comments", + "https://www.googleapis.com/auth/dataportability.youtube.live_chat", + "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.private_videos", + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.public_videos", + "https://www.googleapis.com/auth/dataportability.youtube.shopping", + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos" + ] + } + } + } + }, + "revision": "20240312", + "rootUrl": "https://dataportability.googleapis.com/", + "schemas": { + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "InitiatePortabilityArchiveRequest": { + "description": "Request to kick off an Archive job.", + "id": "InitiatePortabilityArchiveRequest", + "properties": { + "resources": { + "description": "The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InitiatePortabilityArchiveResponse": { + "description": "Response from initiating an Archive job.", + "id": "InitiatePortabilityArchiveResponse", + "properties": { + "archiveJobId": { + "description": "The archive job ID that is initiated in the API. This can be used to get the state of the job.", + "type": "string" + } + }, + "type": "object" + }, + "PortabilityArchiveState": { + "description": "Resource that contains the state of an Archive job.", + "id": "PortabilityArchiveState", + "properties": { + "name": { + "description": "The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request.", + "type": "string" + }, + "state": { + "description": "Resource that represents the state of the Archive job.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "COMPLETE", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The job is in progress.", + "The job is complete.", + "The job failed.", + "The job is cancelled." + ], + "type": "string" + }, + "urls": { + "description": "If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResetAuthorizationRequest": { + "description": "Request to reset exhausted OAuth scopes.", + "id": "ResetAuthorizationRequest", + "properties": {}, + "type": "object" + }, + "RetryPortabilityArchiveRequest": { + "description": "Request to retry a failed Portability Archive job.", + "id": "RetryPortabilityArchiveRequest", + "properties": {}, + "type": "object" + }, + "RetryPortabilityArchiveResponse": { + "description": "Response from retrying a Portability Archive.", + "id": "RetryPortabilityArchiveResponse", + "properties": { + "archiveJobId": { + "description": "The archive job ID that is initiated by the retry endpoint. This can be used to get the state of the new job.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Data Portability API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/dataportability-v1beta.json b/discovery/dataportability-v1beta.json index ce67c8aade5..8f0b2648f62 100644 --- a/discovery/dataportability-v1beta.json +++ b/discovery/dataportability-v1beta.json @@ -5,6 +5,27 @@ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": { "description": "Move a copy of messages between you and the businesses you have conversations with across Google services." }, + "https://www.googleapis.com/auth/dataportability.chrome.autofill": { + "description": "Move a copy of the information you entered into online forms in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks": { + "description": "Move a copy of pages you bookmarked in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.chrome.dictionary": { + "description": "Move a copy of words you added to Chrome's dictionary." + }, + "https://www.googleapis.com/auth/dataportability.chrome.extensions": { + "description": "Move a copy of extensions you installed from the Chrome Web Store." + }, + "https://www.googleapis.com/auth/dataportability.chrome.history": { + "description": "Move a copy of sites you visited in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.chrome.reading_list": { + "description": "Move a copy of pages you added to your reading list in Chrome." + }, + "https://www.googleapis.com/auth/dataportability.chrome.settings": { + "description": "Move a copy of your settings in Chrome." + }, "https://www.googleapis.com/auth/dataportability.maps.commute_routes": { "description": "Move a copy of your pinned trips on Maps." }, @@ -38,6 +59,9 @@ "https://www.googleapis.com/auth/dataportability.myactivity.youtube": { "description": "Move a copy of your YouTube activity." }, + "https://www.googleapis.com/auth/dataportability.saved.collections": { + "description": "Move a copy of your saved links, images, places, and collections from your use of Google services." + }, "https://www.googleapis.com/auth/dataportability.shopping.addresses": { "description": "Move a copy of your shipping information on Shopping." }, @@ -56,6 +80,12 @@ "https://www.googleapis.com/auth/dataportability.youtube.music": { "description": "Move a copy of your uploaded YouTube music tracks and your YouTube music library." }, + "https://www.googleapis.com/auth/dataportability.youtube.playable": { + "description": "Move a copy of your YouTube playables saved game progress files." + }, + "https://www.googleapis.com/auth/dataportability.youtube.posts": { + "description": "Move a copy of your YouTube posts." + }, "https://www.googleapis.com/auth/dataportability.youtube.private_playlists": { "description": "Move a copy of your YouTube private playlists." }, @@ -205,6 +235,13 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", @@ -216,12 +253,15 @@ "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.saved.collections", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", "https://www.googleapis.com/auth/dataportability.youtube.private_videos", "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", @@ -258,6 +298,13 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", @@ -269,12 +316,15 @@ "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.saved.collections", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", "https://www.googleapis.com/auth/dataportability.youtube.private_videos", "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", @@ -305,6 +355,13 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", @@ -316,12 +373,15 @@ "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.saved.collections", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", "https://www.googleapis.com/auth/dataportability.youtube.private_videos", "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", @@ -352,6 +412,13 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", @@ -363,12 +430,15 @@ "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.saved.collections", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", "https://www.googleapis.com/auth/dataportability.youtube.private_videos", "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", @@ -382,7 +452,7 @@ } } }, - "revision": "20240221", + "revision": "20240312", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/src/apis/dataportability/index.ts b/src/apis/dataportability/index.ts index c3eafdd1a25..c27bbcd4334 100644 --- a/src/apis/dataportability/index.ts +++ b/src/apis/dataportability/index.ts @@ -14,27 +14,44 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {dataportability_v1} from './v1'; import {dataportability_v1beta} from './v1beta'; export const VERSIONS = { + v1: dataportability_v1.Dataportability, v1beta: dataportability_v1beta.Dataportability, }; +export function dataportability( + version: 'v1' +): dataportability_v1.Dataportability; +export function dataportability( + options: dataportability_v1.Options +): dataportability_v1.Dataportability; export function dataportability( version: 'v1beta' ): dataportability_v1beta.Dataportability; export function dataportability( options: dataportability_v1beta.Options ): dataportability_v1beta.Dataportability; -export function dataportability( +export function dataportability< + T = + | dataportability_v1.Dataportability + | dataportability_v1beta.Dataportability, +>( this: GoogleConfigurable, - versionOrOptions: 'v1beta' | dataportability_v1beta.Options + versionOrOptions: + | 'v1' + | dataportability_v1.Options + | 'v1beta' + | dataportability_v1beta.Options ) { return getAPI('dataportability', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); export {auth}; +export {dataportability_v1}; export {dataportability_v1beta}; export { AuthPlus, diff --git a/src/apis/dataportability/v1.ts b/src/apis/dataportability/v1.ts new file mode 100644 index 00000000000..e4723d79da7 --- /dev/null +++ b/src/apis/dataportability/v1.ts @@ -0,0 +1,615 @@ +// 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/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, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace dataportability_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * 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; + } + + /** + * Data Portability API + * + * The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const dataportability = google.dataportability('v1'); + * ``` + */ + export class Dataportability { + context: APIRequestContext; + archiveJobs: Resource$Archivejobs; + authorization: Resource$Authorization; + portabilityArchive: Resource$Portabilityarchive; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.archiveJobs = new Resource$Archivejobs(this.context); + this.authorization = new Resource$Authorization(this.context); + this.portabilityArchive = new Resource$Portabilityarchive(this.context); + } + } + + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * Request to kick off an Archive job. + */ + export interface Schema$InitiatePortabilityArchiveRequest { + /** + * The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes. + */ + resources?: string[] | null; + } + /** + * Response from initiating an Archive job. + */ + export interface Schema$InitiatePortabilityArchiveResponse { + /** + * The archive job ID that is initiated in the API. This can be used to get the state of the job. + */ + archiveJobId?: string | null; + } + /** + * Resource that contains the state of an Archive job. + */ + export interface Schema$PortabilityArchiveState { + /** + * The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job\}/portabilityArchiveState. archive_job is the job ID provided in the request. + */ + name?: string | null; + /** + * Resource that represents the state of the Archive job. + */ + state?: string | null; + /** + * If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket. + */ + urls?: string[] | null; + } + /** + * Request to reset exhausted OAuth scopes. + */ + export interface Schema$ResetAuthorizationRequest {} + /** + * Request to retry a failed Portability Archive job. + */ + export interface Schema$RetryPortabilityArchiveRequest {} + /** + * Response from retrying a Portability Archive. + */ + export interface Schema$RetryPortabilityArchiveResponse { + /** + * The archive job ID that is initiated by the retry endpoint. This can be used to get the state of the new job. + */ + archiveJobId?: string | null; + } + + export class Resource$Archivejobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the state of an Archive job for the Portability API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getPortabilityArchiveState( + params: Params$Resource$Archivejobs$Getportabilityarchivestate, + options: StreamMethodOptions + ): GaxiosPromise; + getPortabilityArchiveState( + params?: Params$Resource$Archivejobs$Getportabilityarchivestate, + options?: MethodOptions + ): GaxiosPromise; + getPortabilityArchiveState( + params: Params$Resource$Archivejobs$Getportabilityarchivestate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPortabilityArchiveState( + params: Params$Resource$Archivejobs$Getportabilityarchivestate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPortabilityArchiveState( + params: Params$Resource$Archivejobs$Getportabilityarchivestate, + callback: BodyResponseCallback + ): void; + getPortabilityArchiveState( + callback: BodyResponseCallback + ): void; + getPortabilityArchiveState( + paramsOrCallback?: + | Params$Resource$Archivejobs$Getportabilityarchivestate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Archivejobs$Getportabilityarchivestate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Archivejobs$Getportabilityarchivestate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://dataportability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retries a failed Portability Archive job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + retry( + params: Params$Resource$Archivejobs$Retry, + options: StreamMethodOptions + ): GaxiosPromise; + retry( + params?: Params$Resource$Archivejobs$Retry, + options?: MethodOptions + ): GaxiosPromise; + retry( + params: Params$Resource$Archivejobs$Retry, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + retry( + params: Params$Resource$Archivejobs$Retry, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + retry( + params: Params$Resource$Archivejobs$Retry, + callback: BodyResponseCallback + ): void; + retry( + callback: BodyResponseCallback + ): void; + retry( + paramsOrCallback?: + | Params$Resource$Archivejobs$Retry + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Archivejobs$Retry; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Archivejobs$Retry; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://dataportability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:retry').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Archivejobs$Getportabilityarchivestate + extends StandardParameters { + /** + * Required. The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job\}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse. + */ + name?: string; + } + export interface Params$Resource$Archivejobs$Retry + extends StandardParameters { + /** + * Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RetryPortabilityArchiveRequest; + } + + export class Resource$Authorization { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reset( + params: Params$Resource$Authorization$Reset, + options: StreamMethodOptions + ): GaxiosPromise; + reset( + params?: Params$Resource$Authorization$Reset, + options?: MethodOptions + ): GaxiosPromise; + reset( + params: Params$Resource$Authorization$Reset, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reset( + params: Params$Resource$Authorization$Reset, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reset( + params: Params$Resource$Authorization$Reset, + callback: BodyResponseCallback + ): void; + reset(callback: BodyResponseCallback): void; + reset( + paramsOrCallback?: + | Params$Resource$Authorization$Reset + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Authorization$Reset; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Authorization$Reset; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://dataportability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/authorization:reset').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Authorization$Reset + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$ResetAuthorizationRequest; + } + + export class Resource$Portabilityarchive { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Initiates a new Archive job for the Portability API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initiate( + params: Params$Resource$Portabilityarchive$Initiate, + options: StreamMethodOptions + ): GaxiosPromise; + initiate( + params?: Params$Resource$Portabilityarchive$Initiate, + options?: MethodOptions + ): GaxiosPromise; + initiate( + params: Params$Resource$Portabilityarchive$Initiate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initiate( + params: Params$Resource$Portabilityarchive$Initiate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initiate( + params: Params$Resource$Portabilityarchive$Initiate, + callback: BodyResponseCallback + ): void; + initiate( + callback: BodyResponseCallback + ): void; + initiate( + paramsOrCallback?: + | Params$Resource$Portabilityarchive$Initiate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Portabilityarchive$Initiate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Portabilityarchive$Initiate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://dataportability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/portabilityArchive:initiate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Portabilityarchive$Initiate + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$InitiatePortabilityArchiveRequest; + } +} From 25dc88ca8649b1ea39d7d5a82353ad157d0530a7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:50 +0000 Subject: [PATCH 34/78] fix(dataproc): update the API #### dataproc:v1 The following keys were changed: - endpoints - resources.projects.resources.locations.resources.batches.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.sessions.methods.list.parameters.filter.description - schemas.GceClusterConfig.properties.internalIpOnly.description --- discovery/dataproc-v1.json | 18 ++++++++++++++---- src/apis/dataproc/v1.ts | 6 +++--- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/discovery/dataproc-v1.json b/discovery/dataproc-v1.json index 450319f0a0e..de304c9d226 100644 --- a/discovery/dataproc-v1.json +++ b/discovery/dataproc-v1.json @@ -20,6 +20,16 @@ "endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dataproc.europe-west3.rep.googleapis.com/", + "location": "europe-west3", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dataproc.europe-west9.rep.googleapis.com/", + "location": "europe-west9", + "description": "Regional Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -446,7 +456,7 @@ ], "parameters": { "filter": { - "description": "Optional. A filter for the batches to return in the response.A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, and create_time.e.g. state = RUNNING and create_time < \"2023-01-01T00:00:00Z\" filters for batches in state RUNNING that were created before 2023-01-01See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.", + "description": "Optional. A filter for the batches to return in the response.A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, create_time, and labels.e.g. state = RUNNING and create_time < \"2023-01-01T00:00:00Z\" filters for batches in state RUNNING that were created before 2023-01-01. state = RUNNING and labels.environment=production filters for batches in state in a RUNNING state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.", "location": "query", "type": "string" }, @@ -860,7 +870,7 @@ ], "parameters": { "filter": { - "description": "Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, and create_time.Example: state = ACTIVE and create_time < \"2023-01-01T00:00:00Z\" is a filter for sessions in an ACTIVE state that were created before 2023-01-01.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators.", + "description": "Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.Example: state = ACTIVE and create_time < \"2023-01-01T00:00:00Z\" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators.", "location": "query", "type": "string" }, @@ -3034,7 +3044,7 @@ } } }, - "revision": "20240209", + "revision": "20240309", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -4110,7 +4120,7 @@ "description": "Optional. Confidential Instance Config for clusters using Confidential VMs (https://cloud.google.com/compute/confidential-vm/docs)." }, "internalIpOnly": { - "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.", + "description": "Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.When set to true: All cluster VMs have internal IP addresses. Google Private Access (https://cloud.google.com/vpc/docs/private-google-access) must be enabled to access Dataproc and other Google Cloud APIs. Off-cluster dependencies must be configured to be accessible without external IP addresses.When set to false: Cluster VMs are not restricted to internal IP addresses. Ephemeral external IP addresses are assigned to each cluster VM.", "type": "boolean" }, "metadata": { diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 25d4831735a..f845d41348d 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -885,7 +885,7 @@ export namespace dataproc_v1 { */ confidentialInstanceConfig?: Schema$ConfidentialInstanceConfig; /** - * Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses. + * Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.When set to true: All cluster VMs have internal IP addresses. Google Private Access (https://cloud.google.com/vpc/docs/private-google-access) must be enabled to access Dataproc and other Google Cloud APIs. Off-cluster dependencies must be configured to be accessible without external IP addresses.When set to false: Cluster VMs are not restricted to internal IP addresses. Ephemeral external IP addresses are assigned to each cluster VM. */ internalIpOnly?: boolean | null; /** @@ -4429,7 +4429,7 @@ export namespace dataproc_v1 { export interface Params$Resource$Projects$Locations$Batches$List extends StandardParameters { /** - * Optional. A filter for the batches to return in the response.A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, and create_time.e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-01-01See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons. + * Optional. A filter for the batches to return in the response.A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, create_time, and labels.e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-01-01. state = RUNNING and labels.environment=production filters for batches in state in a RUNNING state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons. */ filter?: string; /** @@ -5321,7 +5321,7 @@ export namespace dataproc_v1 { export interface Params$Resource$Projects$Locations$Sessions$List extends StandardParameters { /** - * Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, and create_time.Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were created before 2023-01-01.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators. + * Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators. */ filter?: string; /** From 3d7fb8880f43bec8318c14544fcbe09b06a45cf7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:50 +0000 Subject: [PATCH 35/78] feat(dialogflow): update the API #### dialogflow:v2beta1 The following keys were added: - schemas.GoogleCloudDialogflowCxV3AdvancedSettings.properties.speechSettings.$ref - schemas.GoogleCloudDialogflowCxV3AdvancedSettings.properties.speechSettings.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.id - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.format - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.format - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.oauthConfig.$ref - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.oauthConfig.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.enum - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.enumDescriptions - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.id - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientId.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientId.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.items.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettings.properties.speechSettings.$ref - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettings.properties.speechSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.id - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.format - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.format - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.oauthConfig.$ref - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.oauthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.enum - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.id - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientId.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientId.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.items.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.type #### dialogflow:v3beta1 The following keys were added: - schemas.GoogleCloudDialogflowCxV3AdvancedSettings.properties.speechSettings.$ref - schemas.GoogleCloudDialogflowCxV3AdvancedSettings.properties.speechSettings.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.id - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.format - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.format - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.oauthConfig.$ref - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.oauthConfig.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.enum - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.enumDescriptions - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.id - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientId.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientId.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.items.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettings.properties.speechSettings.$ref - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettings.properties.speechSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.id - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.format - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.format - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.type - schemas.GoogleCloudDialogflowCxV3beta1Agent.properties.personalizationSettings.$ref - schemas.GoogleCloudDialogflowCxV3beta1Agent.properties.personalizationSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings.id - schemas.GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings.properties.defaultEndUserMetadata.additionalProperties.description - schemas.GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings.properties.defaultEndUserMetadata.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings.properties.defaultEndUserMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings.properties.defaultEndUserMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.id - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.answer.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.answer.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.answerGenerationModelCallSignals.$ref - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.answerGenerationModelCallSignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.answerParts.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.answerParts.items.$ref - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.answerParts.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.citedSnippets.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.citedSnippets.items.$ref - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.citedSnippets.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.groundingSignals.$ref - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.groundingSignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.rewriterModelCallSignals.$ref - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.rewriterModelCallSignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.rewrittenQuery.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.rewrittenQuery.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.safetySignals.$ref - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.safetySignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.searchSnippets.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.searchSnippets.items.$ref - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.properties.searchSnippets.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals.id - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals.properties.modelOutput.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals.properties.modelOutput.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals.properties.renderedPrompt.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals.properties.renderedPrompt.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.id - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.properties.supportingIndices.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.properties.supportingIndices.items.format - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.properties.supportingIndices.items.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.properties.supportingIndices.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.properties.text.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.properties.text.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet.id - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet.properties.searchSnippet.$ref - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet.properties.searchSnippet.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet.properties.snippetIndex.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet.properties.snippetIndex.format - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet.properties.snippetIndex.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.id - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.properties.decision.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.properties.decision.enum - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.properties.decision.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.properties.decision.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.properties.score.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.properties.score.enum - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.properties.score.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.properties.score.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals.id - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals.properties.modelOutput.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals.properties.modelOutput.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals.properties.renderedPrompt.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals.properties.renderedPrompt.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.id - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.bannedPhraseMatch.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.bannedPhraseMatch.enum - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.bannedPhraseMatch.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.bannedPhraseMatch.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.decision.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.decision.enum - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.decision.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.decision.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.matchedBannedPhrase.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.properties.matchedBannedPhrase.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.id - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.properties.documentTitle.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.properties.documentTitle.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.properties.documentUri.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.properties.documentUri.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.properties.text.description - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.properties.text.type - schemas.GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet.type - schemas.GoogleCloudDialogflowCxV3beta1QueryParameters.properties.populateDataStoreConnectionSignals.description - schemas.GoogleCloudDialogflowCxV3beta1QueryParameters.properties.populateDataStoreConnectionSignals.type - schemas.GoogleCloudDialogflowCxV3beta1QueryResult.properties.dataStoreConnectionSignals.$ref - schemas.GoogleCloudDialogflowCxV3beta1QueryResult.properties.dataStoreConnectionSignals.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.oauthConfig.$ref - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.oauthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.enum - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.id - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientId.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientId.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.items.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.type The following keys were changed: - schemas.GoogleCloudDialogflowCxV3beta1SecuritySettings.properties.retentionWindowDays.description - schemas.GoogleCloudDialogflowCxV3beta1SecuritySettingsAudioExportSettings.properties.enableAudioRedaction.description #### dialogflow:v2 The following keys were added: - schemas.GoogleCloudDialogflowCxV3AdvancedSettings.properties.speechSettings.$ref - schemas.GoogleCloudDialogflowCxV3AdvancedSettings.properties.speechSettings.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.id - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.format - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.format - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.oauthConfig.$ref - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.oauthConfig.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.enum - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.enumDescriptions - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.id - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientId.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientId.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.items.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettings.properties.speechSettings.$ref - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettings.properties.speechSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.id - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.format - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.format - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.oauthConfig.$ref - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.oauthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.enum - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.id - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientId.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientId.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.items.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.type #### dialogflow:v3 The following keys were added: - schemas.GoogleCloudDialogflowCxV3AdvancedSettings.properties.speechSettings.$ref - schemas.GoogleCloudDialogflowCxV3AdvancedSettings.properties.speechSettings.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.id - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.format - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.models.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.format - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.type - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.type - schemas.GoogleCloudDialogflowCxV3Agent.properties.personalizationSettings.$ref - schemas.GoogleCloudDialogflowCxV3Agent.properties.personalizationSettings.description - schemas.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.description - schemas.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.id - schemas.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.properties.defaultEndUserMetadata.additionalProperties.description - schemas.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.properties.defaultEndUserMetadata.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.properties.defaultEndUserMetadata.description - schemas.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.properties.defaultEndUserMetadata.type - schemas.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.id - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.answer.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.answer.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.answerGenerationModelCallSignals.$ref - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.answerGenerationModelCallSignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.answerParts.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.answerParts.items.$ref - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.answerParts.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.citedSnippets.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.citedSnippets.items.$ref - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.citedSnippets.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.groundingSignals.$ref - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.groundingSignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.rewriterModelCallSignals.$ref - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.rewriterModelCallSignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.rewrittenQuery.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.rewrittenQuery.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.safetySignals.$ref - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.safetySignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.searchSnippets.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.searchSnippets.items.$ref - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.properties.searchSnippets.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignals.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals.id - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals.properties.modelOutput.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals.properties.modelOutput.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals.properties.renderedPrompt.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals.properties.renderedPrompt.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.id - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.properties.supportingIndices.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.properties.supportingIndices.items.format - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.properties.supportingIndices.items.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.properties.supportingIndices.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.properties.text.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.properties.text.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet.id - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet.properties.searchSnippet.$ref - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet.properties.searchSnippet.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet.properties.snippetIndex.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet.properties.snippetIndex.format - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet.properties.snippetIndex.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.id - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.properties.decision.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.properties.decision.enum - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.properties.decision.enumDescriptions - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.properties.decision.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.properties.score.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.properties.score.enum - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.properties.score.enumDescriptions - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.properties.score.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals.id - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals.properties.modelOutput.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals.properties.modelOutput.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals.properties.renderedPrompt.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals.properties.renderedPrompt.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.id - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.bannedPhraseMatch.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.bannedPhraseMatch.enum - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.bannedPhraseMatch.enumDescriptions - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.bannedPhraseMatch.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.decision.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.decision.enum - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.decision.enumDescriptions - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.decision.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.matchedBannedPhrase.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.properties.matchedBannedPhrase.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.id - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.properties.documentTitle.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.properties.documentTitle.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.properties.documentUri.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.properties.documentUri.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.properties.text.description - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.properties.text.type - schemas.GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet.type - schemas.GoogleCloudDialogflowCxV3QueryParameters.properties.populateDataStoreConnectionSignals.description - schemas.GoogleCloudDialogflowCxV3QueryParameters.properties.populateDataStoreConnectionSignals.type - schemas.GoogleCloudDialogflowCxV3QueryResult.properties.dataStoreConnectionSignals.$ref - schemas.GoogleCloudDialogflowCxV3QueryResult.properties.dataStoreConnectionSignals.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.oauthConfig.$ref - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.oauthConfig.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.enum - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.enumDescriptions - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAgentAuth.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.id - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientId.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientId.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.items.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.scopes.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.type - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettings.properties.speechSettings.$ref - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettings.properties.speechSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.id - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.format - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.endpointerSensitivity.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.additionalProperties.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.models.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.format - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.noSpeechTimeout.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.type - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.oauthConfig.$ref - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.oauthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.enum - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAgentAuth.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.id - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientId.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientId.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.items.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.scopes.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.tokenEndpoint.type - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.type The following keys were changed: - schemas.GoogleCloudDialogflowCxV3SecuritySettings.properties.retentionWindowDays.description - schemas.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings.properties.enableAudioRedaction.description --- discovery/dialogflow-v2.json | 158 +++++++++++- discovery/dialogflow-v2beta1.json | 158 +++++++++++- discovery/dialogflow-v3.json | 407 +++++++++++++++++++++++++++++- discovery/dialogflow-v3beta1.json | 407 +++++++++++++++++++++++++++++- src/apis/dialogflow/v2.ts | 108 ++++++++ src/apis/dialogflow/v2beta1.ts | 108 ++++++++ src/apis/dialogflow/v3.ts | 273 +++++++++++++++++++- src/apis/dialogflow/v3beta1.ts | 273 +++++++++++++++++++- 8 files changed, 1880 insertions(+), 12 deletions(-) diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index b8131d5082f..fd2b7cffdb1 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -8327,7 +8327,7 @@ } } }, - "revision": "20240219", + "revision": "20240311", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8345,6 +8345,10 @@ "loggingSettings": { "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level." + }, + "speechSettings": { + "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", + "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level" } }, "type": "object" @@ -8384,6 +8388,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings": { + "description": "Define behaviors of speech to text detection.", + "id": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", + "properties": { + "endpointerSensitivity": { + "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "models": { + "additionalProperties": { + "type": "string" + }, + "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", + "type": "object" + }, + "noSpeechTimeout": { + "description": "Timeout before detecting no speech.", + "format": "google-duration", + "type": "string" + }, + "useTimeoutBasedEndpointing": { + "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3AudioInput": { "description": "Represents the natural speech audio to be processed.", "id": "GoogleCloudDialogflowCxV3AudioInput", @@ -10341,6 +10373,10 @@ ], "type": "string" }, + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", + "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header." + }, "parameterMapping": { "additionalProperties": { "type": "string" @@ -10364,6 +10400,22 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", + "enum": [ + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "NONE", + "ID_TOKEN", + "ACCESS_TOKEN" + ], + "enumDescriptions": [ + "Service agent auth type unspecified. Default to ID_TOKEN.", + "No token used.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." + ], + "type": "string" + }, "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" @@ -10390,6 +10442,32 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig": { + "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", + "properties": { + "clientId": { + "description": "Required. The client ID provided by the 3rd party platform.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The client secret provided by the 3rd party platform.", + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -10623,6 +10701,10 @@ "loggingSettings": { "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level." + }, + "speechSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", + "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level" } }, "type": "object" @@ -10662,6 +10744,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings": { + "description": "Define behaviors of speech to text detection.", + "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", + "properties": { + "endpointerSensitivity": { + "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "models": { + "additionalProperties": { + "type": "string" + }, + "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", + "type": "object" + }, + "noSpeechTimeout": { + "description": "Timeout before detecting no speech.", + "format": "google-duration", + "type": "string" + }, + "useTimeoutBasedEndpointing": { + "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1AudioInput": { "description": "Represents the natural speech audio to be processed.", "id": "GoogleCloudDialogflowCxV3beta1AudioInput", @@ -12603,6 +12713,10 @@ ], "type": "string" }, + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", + "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header." + }, "parameterMapping": { "additionalProperties": { "type": "string" @@ -12626,6 +12740,22 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", + "enum": [ + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "NONE", + "ID_TOKEN", + "ACCESS_TOKEN" + ], + "enumDescriptions": [ + "Service agent auth type unspecified. Default to ID_TOKEN.", + "No token used.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." + ], + "type": "string" + }, "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" @@ -12652,6 +12782,32 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig": { + "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", + "properties": { + "clientId": { + "description": "Required. The client ID provided by the 3rd party platform.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The client secret provided by the 3rd party platform.", + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index 060ee2d4781..a02854ad081 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -7695,7 +7695,7 @@ } } }, - "revision": "20240219", + "revision": "20240311", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -7713,6 +7713,10 @@ "loggingSettings": { "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level." + }, + "speechSettings": { + "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", + "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level" } }, "type": "object" @@ -7752,6 +7756,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings": { + "description": "Define behaviors of speech to text detection.", + "id": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", + "properties": { + "endpointerSensitivity": { + "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "models": { + "additionalProperties": { + "type": "string" + }, + "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", + "type": "object" + }, + "noSpeechTimeout": { + "description": "Timeout before detecting no speech.", + "format": "google-duration", + "type": "string" + }, + "useTimeoutBasedEndpointing": { + "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3AudioInput": { "description": "Represents the natural speech audio to be processed.", "id": "GoogleCloudDialogflowCxV3AudioInput", @@ -9709,6 +9741,10 @@ ], "type": "string" }, + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", + "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header." + }, "parameterMapping": { "additionalProperties": { "type": "string" @@ -9732,6 +9768,22 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", + "enum": [ + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "NONE", + "ID_TOKEN", + "ACCESS_TOKEN" + ], + "enumDescriptions": [ + "Service agent auth type unspecified. Default to ID_TOKEN.", + "No token used.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." + ], + "type": "string" + }, "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" @@ -9758,6 +9810,32 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig": { + "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", + "properties": { + "clientId": { + "description": "Required. The client ID provided by the 3rd party platform.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The client secret provided by the 3rd party platform.", + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -9991,6 +10069,10 @@ "loggingSettings": { "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level." + }, + "speechSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", + "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level" } }, "type": "object" @@ -10030,6 +10112,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings": { + "description": "Define behaviors of speech to text detection.", + "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", + "properties": { + "endpointerSensitivity": { + "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "models": { + "additionalProperties": { + "type": "string" + }, + "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", + "type": "object" + }, + "noSpeechTimeout": { + "description": "Timeout before detecting no speech.", + "format": "google-duration", + "type": "string" + }, + "useTimeoutBasedEndpointing": { + "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1AudioInput": { "description": "Represents the natural speech audio to be processed.", "id": "GoogleCloudDialogflowCxV3beta1AudioInput", @@ -11971,6 +12081,10 @@ ], "type": "string" }, + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", + "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header." + }, "parameterMapping": { "additionalProperties": { "type": "string" @@ -11994,6 +12108,22 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", + "enum": [ + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "NONE", + "ID_TOKEN", + "ACCESS_TOKEN" + ], + "enumDescriptions": [ + "Service agent auth type unspecified. Default to ID_TOKEN.", + "No token used.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." + ], + "type": "string" + }, "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" @@ -12020,6 +12150,32 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig": { + "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", + "properties": { + "clientId": { + "description": "Required. The client ID provided by the 3rd party platform.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The client secret provided by the 3rd party platform.", + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 44277489688..97bf63c8561 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -4453,7 +4453,7 @@ } } }, - "revision": "20240219", + "revision": "20240311", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4471,6 +4471,10 @@ "loggingSettings": { "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level." + }, + "speechSettings": { + "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", + "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level" } }, "type": "object" @@ -4510,6 +4514,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings": { + "description": "Define behaviors of speech to text detection.", + "id": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", + "properties": { + "endpointerSensitivity": { + "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "models": { + "additionalProperties": { + "type": "string" + }, + "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", + "type": "object" + }, + "noSpeechTimeout": { + "description": "Timeout before detecting no speech.", + "format": "google-duration", + "type": "string" + }, + "useTimeoutBasedEndpointing": { + "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3Agent": { "description": "Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.", "id": "GoogleCloudDialogflowCxV3Agent", @@ -4563,6 +4595,10 @@ "description": "The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.", "type": "string" }, + "personalizationSettings": { + "$ref": "GoogleCloudDialogflowCxV3AgentPersonalizationSettings", + "description": "Optional. Settings for end user personalization." + }, "securitySettings": { "description": "Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.", "type": "string" @@ -4656,6 +4692,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3AgentPersonalizationSettings": { + "description": "Settings for end user personalization.", + "id": "GoogleCloudDialogflowCxV3AgentPersonalizationSettings", + "properties": { + "defaultEndUserMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { \"age\": \"$session.params.age\" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3AgentValidationResult": { "description": "The response message for Agents.GetAgentValidationResult.", "id": "GoogleCloudDialogflowCxV3AgentValidationResult", @@ -5152,6 +5203,224 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3DataStoreConnectionSignals": { + "description": "Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ...", + "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignals", + "properties": { + "answer": { + "description": "Optional. The final compiled answer.", + "type": "string" + }, + "answerGenerationModelCallSignals": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals", + "description": "Optional. Diagnostic info related to the answer generation model call." + }, + "answerParts": { + "description": "Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).", + "items": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart" + }, + "type": "array" + }, + "citedSnippets": { + "description": "Optional. Snippets cited by the answer generation model from the most to least relevant.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet" + }, + "type": "array" + }, + "groundingSignals": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals", + "description": "Optional. Grounding signals." + }, + "rewriterModelCallSignals": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals", + "description": "Optional. Diagnostic info related to the rewriter model call." + }, + "rewrittenQuery": { + "description": "Optional. Rewritten string query used for search.", + "type": "string" + }, + "safetySignals": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals", + "description": "Optional. Safety check result." + }, + "searchSnippets": { + "description": "Optional. Search snippets included in the answer generation prompt.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals": { + "description": "Diagnostic info related to the answer generation model call.", + "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals", + "properties": { + "modelOutput": { + "description": "Output of the generative model.", + "type": "string" + }, + "renderedPrompt": { + "description": "Prompt as sent to the model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart": { + "description": "Answer part with citation.", + "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart", + "properties": { + "supportingIndices": { + "description": "Citations for this answer part. Indices of `search_snippets`.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "text": { + "description": "Substring of the answer.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet": { + "description": "Snippet cited by the answer generation model.", + "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet", + "properties": { + "searchSnippet": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet", + "description": "Details of the snippet." + }, + "snippetIndex": { + "description": "Index of the snippet in `search_snippets` field.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals": { + "description": "Grounding signals.", + "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals", + "properties": { + "decision": { + "description": "Represents the decision of the grounding check.", + "enum": [ + "GROUNDING_DECISION_UNSPECIFIED", + "ACCEPTED_BY_GROUNDING", + "REJECTED_BY_GROUNDING" + ], + "enumDescriptions": [ + "Decision not specified.", + "Grounding have accepted the answer.", + "Grounding have rejected the answer." + ], + "type": "string" + }, + "score": { + "description": "Grounding score bucket setting.", + "enum": [ + "GROUNDING_SCORE_BUCKET_UNSPECIFIED", + "VERY_LOW", + "LOW", + "MEDIUM", + "HIGH", + "VERY_HIGH" + ], + "enumDescriptions": [ + "Score not specified.", + "We have very low confidence that the answer is grounded.", + "We have low confidence that the answer is grounded.", + "We have medium confidence that the answer is grounded.", + "We have high confidence that the answer is grounded.", + "We have very high confidence that the answer is grounded." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals": { + "description": "Diagnostic info related to the rewriter model call.", + "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals", + "properties": { + "modelOutput": { + "description": "Output of the generative model.", + "type": "string" + }, + "renderedPrompt": { + "description": "Prompt as sent to the model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals": { + "description": "Safety check results.", + "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals", + "properties": { + "bannedPhraseMatch": { + "description": "Specifies banned phrase match subject.", + "enum": [ + "BANNED_PHRASE_MATCH_UNSPECIFIED", + "BANNED_PHRASE_MATCH_NONE", + "BANNED_PHRASE_MATCH_QUERY", + "BANNED_PHRASE_MATCH_RESPONSE" + ], + "enumDescriptions": [ + "No banned phrase check was executed.", + "All banned phrase checks led to no match.", + "A banned phrase matched the query.", + "A banned phrase matched the response." + ], + "type": "string" + }, + "decision": { + "description": "Safety decision.", + "enum": [ + "SAFETY_DECISION_UNSPECIFIED", + "ACCEPTED_BY_SAFETY_CHECK", + "REJECTED_BY_SAFETY_CHECK" + ], + "enumDescriptions": [ + "Decision not specified.", + "No manual or automatic safety check fired.", + "One ore more safety checks fired." + ], + "type": "string" + }, + "matchedBannedPhrase": { + "description": "The matched banned phrase if there was a match.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet": { + "description": "Search snippet details.", + "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet", + "properties": { + "documentTitle": { + "description": "Title of the enclosing document.", + "type": "string" + }, + "documentUri": { + "description": "Uri for the document. Present if specified for the document.", + "type": "string" + }, + "text": { + "description": "Text included in the prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": { "description": "Metadata for DeleteDocument operation.", "id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata", @@ -7920,6 +8189,10 @@ "description": "This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { \"telephony\": { \"caller_id\": \"+18558363987\" } } ```", "type": "object" }, + "populateDataStoreConnectionSignals": { + "description": "Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.", + "type": "boolean" + }, "searchConfig": { "$ref": "GoogleCloudDialogflowCxV3SearchConfig", "description": "Optional. Search configuration for UCS search queries." @@ -7966,6 +8239,10 @@ "$ref": "GoogleCloudDialogflowCxV3Page", "description": "The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`." }, + "dataStoreConnectionSignals": { + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignals", + "description": "Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request." + }, "diagnosticInfo": { "additionalProperties": { "description": "Properties of the object.", @@ -8593,7 +8870,7 @@ "type": "string" }, "retentionWindowDays": { - "description": "Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL.", + "description": "Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.", "format": "int32", "type": "integer" } @@ -8625,7 +8902,7 @@ "type": "string" }, "enableAudioRedaction": { - "description": "Enable audio redaction if it is true.", + "description": "Enable audio redaction if it is true. Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted.", "type": "boolean" }, "gcsBucket": { @@ -9547,6 +9824,10 @@ ], "type": "string" }, + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", + "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header." + }, "parameterMapping": { "additionalProperties": { "type": "string" @@ -9570,6 +9851,22 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", + "enum": [ + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "NONE", + "ID_TOKEN", + "ACCESS_TOKEN" + ], + "enumDescriptions": [ + "Service agent auth type unspecified. Default to ID_TOKEN.", + "No token used.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." + ], + "type": "string" + }, "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" @@ -9596,6 +9893,32 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig": { + "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", + "properties": { + "clientId": { + "description": "Required. The client ID provided by the 3rd party platform.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The client secret provided by the 3rd party platform.", + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -9829,6 +10152,10 @@ "loggingSettings": { "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level." + }, + "speechSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", + "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level" } }, "type": "object" @@ -9868,6 +10195,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings": { + "description": "Define behaviors of speech to text detection.", + "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", + "properties": { + "endpointerSensitivity": { + "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "models": { + "additionalProperties": { + "type": "string" + }, + "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", + "type": "object" + }, + "noSpeechTimeout": { + "description": "Timeout before detecting no speech.", + "format": "google-duration", + "type": "string" + }, + "useTimeoutBasedEndpointing": { + "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1AudioInput": { "description": "Represents the natural speech audio to be processed.", "id": "GoogleCloudDialogflowCxV3beta1AudioInput", @@ -11809,6 +12164,10 @@ ], "type": "string" }, + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", + "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header." + }, "parameterMapping": { "additionalProperties": { "type": "string" @@ -11832,6 +12191,22 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", + "enum": [ + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "NONE", + "ID_TOKEN", + "ACCESS_TOKEN" + ], + "enumDescriptions": [ + "Service agent auth type unspecified. Default to ID_TOKEN.", + "No token used.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." + ], + "type": "string" + }, "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" @@ -11858,6 +12233,32 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig": { + "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", + "properties": { + "clientId": { + "description": "Required. The client ID provided by the 3rd party platform.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The client secret provided by the 3rd party platform.", + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index 8fe226a5505..108feb4dac0 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -4453,7 +4453,7 @@ } } }, - "revision": "20240219", + "revision": "20240311", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4471,6 +4471,10 @@ "loggingSettings": { "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level." + }, + "speechSettings": { + "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", + "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level" } }, "type": "object" @@ -4510,6 +4514,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings": { + "description": "Define behaviors of speech to text detection.", + "id": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", + "properties": { + "endpointerSensitivity": { + "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "models": { + "additionalProperties": { + "type": "string" + }, + "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", + "type": "object" + }, + "noSpeechTimeout": { + "description": "Timeout before detecting no speech.", + "format": "google-duration", + "type": "string" + }, + "useTimeoutBasedEndpointing": { + "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3AudioInput": { "description": "Represents the natural speech audio to be processed.", "id": "GoogleCloudDialogflowCxV3AudioInput", @@ -6467,6 +6499,10 @@ ], "type": "string" }, + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", + "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header." + }, "parameterMapping": { "additionalProperties": { "type": "string" @@ -6490,6 +6526,22 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", + "enum": [ + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "NONE", + "ID_TOKEN", + "ACCESS_TOKEN" + ], + "enumDescriptions": [ + "Service agent auth type unspecified. Default to ID_TOKEN.", + "No token used.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." + ], + "type": "string" + }, "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" @@ -6516,6 +6568,32 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig": { + "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", + "properties": { + "clientId": { + "description": "Required. The client ID provided by the 3rd party platform.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The client secret provided by the 3rd party platform.", + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -6749,6 +6827,10 @@ "loggingSettings": { "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level." + }, + "speechSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", + "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level" } }, "type": "object" @@ -6788,6 +6870,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings": { + "description": "Define behaviors of speech to text detection.", + "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", + "properties": { + "endpointerSensitivity": { + "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "models": { + "additionalProperties": { + "type": "string" + }, + "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", + "type": "object" + }, + "noSpeechTimeout": { + "description": "Timeout before detecting no speech.", + "format": "google-duration", + "type": "string" + }, + "useTimeoutBasedEndpointing": { + "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1Agent": { "description": "Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.", "id": "GoogleCloudDialogflowCxV3beta1Agent", @@ -6841,6 +6951,10 @@ "description": "The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.", "type": "string" }, + "personalizationSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings", + "description": "Optional. Settings for end user personalization." + }, "securitySettings": { "description": "Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.", "type": "string" @@ -6934,6 +7048,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings": { + "description": "Settings for end user personalization.", + "id": "GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings", + "properties": { + "defaultEndUserMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { \"age\": \"$session.params.age\" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1AgentValidationResult": { "description": "The response message for Agents.GetAgentValidationResult.", "id": "GoogleCloudDialogflowCxV3beta1AgentValidationResult", @@ -7430,6 +7559,224 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals": { + "description": "Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ...", + "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals", + "properties": { + "answer": { + "description": "Optional. The final compiled answer.", + "type": "string" + }, + "answerGenerationModelCallSignals": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals", + "description": "Optional. Diagnostic info related to the answer generation model call." + }, + "answerParts": { + "description": "Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart" + }, + "type": "array" + }, + "citedSnippets": { + "description": "Optional. Snippets cited by the answer generation model from the most to least relevant.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet" + }, + "type": "array" + }, + "groundingSignals": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals", + "description": "Optional. Grounding signals." + }, + "rewriterModelCallSignals": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals", + "description": "Optional. Diagnostic info related to the rewriter model call." + }, + "rewrittenQuery": { + "description": "Optional. Rewritten string query used for search.", + "type": "string" + }, + "safetySignals": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals", + "description": "Optional. Safety check result." + }, + "searchSnippets": { + "description": "Optional. Search snippets included in the answer generation prompt.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals": { + "description": "Diagnostic info related to the answer generation model call.", + "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals", + "properties": { + "modelOutput": { + "description": "Output of the generative model.", + "type": "string" + }, + "renderedPrompt": { + "description": "Prompt as sent to the model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart": { + "description": "Answer part with citation.", + "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart", + "properties": { + "supportingIndices": { + "description": "Citations for this answer part. Indices of `search_snippets`.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "text": { + "description": "Substring of the answer.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet": { + "description": "Snippet cited by the answer generation model.", + "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet", + "properties": { + "searchSnippet": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet", + "description": "Details of the snippet." + }, + "snippetIndex": { + "description": "Index of the snippet in `search_snippets` field.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals": { + "description": "Grounding signals.", + "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals", + "properties": { + "decision": { + "description": "Represents the decision of the grounding check.", + "enum": [ + "GROUNDING_DECISION_UNSPECIFIED", + "ACCEPTED_BY_GROUNDING", + "REJECTED_BY_GROUNDING" + ], + "enumDescriptions": [ + "Decision not specified.", + "Grounding have accepted the answer.", + "Grounding have rejected the answer." + ], + "type": "string" + }, + "score": { + "description": "Grounding score bucket setting.", + "enum": [ + "GROUNDING_SCORE_BUCKET_UNSPECIFIED", + "VERY_LOW", + "LOW", + "MEDIUM", + "HIGH", + "VERY_HIGH" + ], + "enumDescriptions": [ + "Score not specified.", + "We have very low confidence that the answer is grounded.", + "We have low confidence that the answer is grounded.", + "We have medium confidence that the answer is grounded.", + "We have high confidence that the answer is grounded.", + "We have very high confidence that the answer is grounded." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals": { + "description": "Diagnostic info related to the rewriter model call.", + "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals", + "properties": { + "modelOutput": { + "description": "Output of the generative model.", + "type": "string" + }, + "renderedPrompt": { + "description": "Prompt as sent to the model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals": { + "description": "Safety check results.", + "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals", + "properties": { + "bannedPhraseMatch": { + "description": "Specifies banned phrase match subject.", + "enum": [ + "BANNED_PHRASE_MATCH_UNSPECIFIED", + "BANNED_PHRASE_MATCH_NONE", + "BANNED_PHRASE_MATCH_QUERY", + "BANNED_PHRASE_MATCH_RESPONSE" + ], + "enumDescriptions": [ + "No banned phrase check was executed.", + "All banned phrase checks led to no match.", + "A banned phrase matched the query.", + "A banned phrase matched the response." + ], + "type": "string" + }, + "decision": { + "description": "Safety decision.", + "enum": [ + "SAFETY_DECISION_UNSPECIFIED", + "ACCEPTED_BY_SAFETY_CHECK", + "REJECTED_BY_SAFETY_CHECK" + ], + "enumDescriptions": [ + "Decision not specified.", + "No manual or automatic safety check fired.", + "One ore more safety checks fired." + ], + "type": "string" + }, + "matchedBannedPhrase": { + "description": "The matched banned phrase if there was a match.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet": { + "description": "Search snippet details.", + "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet", + "properties": { + "documentTitle": { + "description": "Title of the enclosing document.", + "type": "string" + }, + "documentUri": { + "description": "Uri for the document. Present if specified for the document.", + "type": "string" + }, + "text": { + "description": "Text included in the prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": { "description": "Metadata for DeleteDocument operation.", "id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata", @@ -10198,6 +10545,10 @@ "description": "This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { \"telephony\": { \"caller_id\": \"+18558363987\" } } ```", "type": "object" }, + "populateDataStoreConnectionSignals": { + "description": "Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.", + "type": "boolean" + }, "searchConfig": { "$ref": "GoogleCloudDialogflowCxV3beta1SearchConfig", "description": "Optional. Search configuration for UCS search queries." @@ -10244,6 +10595,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1Page", "description": "The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`." }, + "dataStoreConnectionSignals": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals", + "description": "Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request." + }, "diagnosticInfo": { "additionalProperties": { "description": "Properties of the object.", @@ -10884,7 +11239,7 @@ "type": "string" }, "retentionWindowDays": { - "description": "Retains data in interaction logging for the specified number of days. This does not apply to Cloud logging, which is owned by the user - not Dialogflow. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL.", + "description": "Retains data in interaction logging for the specified number of days. This does not apply to Cloud logging, which is owned by the user - not Dialogflow. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.", "format": "int32", "type": "integer" } @@ -10916,7 +11271,7 @@ "type": "string" }, "enableAudioRedaction": { - "description": "Enable audio redaction if it is true.", + "description": "Enable audio redaction if it is true. Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted.", "type": "boolean" }, "gcsBucket": { @@ -11838,6 +12193,10 @@ ], "type": "string" }, + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", + "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header." + }, "parameterMapping": { "additionalProperties": { "type": "string" @@ -11861,6 +12220,22 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", + "enum": [ + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "NONE", + "ID_TOKEN", + "ACCESS_TOKEN" + ], + "enumDescriptions": [ + "Service agent auth type unspecified. Default to ID_TOKEN.", + "No token used.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." + ], + "type": "string" + }, "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" @@ -11887,6 +12262,32 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig": { + "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", + "properties": { + "clientId": { + "description": "Required. The client ID provided by the 3rd party platform.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The client secret provided by the 3rd party platform.", + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index c55456712c9..6291aabb7d0 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -140,6 +140,10 @@ export namespace dialogflow_v2 { * Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */ loggingSettings?: Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings; + /** + * Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + */ + speechSettings?: Schema$GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings; } /** * Define behaviors for DTMF (dual tone multi frequency). @@ -171,6 +175,27 @@ export namespace dialogflow_v2 { */ enableStackdriverLogging?: boolean | null; } + /** + * Define behaviors of speech to text detection. + */ + export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings { + /** + * Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + */ + endpointerSensitivity?: number | null; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + */ + models?: {[key: string]: string} | null; + /** + * Timeout before detecting no speech. + */ + noSpeechTimeout?: string | null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + */ + useTimeoutBasedEndpointing?: boolean | null; + } /** * Represents the natural speech audio to be processed. */ @@ -231,6 +256,10 @@ export namespace dialogflow_v2 { * Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */ loggingSettings?: Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings; + /** + * Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + */ + speechSettings?: Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings; } /** * Define behaviors for DTMF (dual tone multi frequency). @@ -262,6 +291,27 @@ export namespace dialogflow_v2 { */ enableStackdriverLogging?: boolean | null; } + /** + * Define behaviors of speech to text detection. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings { + /** + * Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + */ + endpointerSensitivity?: number | null; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + */ + models?: {[key: string]: string} | null; + /** + * Timeout before detecting no speech. + */ + noSpeechTimeout?: string | null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + */ + useTimeoutBasedEndpointing?: boolean | null; + } /** * Represents the natural speech audio to be processed. */ @@ -1690,6 +1740,10 @@ export namespace dialogflow_v2 { * Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. */ httpMethod?: string | null; + /** + * Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig; /** * Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response */ @@ -1706,6 +1760,10 @@ export namespace dialogflow_v2 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; /** * Required. The webhook URI for receiving POST requests. It must use https protocol. */ @@ -1719,6 +1777,27 @@ export namespace dialogflow_v2 { */ webhookType?: string | null; } + /** + * Represents configuration of OAuth client credential flow for 3rd party API authentication. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig { + /** + * Required. The client ID provided by the 3rd party platform. + */ + clientId?: string | null; + /** + * Required. The client secret provided by the 3rd party platform. + */ + clientSecret?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Required. The token endpoint provided by the 3rd party platform to exchange an access token. + */ + tokenEndpoint?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -3283,6 +3362,10 @@ export namespace dialogflow_v2 { * Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. */ httpMethod?: string | null; + /** + * Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig; /** * Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response */ @@ -3299,6 +3382,10 @@ export namespace dialogflow_v2 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; /** * Required. The webhook URI for receiving POST requests. It must use https protocol. */ @@ -3312,6 +3399,27 @@ export namespace dialogflow_v2 { */ webhookType?: string | null; } + /** + * Represents configuration of OAuth client credential flow for 3rd party API authentication. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig { + /** + * Required. The client ID provided by the 3rd party platform. + */ + clientId?: string | null; + /** + * Required. The client secret provided by the 3rd party platform. + */ + clientSecret?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Required. The token endpoint provided by the 3rd party platform to exchange an access token. + */ + tokenEndpoint?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 79b0469e343..98fbc7114df 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -140,6 +140,10 @@ export namespace dialogflow_v2beta1 { * Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */ loggingSettings?: Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings; + /** + * Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + */ + speechSettings?: Schema$GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings; } /** * Define behaviors for DTMF (dual tone multi frequency). @@ -171,6 +175,27 @@ export namespace dialogflow_v2beta1 { */ enableStackdriverLogging?: boolean | null; } + /** + * Define behaviors of speech to text detection. + */ + export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings { + /** + * Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + */ + endpointerSensitivity?: number | null; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + */ + models?: {[key: string]: string} | null; + /** + * Timeout before detecting no speech. + */ + noSpeechTimeout?: string | null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + */ + useTimeoutBasedEndpointing?: boolean | null; + } /** * Represents the natural speech audio to be processed. */ @@ -231,6 +256,10 @@ export namespace dialogflow_v2beta1 { * Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */ loggingSettings?: Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings; + /** + * Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + */ + speechSettings?: Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings; } /** * Define behaviors for DTMF (dual tone multi frequency). @@ -262,6 +291,27 @@ export namespace dialogflow_v2beta1 { */ enableStackdriverLogging?: boolean | null; } + /** + * Define behaviors of speech to text detection. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings { + /** + * Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + */ + endpointerSensitivity?: number | null; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + */ + models?: {[key: string]: string} | null; + /** + * Timeout before detecting no speech. + */ + noSpeechTimeout?: string | null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + */ + useTimeoutBasedEndpointing?: boolean | null; + } /** * Represents the natural speech audio to be processed. */ @@ -1690,6 +1740,10 @@ export namespace dialogflow_v2beta1 { * Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. */ httpMethod?: string | null; + /** + * Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig; /** * Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response */ @@ -1706,6 +1760,10 @@ export namespace dialogflow_v2beta1 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; /** * Required. The webhook URI for receiving POST requests. It must use https protocol. */ @@ -1719,6 +1777,27 @@ export namespace dialogflow_v2beta1 { */ webhookType?: string | null; } + /** + * Represents configuration of OAuth client credential flow for 3rd party API authentication. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig { + /** + * Required. The client ID provided by the 3rd party platform. + */ + clientId?: string | null; + /** + * Required. The client secret provided by the 3rd party platform. + */ + clientSecret?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Required. The token endpoint provided by the 3rd party platform to exchange an access token. + */ + tokenEndpoint?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -3283,6 +3362,10 @@ export namespace dialogflow_v2beta1 { * Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. */ httpMethod?: string | null; + /** + * Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig; /** * Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response */ @@ -3299,6 +3382,10 @@ export namespace dialogflow_v2beta1 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; /** * Required. The webhook URI for receiving POST requests. It must use https protocol. */ @@ -3312,6 +3399,27 @@ export namespace dialogflow_v2beta1 { */ webhookType?: string | null; } + /** + * Represents configuration of OAuth client credential flow for 3rd party API authentication. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig { + /** + * Required. The client ID provided by the 3rd party platform. + */ + clientId?: string | null; + /** + * Required. The client secret provided by the 3rd party platform. + */ + clientSecret?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Required. The token endpoint provided by the 3rd party platform to exchange an access token. + */ + tokenEndpoint?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index d9f6ea25163..d7697154a4f 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -140,6 +140,10 @@ export namespace dialogflow_v3 { * Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */ loggingSettings?: Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings; + /** + * Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + */ + speechSettings?: Schema$GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings; } /** * Define behaviors for DTMF (dual tone multi frequency). @@ -171,6 +175,27 @@ export namespace dialogflow_v3 { */ enableStackdriverLogging?: boolean | null; } + /** + * Define behaviors of speech to text detection. + */ + export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings { + /** + * Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + */ + endpointerSensitivity?: number | null; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + */ + models?: {[key: string]: string} | null; + /** + * Timeout before detecting no speech. + */ + noSpeechTimeout?: string | null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + */ + useTimeoutBasedEndpointing?: boolean | null; + } /** * Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows. */ @@ -223,6 +248,10 @@ export namespace dialogflow_v3 { * The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. */ name?: string | null; + /** + * Optional. Settings for end user personalization. + */ + personalizationSettings?: Schema$GoogleCloudDialogflowCxV3AgentPersonalizationSettings; /** * Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. */ @@ -300,6 +329,15 @@ export namespace dialogflow_v3 { */ trackingBranch?: string | null; } + /** + * Settings for end user personalization. + */ + export interface Schema$GoogleCloudDialogflowCxV3AgentPersonalizationSettings { + /** + * Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" \}. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing. + */ + defaultEndUserMetadata?: {[key: string]: any} | null; + } /** * The response message for Agents.GetAgentValidationResult. */ @@ -425,6 +463,10 @@ export namespace dialogflow_v3 { * Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */ loggingSettings?: Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings; + /** + * Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + */ + speechSettings?: Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings; } /** * Define behaviors for DTMF (dual tone multi frequency). @@ -456,6 +498,27 @@ export namespace dialogflow_v3 { */ enableStackdriverLogging?: boolean | null; } + /** + * Define behaviors of speech to text detection. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings { + /** + * Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + */ + endpointerSensitivity?: number | null; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + */ + models?: {[key: string]: string} | null; + /** + * Timeout before detecting no speech. + */ + noSpeechTimeout?: string | null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + */ + useTimeoutBasedEndpointing?: boolean | null; + } /** * Represents the natural speech audio to be processed. */ @@ -1884,6 +1947,10 @@ export namespace dialogflow_v3 { * Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. */ httpMethod?: string | null; + /** + * Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig; /** * Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response */ @@ -1900,6 +1967,10 @@ export namespace dialogflow_v3 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; /** * Required. The webhook URI for receiving POST requests. It must use https protocol. */ @@ -1913,6 +1984,27 @@ export namespace dialogflow_v3 { */ webhookType?: string | null; } + /** + * Represents configuration of OAuth client credential flow for 3rd party API authentication. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig { + /** + * Required. The client ID provided by the 3rd party platform. + */ + clientId?: string | null; + /** + * Required. The client secret provided by the 3rd party platform. + */ + clientSecret?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Required. The token endpoint provided by the 3rd party platform to exchange an access token. + */ + tokenEndpoint?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -2340,6 +2432,146 @@ export namespace dialogflow_v3 { */ dataStoreType?: string | null; } + /** + * Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... + */ + export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignals { + /** + * Optional. The final compiled answer. + */ + answer?: string | null; + /** + * Optional. Diagnostic info related to the answer generation model call. + */ + answerGenerationModelCallSignals?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals; + /** + * Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). + */ + answerParts?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart[]; + /** + * Optional. Snippets cited by the answer generation model from the most to least relevant. + */ + citedSnippets?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet[]; + /** + * Optional. Grounding signals. + */ + groundingSignals?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals; + /** + * Optional. Diagnostic info related to the rewriter model call. + */ + rewriterModelCallSignals?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals; + /** + * Optional. Rewritten string query used for search. + */ + rewrittenQuery?: string | null; + /** + * Optional. Safety check result. + */ + safetySignals?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals; + /** + * Optional. Search snippets included in the answer generation prompt. + */ + searchSnippets?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet[]; + } + /** + * Diagnostic info related to the answer generation model call. + */ + export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals { + /** + * Output of the generative model. + */ + modelOutput?: string | null; + /** + * Prompt as sent to the model. + */ + renderedPrompt?: string | null; + } + /** + * Answer part with citation. + */ + export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart { + /** + * Citations for this answer part. Indices of `search_snippets`. + */ + supportingIndices?: number[] | null; + /** + * Substring of the answer. + */ + text?: string | null; + } + /** + * Snippet cited by the answer generation model. + */ + export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet { + /** + * Details of the snippet. + */ + searchSnippet?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet; + /** + * Index of the snippet in `search_snippets` field. + */ + snippetIndex?: number | null; + } + /** + * Grounding signals. + */ + export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals { + /** + * Represents the decision of the grounding check. + */ + decision?: string | null; + /** + * Grounding score bucket setting. + */ + score?: string | null; + } + /** + * Diagnostic info related to the rewriter model call. + */ + export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals { + /** + * Output of the generative model. + */ + modelOutput?: string | null; + /** + * Prompt as sent to the model. + */ + renderedPrompt?: string | null; + } + /** + * Safety check results. + */ + export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals { + /** + * Specifies banned phrase match subject. + */ + bannedPhraseMatch?: string | null; + /** + * Safety decision. + */ + decision?: string | null; + /** + * The matched banned phrase if there was a match. + */ + matchedBannedPhrase?: string | null; + } + /** + * Search snippet details. + */ + export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet { + /** + * Title of the enclosing document. + */ + documentTitle?: string | null; + /** + * Uri for the document. Present if specified for the document. + */ + documentUri?: string | null; + /** + * Text included in the prompt. + */ + text?: string | null; + } /** * Metadata for DeleteDocument operation. */ @@ -4312,6 +4544,10 @@ export namespace dialogflow_v3 { * This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" \} \} ``` */ payload?: {[key: string]: any} | null; + /** + * Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations. + */ + populateDataStoreConnectionSignals?: boolean | null; /** * Optional. Search configuration for UCS search queries. */ @@ -4349,6 +4585,10 @@ export namespace dialogflow_v3 { * The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. */ currentPage?: Schema$GoogleCloudDialogflowCxV3Page; + /** + * Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. + */ + dataStoreConnectionSignals?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignals; /** * The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. */ @@ -4794,7 +5034,7 @@ export namespace dialogflow_v3 { */ retentionStrategy?: string | null; /** - * Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. + * Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact. */ retentionWindowDays?: number | null; } @@ -4811,7 +5051,7 @@ export namespace dialogflow_v3 { */ audioFormat?: string | null; /** - * Enable audio redaction if it is true. + * Enable audio redaction if it is true. Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted. */ enableAudioRedaction?: boolean | null; /** @@ -5443,6 +5683,10 @@ export namespace dialogflow_v3 { * Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. */ httpMethod?: string | null; + /** + * Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig; /** * Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response */ @@ -5459,6 +5703,10 @@ export namespace dialogflow_v3 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; /** * Required. The webhook URI for receiving POST requests. It must use https protocol. */ @@ -5472,6 +5720,27 @@ export namespace dialogflow_v3 { */ webhookType?: string | null; } + /** + * Represents configuration of OAuth client credential flow for 3rd party API authentication. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig { + /** + * Required. The client ID provided by the 3rd party platform. + */ + clientId?: string | null; + /** + * Required. The client secret provided by the 3rd party platform. + */ + clientSecret?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Required. The token endpoint provided by the 3rd party platform to exchange an access token. + */ + tokenEndpoint?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index e9e361bd5fd..6c2e89d05c2 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -140,6 +140,10 @@ export namespace dialogflow_v3beta1 { * Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */ loggingSettings?: Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings; + /** + * Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + */ + speechSettings?: Schema$GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings; } /** * Define behaviors for DTMF (dual tone multi frequency). @@ -171,6 +175,27 @@ export namespace dialogflow_v3beta1 { */ enableStackdriverLogging?: boolean | null; } + /** + * Define behaviors of speech to text detection. + */ + export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings { + /** + * Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + */ + endpointerSensitivity?: number | null; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + */ + models?: {[key: string]: string} | null; + /** + * Timeout before detecting no speech. + */ + noSpeechTimeout?: string | null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + */ + useTimeoutBasedEndpointing?: boolean | null; + } /** * Represents the natural speech audio to be processed. */ @@ -231,6 +256,10 @@ export namespace dialogflow_v3beta1 { * Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */ loggingSettings?: Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings; + /** + * Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + */ + speechSettings?: Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings; } /** * Define behaviors for DTMF (dual tone multi frequency). @@ -262,6 +291,27 @@ export namespace dialogflow_v3beta1 { */ enableStackdriverLogging?: boolean | null; } + /** + * Define behaviors of speech to text detection. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings { + /** + * Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + */ + endpointerSensitivity?: number | null; + /** + * Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + */ + models?: {[key: string]: string} | null; + /** + * Timeout before detecting no speech. + */ + noSpeechTimeout?: string | null; + /** + * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + */ + useTimeoutBasedEndpointing?: boolean | null; + } /** * Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows. */ @@ -314,6 +364,10 @@ export namespace dialogflow_v3beta1 { * The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. */ name?: string | null; + /** + * Optional. Settings for end user personalization. + */ + personalizationSettings?: Schema$GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings; /** * Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. */ @@ -391,6 +445,15 @@ export namespace dialogflow_v3beta1 { */ trackingBranch?: string | null; } + /** + * Settings for end user personalization. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings { + /** + * Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" \}. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing. + */ + defaultEndUserMetadata?: {[key: string]: any} | null; + } /** * The response message for Agents.GetAgentValidationResult. */ @@ -751,6 +814,146 @@ export namespace dialogflow_v3beta1 { */ dataStoreType?: string | null; } + /** + * Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals { + /** + * Optional. The final compiled answer. + */ + answer?: string | null; + /** + * Optional. Diagnostic info related to the answer generation model call. + */ + answerGenerationModelCallSignals?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals; + /** + * Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). + */ + answerParts?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart[]; + /** + * Optional. Snippets cited by the answer generation model from the most to least relevant. + */ + citedSnippets?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet[]; + /** + * Optional. Grounding signals. + */ + groundingSignals?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals; + /** + * Optional. Diagnostic info related to the rewriter model call. + */ + rewriterModelCallSignals?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals; + /** + * Optional. Rewritten string query used for search. + */ + rewrittenQuery?: string | null; + /** + * Optional. Safety check result. + */ + safetySignals?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals; + /** + * Optional. Search snippets included in the answer generation prompt. + */ + searchSnippets?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet[]; + } + /** + * Diagnostic info related to the answer generation model call. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals { + /** + * Output of the generative model. + */ + modelOutput?: string | null; + /** + * Prompt as sent to the model. + */ + renderedPrompt?: string | null; + } + /** + * Answer part with citation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerPart { + /** + * Citations for this answer part. Indices of `search_snippets`. + */ + supportingIndices?: number[] | null; + /** + * Substring of the answer. + */ + text?: string | null; + } + /** + * Snippet cited by the answer generation model. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsCitedSnippet { + /** + * Details of the snippet. + */ + searchSnippet?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet; + /** + * Index of the snippet in `search_snippets` field. + */ + snippetIndex?: number | null; + } + /** + * Grounding signals. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsGroundingSignals { + /** + * Represents the decision of the grounding check. + */ + decision?: string | null; + /** + * Grounding score bucket setting. + */ + score?: string | null; + } + /** + * Diagnostic info related to the rewriter model call. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals { + /** + * Output of the generative model. + */ + modelOutput?: string | null; + /** + * Prompt as sent to the model. + */ + renderedPrompt?: string | null; + } + /** + * Safety check results. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSafetySignals { + /** + * Specifies banned phrase match subject. + */ + bannedPhraseMatch?: string | null; + /** + * Safety decision. + */ + decision?: string | null; + /** + * The matched banned phrase if there was a match. + */ + matchedBannedPhrase?: string | null; + } + /** + * Search snippet details. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsSearchSnippet { + /** + * Title of the enclosing document. + */ + documentTitle?: string | null; + /** + * Uri for the document. Present if specified for the document. + */ + documentUri?: string | null; + /** + * Text included in the prompt. + */ + text?: string | null; + } /** * Metadata for DeleteDocument operation. */ @@ -2723,6 +2926,10 @@ export namespace dialogflow_v3beta1 { * This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" \} \} ``` */ payload?: {[key: string]: any} | null; + /** + * Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations. + */ + populateDataStoreConnectionSignals?: boolean | null; /** * Optional. Search configuration for UCS search queries. */ @@ -2760,6 +2967,10 @@ export namespace dialogflow_v3beta1 { * The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. */ currentPage?: Schema$GoogleCloudDialogflowCxV3beta1Page; + /** + * Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. + */ + dataStoreConnectionSignals?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals; /** * The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. */ @@ -3217,7 +3428,7 @@ export namespace dialogflow_v3beta1 { */ retentionStrategy?: string | null; /** - * Retains data in interaction logging for the specified number of days. This does not apply to Cloud logging, which is owned by the user - not Dialogflow. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. + * Retains data in interaction logging for the specified number of days. This does not apply to Cloud logging, which is owned by the user - not Dialogflow. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact. */ retentionWindowDays?: number | null; } @@ -3234,7 +3445,7 @@ export namespace dialogflow_v3beta1 { */ audioFormat?: string | null; /** - * Enable audio redaction if it is true. + * Enable audio redaction if it is true. Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted. */ enableAudioRedaction?: boolean | null; /** @@ -3868,6 +4079,10 @@ export namespace dialogflow_v3beta1 { * Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. */ httpMethod?: string | null; + /** + * Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig; /** * Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response */ @@ -3884,6 +4099,10 @@ export namespace dialogflow_v3beta1 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; /** * Required. The webhook URI for receiving POST requests. It must use https protocol. */ @@ -3897,6 +4116,27 @@ export namespace dialogflow_v3beta1 { */ webhookType?: string | null; } + /** + * Represents configuration of OAuth client credential flow for 3rd party API authentication. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig { + /** + * Required. The client ID provided by the 3rd party platform. + */ + clientId?: string | null; + /** + * Required. The client secret provided by the 3rd party platform. + */ + clientSecret?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Required. The token endpoint provided by the 3rd party platform to exchange an access token. + */ + tokenEndpoint?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -5461,6 +5701,10 @@ export namespace dialogflow_v3beta1 { * Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. */ httpMethod?: string | null; + /** + * Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig; /** * Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response */ @@ -5477,6 +5721,10 @@ export namespace dialogflow_v3beta1 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; /** * Required. The webhook URI for receiving POST requests. It must use https protocol. */ @@ -5490,6 +5738,27 @@ export namespace dialogflow_v3beta1 { */ webhookType?: string | null; } + /** + * Represents configuration of OAuth client credential flow for 3rd party API authentication. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig { + /** + * Required. The client ID provided by the 3rd party platform. + */ + clientId?: string | null; + /** + * Required. The client secret provided by the 3rd party platform. + */ + clientSecret?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Required. The token endpoint provided by the 3rd party platform to exchange an access token. + */ + tokenEndpoint?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ From e5ab8e651d1b7ff419c33ffff6f1b74e0e950e75 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:50 +0000 Subject: [PATCH 36/78] feat(discoveryengine)!: update the API BREAKING CHANGE: This release has breaking changes. #### discoveryengine:v1alpha The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1DigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1DigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1DigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.ocrConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.ocrConfig.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.ocrConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.allowMultipleDataStoresSearchEngine.description - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.allowMultipleDataStoresSearchEngine.type - schemas.GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enabled.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enabled.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.format - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.type The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.scopes - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.description - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.flatPath - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.id - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.path - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.scopes - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.description - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.flatPath - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.id - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.path - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.scopes - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaChunk.description - schemas.GoogleCloudDiscoveryengineV1alphaChunk.id - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.content.description - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.content.type - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.derivedStructData.additionalProperties.description - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.derivedStructData.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.derivedStructData.description - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.derivedStructData.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.derivedStructData.type - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.documentMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.documentMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.id.description - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.id.type - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaChunk.type - schemas.GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata.properties.title.description - schemas.GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata.properties.title.type - schemas.GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentAclInfo.properties.readers.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.chunkingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.chunkingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.properties.layoutBasedChunkingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.properties.layoutBasedChunkingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.chunkSize.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.chunkSize.format - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.chunkSize.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.includeAncestorHeadings.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.includeAncestorHeadings.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaListChunksResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaListChunksResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaListChunksResponse.properties.chunks.description - schemas.GoogleCloudDiscoveryengineV1alphaListChunksResponse.properties.chunks.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaListChunksResponse.properties.chunks.type - schemas.GoogleCloudDiscoveryengineV1alphaListChunksResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1alphaListChunksResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1alphaListChunksResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.dataStoreSpecs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.dataStoreSpecs.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec.properties.searchResultMode.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec.properties.searchResultMode.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec.properties.searchResultMode.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec.properties.searchResultMode.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec.properties.returnExtractiveSegmentScore.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec.properties.returnExtractiveSegmentScore.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec.properties.dataStore.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec.properties.dataStore.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult.properties.chunk.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult.properties.chunk.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.collectionComponents.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.collectionComponents.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.collectionComponents.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.collectionComponents.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreUiConfigs.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreUiConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreUiConfigs.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataStoreComponents.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataStoreComponents.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataStoreComponents.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.id.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.id.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.id.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.id.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.id.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.id.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.facetField.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.facetField.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.facetField.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.fieldsUiComponentsMap.additionalProperties.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.fieldsUiComponentsMap.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.fieldsUiComponentsMap.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.id.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.id.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.id.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.id - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorConfig.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.modelStatus.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.modelStatus.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.type The following keys were changed: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig.properties.digitalParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig.properties.ocrParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig.properties.digitalParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig.properties.layoutParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig.properties.ocrParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec.properties.condition.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec.properties.summaryResultCount.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec.properties.version.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput.properties.corpusDataPath.description - schemas.GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput.properties.queryDataPath.description - schemas.GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput.properties.trainDataPath.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig.properties.digitalParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig.properties.ocrParsingConfig.$ref #### discoveryengine:v1beta The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1DigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1DigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1DigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.ocrConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.ocrConfig.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.ocrConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.allowMultipleDataStoresSearchEngine.description - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.allowMultipleDataStoresSearchEngine.type - schemas.GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enabled.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enabled.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1alphaOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.deprecated - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.format - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.type The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.description - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.id - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.parameters.dataStore.description - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.parameters.dataStore.location - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.parameters.dataStore.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.parameters.dataStore.required - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.parameters.dataStore.type - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.path - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.request.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.scopes - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.chunkingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.chunkingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.properties.layoutBasedChunkingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.properties.layoutBasedChunkingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.chunkSize.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.chunkSize.format - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.chunkSize.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.includeAncestorHeadings.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.properties.includeAncestorHeadings.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.items.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.enhancedDocumentElements.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.description - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.properties.useNativeText.type - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.dataStoreSpecs.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.dataStoreSpecs.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec.properties.returnExtractiveSegmentScore.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec.properties.returnExtractiveSegmentScore.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec.properties.dataStore.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec.properties.dataStore.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.id - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.properties.errorConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.properties.errorConfig.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.properties.gcsTrainingInput.$ref - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.properties.gcsTrainingInput.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.properties.modelType.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.properties.modelType.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.id - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.properties.corpusDataPath.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.properties.corpusDataPath.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.properties.queryDataPath.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.properties.queryDataPath.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.properties.testDataPath.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.properties.testDataPath.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.properties.trainDataPath.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.properties.trainDataPath.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.id - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorConfig.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.modelStatus.description - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.properties.modelStatus.type - schemas.GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse.type The following keys were changed: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.description - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig.properties.digitalParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig.properties.ocrParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig.properties.digitalParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig.properties.layoutParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig.properties.ocrParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig.properties.digitalParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig.properties.ocrParsingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec.properties.condition.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec.properties.summaryResultCount.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec.properties.version.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.name.description --- discovery/discoveryengine-v1alpha.json | 640 ++++++++++++---- discovery/discoveryengine-v1beta.json | 398 ++++++---- src/apis/discoveryengine/v1alpha.ts | 993 ++++++++++++++++++++----- src/apis/discoveryengine/v1beta.ts | 398 +++++++--- 4 files changed, 1870 insertions(+), 559 deletions(-) diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index c6bac32a87b..4465cbf7396 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -926,6 +926,73 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "chunks": { + "methods": { + "get": { + "description": "Gets a Document.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks/{chunksId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.chunks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Chunk, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+/chunks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of Chunks.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.chunks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/chunks", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListChunksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "operations": { @@ -1574,7 +1641,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -1610,7 +1677,7 @@ "type": "string" }, "parent": { - "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1635,7 +1702,7 @@ ], "parameters": { "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -2896,7 +2963,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -2932,7 +2999,7 @@ "type": "string" }, "parent": { - "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2957,7 +3024,7 @@ ], "parameters": { "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -3627,6 +3694,73 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "chunks": { + "methods": { + "get": { + "description": "Gets a Document.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks/{chunksId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.branches.documents.chunks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Chunk, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+/chunks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of Chunks.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.branches.documents.chunks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/chunks", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListChunksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "operations": { @@ -4203,7 +4337,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -4239,7 +4373,7 @@ "type": "string" }, "parent": { - "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4264,7 +4398,7 @@ ], "parameters": { "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -4946,7 +5080,7 @@ } } }, - "revision": "20240227", + "revision": "20240312", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5345,12 +5479,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DigitalParsingConfig", - "properties": {}, - "type": "object" - }, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", @@ -5401,16 +5529,40 @@ "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "properties": { "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DigitalParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1OcrParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", @@ -5763,24 +5915,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1OcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1OcrParsingConfig", - "properties": { - "enhancedDocumentElements": { - "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", @@ -6158,6 +6292,53 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaChunk": { + "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", + "id": "GoogleCloudDiscoveryengineV1alphaChunk", + "properties": { + "content": { + "description": "Content is a string from a document (parsed content).", + "type": "string" + }, + "derivedStructData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", + "readOnly": true, + "type": "object" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", + "description": "Metadata of the document from the current chunk." + }, + "id": { + "description": "Unique chunk id of the current chunk.", + "type": "string" + }, + "name": { + "description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", + "properties": { + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "Uri of the document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest": { "description": "Request message for CompletionService.CompleteQuery method.", "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest", @@ -6675,12 +6856,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig", - "properties": {}, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", @@ -6773,6 +6948,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", "properties": { "readers": { + "description": "Readers of the document.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" }, @@ -6850,6 +7026,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -6858,11 +7038,6 @@ "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, - "ocrConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOcrConfig", - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs." - }, "parsingConfigOverrides": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" @@ -6873,25 +7048,82 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "description": "Configurations applied to layout parser." }, "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOcrParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDoubleList": { "description": "Double list.", "id": "GoogleCloudDiscoveryengineV1alphaDoubleList", @@ -6951,10 +7183,6 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { - "allowMultipleDataStoresSearchEngine": { - "description": "Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field.", - "type": "boolean" - }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -7864,10 +8092,22 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { + "description": "Response message for ChunkService.ListChunks method.", + "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", + "properties": { + "chunks": { + "description": "The Chunks.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaListConversationsResponse": { @@ -8040,47 +8280,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaOcrConfig": { - "deprecated": true, - "description": "The OCR options for parsing documents.", - "id": "GoogleCloudDiscoveryengineV1alphaOcrConfig", - "properties": { - "enabled": { - "description": "Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.", - "type": "boolean" - }, - "enhancedDocumentElements": { - "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaOcrParsingConfig", - "properties": { - "enhancedDocumentElements": { - "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", @@ -8673,6 +8872,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "description": "Custom fine tuning configs." }, + "dataStoreSpecs": { + "description": "A list of data store specs to apply on a search call.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + }, + "type": "array" + }, "embeddingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." @@ -8783,7 +8989,7 @@ "type": "number" }, "condition": { - "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))", + "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, @@ -8797,6 +9003,20 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", + "enum": [ + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" + ], + "enumDescriptions": [ + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." + ], + "type": "string" + }, "snippetSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "description": "If `snippetSpec` is not specified, snippets are not included in the search response." @@ -8831,6 +9051,10 @@ "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", "format": "int32", "type": "integer" + }, + "returnExtractiveSegmentScore": { + "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`.", + "type": "boolean" } }, "type": "object" @@ -8886,7 +9110,7 @@ "description": "If specified, the spec will be used to modify the model specification provided to the LLM." }, "summaryResultCount": { - "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary.", + "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary.", "format": "int32", "type": "integer" } @@ -8909,7 +9133,18 @@ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { "version": { - "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English.", + "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { + "description": "A struct to define data stores to filter on in a search call.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", + "properties": { + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, @@ -9259,6 +9494,10 @@ "description": "Represents the search results.", "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult", "properties": { + "chunk": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk", + "description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." + }, "document": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", "description": "The document data snippet in the search response. Only fields that are marked as retrievable are populated." @@ -9503,7 +9742,7 @@ "type": "string" }, "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "type": "string" }, "onewaySynonymsControlIds": { @@ -9583,12 +9822,6 @@ "format": "int32", "type": "integer" }, - "contentWatchedMinutesThreshold": { - "deprecated": true, - "description": "Specifies the content watched minutes threshold for demotion.", - "format": "float", - "type": "number" - }, "contentWatchedPercentageThreshold": { "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", "format": "float", @@ -9823,11 +10056,11 @@ "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", "properties": { "corpusDataPath": { - "description": "The Cloud Storage corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: {\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}", + "description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`", "type": "string" }, "queryDataPath": { - "description": "The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", + "description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", "type": "string" }, "testDataPath": { @@ -9835,7 +10068,7 @@ "type": "string" }, "trainDataPath": { - "description": "Cloud Storage training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\\tcorpus-id\\tscore query1\\tdoc1\\t1", + "description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`", "type": "string" } }, @@ -10125,6 +10358,14 @@ }, "type": "array" }, + "collectionComponents": { + "description": "Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent" + }, + "readOnly": true, + "type": "array" + }, "configId": { "description": "Output only. Unique obfuscated identifier of a WidgetConfig.", "readOnly": true, @@ -10159,6 +10400,13 @@ "readOnly": true, "type": "string" }, + "dataStoreUiConfigs": { + "description": "Configurable UI configurations per data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig" + }, + "type": "array" + }, "displayName": { "description": "Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" @@ -10277,6 +10525,83 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent": { + "description": "Read-only collection component that contains data store collections fields that may be used for filtering", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent", + "properties": { + "dataStoreComponents": { + "description": "For the data store collection, list of the children data stores.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent" + }, + "type": "array" + }, + "displayName": { + "description": "The display name of the collection.", + "type": "string" + }, + "id": { + "description": "Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For widget service usage, such look up widget config, returned name should be skipped.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent": { + "description": "Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent", + "properties": { + "displayName": { + "description": "The display name of the data store.", + "type": "string" + }, + "id": { + "description": "Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For widget service usage, such look up widget config, returned name should be skipped.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig": { + "description": "UI component configuration for data store.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig", + "properties": { + "facetField": { + "description": "Facet fields that store the mapping of fields to end user widget appearance.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField" + }, + "type": "array" + }, + "fieldsUiComponentsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField" + }, + "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.", + "type": "object" + }, + "id": { + "description": "Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For widget service usage, such look up widget config, returned name should be skipped.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField": { "description": "Facet fields that store the mapping of fields to end user widget appearance.", "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField", @@ -10650,12 +10975,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig", - "properties": {}, - "type": "object" - }, "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", @@ -10706,16 +11025,40 @@ "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "properties": { "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaOcrParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", @@ -11068,24 +11411,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaOcrParsingConfig", - "properties": { - "enhancedDocumentElements": { - "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", @@ -11321,6 +11646,45 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata", diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 0d09851ccba..0312dd2048b 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -419,6 +419,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "trainCustomModel": { + "description": "Trains a custom model.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel", + "parameterOrder": [ + "dataStore" + ], + "parameters": { + "dataStore": { + "description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+dataStore}:trainCustomModel", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1282,7 +1310,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -1318,7 +1346,7 @@ "type": "string" }, "parent": { - "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1343,7 +1371,7 @@ ], "parameters": { "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -2492,7 +2520,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -2528,7 +2556,7 @@ "type": "string" }, "parent": { - "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2553,7 +2581,7 @@ ], "parameters": { "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -3734,7 +3762,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -3770,7 +3798,7 @@ "type": "string" }, "parent": { - "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -3795,7 +3823,7 @@ ], "parameters": { "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -4449,7 +4477,7 @@ } } }, - "revision": "20240227", + "revision": "20240312", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4848,12 +4876,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DigitalParsingConfig", - "properties": {}, - "type": "object" - }, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", @@ -4904,16 +4926,40 @@ "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "properties": { "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DigitalParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1OcrParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", @@ -5266,24 +5312,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1OcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1OcrParsingConfig", - "properties": { - "enhancedDocumentElements": { - "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", @@ -5827,12 +5855,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig", - "properties": {}, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", @@ -5860,6 +5882,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -5868,11 +5894,6 @@ "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, - "ocrConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOcrConfig", - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs." - }, "parsingConfigOverrides": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" @@ -5883,25 +5904,82 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "description": "Configurations applied to layout parser." }, "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOcrParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", @@ -5929,10 +6007,6 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { - "allowMultipleDataStoresSearchEngine": { - "description": "Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field.", - "type": "boolean" - }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -6566,53 +6640,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaOcrConfig": { - "deprecated": true, - "description": "The OCR options for parsing documents.", - "id": "GoogleCloudDiscoveryengineV1alphaOcrConfig", - "properties": { - "enabled": { - "description": "Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.", - "type": "boolean" - }, - "enhancedDocumentElements": { - "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaOcrParsingConfig", - "properties": { - "enhancedDocumentElements": { - "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", @@ -7641,12 +7668,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig", - "properties": {}, - "type": "object" - }, "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", @@ -7808,16 +7829,40 @@ "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "properties": { "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaOcrParsingConfig", + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDoubleList": { "description": "Double list.", "id": "GoogleCloudDiscoveryengineV1betaDoubleList", @@ -8543,24 +8588,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaOcrParsingConfig", - "properties": { - "enhancedDocumentElements": { - "description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1betaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1betaPageInfo", @@ -8933,6 +8960,13 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, + "dataStoreSpecs": { + "description": "A list of data store specs to apply on a search call.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" + }, + "type": "array" + }, "embeddingSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." @@ -9039,7 +9073,7 @@ "type": "number" }, "condition": { - "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))", + "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, @@ -9087,6 +9121,10 @@ "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", "format": "int32", "type": "integer" + }, + "returnExtractiveSegmentScore": { + "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`.", + "type": "boolean" } }, "type": "object" @@ -9142,7 +9180,7 @@ "description": "If specified, the spec will be used to modify the model specification provided to the LLM." }, "summaryResultCount": { - "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary.", + "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary.", "format": "int32", "type": "integer" } @@ -9165,7 +9203,18 @@ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { "version": { - "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English.", + "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { + "description": "A struct to define data stores to filter on in a search call.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", + "properties": { + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, @@ -9751,7 +9800,7 @@ "type": "string" }, "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "type": "string" }, "onewaySynonymsControlIds": { @@ -9831,12 +9880,6 @@ "format": "int32", "type": "integer" }, - "contentWatchedMinutesThreshold": { - "deprecated": true, - "description": "Specifies the content watched minutes threshold for demotion.", - "format": "float", - "type": "number" - }, "contentWatchedPercentageThreshold": { "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", "format": "float", @@ -10030,6 +10073,87 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest": { + "description": "Request message for SearchTuningService.TrainCustomModel method.", + "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the data ingestion and training." + }, + "gcsTrainingInput": { + "$ref": "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput", + "description": "Cloud Storage training input." + }, + "modelType": { + "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput": { + "description": "Cloud Storage training data input.", + "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput", + "properties": { + "corpusDataPath": { + "description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`", + "type": "string" + }, + "queryDataPath": { + "description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", + "type": "string" + }, + "testDataPath": { + "description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.", + "type": "string" + }, + "trainDataPath": { + "description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaTransactionInfo": { "description": "A transaction represents the entire purchase transaction.", "id": "GoogleCloudDiscoveryengineV1betaTransactionInfo", diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 8c06fa89977..b2100c75523 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -327,6 +327,44 @@ export namespace discoveryengine_v1alpha { */ tableId?: string | null; } + /** + * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaChunk { + /** + * Content is a string from a document (parsed content). + */ + content?: string | null; + /** + * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + */ + derivedStructData?: {[key: string]: any} | null; + /** + * Metadata of the document from the current chunk. + */ + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata; + /** + * Unique chunk id of the current chunk. + */ + id?: string | null; + /** + * The full resource name of the chunk. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}/chunks/{chunk_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } + /** + * Document metadata contains the information of the document of the current chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata { + /** + * Title of the document. + */ + title?: string | null; + /** + * Uri of the document. + */ + uri?: string | null; + } /** * Request message for CompletionService.CompleteQuery method. */ @@ -700,10 +738,6 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } - /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {} /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -774,6 +808,9 @@ export namespace discoveryengine_v1alpha { * ACL Information of the Document. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo { + /** + * Readers of the document. + */ readers?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[]; } /** @@ -831,6 +868,10 @@ export namespace discoveryengine_v1alpha { * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig; /** * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */ @@ -839,10 +880,6 @@ export namespace discoveryengine_v1alpha { * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. */ name?: string | null; - /** - * [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. - */ - ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig; /** * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */ @@ -852,6 +889,28 @@ export namespace discoveryengine_v1alpha { ]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig; } | null; } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + */ + includeAncestorHeadings?: boolean | null; + } /** * Related configurations applied to a specific type of document parser. */ @@ -859,15 +918,36 @@ export namespace discoveryengine_v1alpha { /** * Configurations applied to digital parser. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig; /** * Configurations applied to layout parser. */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig; + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig; + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** * Double list. @@ -912,10 +992,6 @@ export namespace discoveryengine_v1alpha { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine { - /** - * Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. - */ - allowMultipleDataStoresSearchEngine?: boolean | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -1512,9 +1588,18 @@ export namespace discoveryengine_v1alpha { minimum?: number | null; } /** - * The layout parsing configurations for documents. + * Response message for ChunkService.ListChunks method. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse { + /** + * The Chunks. + */ + chunks?: Schema$GoogleCloudDiscoveryengineV1alphaChunk[]; + /** + * A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response for ListConversations method. */ @@ -1641,36 +1726,6 @@ export namespace discoveryengine_v1alpha { */ mediaProgressPercentage?: number | null; } - /** - * The OCR options for parsing documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig { - /** - * Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. - */ - enabled?: boolean | null; - /** - * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. - */ - enhancedDocumentElements?: string[] | null; - /** - * If true, will use native text instead of OCR text on pages containing native text. - */ - useNativeText?: boolean | null; - } - /** - * The OCR parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig { - /** - * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. - */ - enhancedDocumentElements?: string[] | null; - /** - * If true, will use native text instead of OCR text on pages containing native text. - */ - useNativeText?: boolean | null; - } /** * Detailed page information. */ @@ -2123,6 +2178,10 @@ export namespace discoveryengine_v1alpha { * Custom fine tuning configs. */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; + /** + * A list of data store specs to apply on a search call. + */ + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; /** * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */ @@ -2214,7 +2273,7 @@ export namespace discoveryengine_v1alpha { */ boost?: number | null; /** - * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) + * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */ condition?: string | null; } @@ -2226,6 +2285,10 @@ export namespace discoveryengine_v1alpha { * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec; + /** + * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + */ + searchResultMode?: string | null; /** * If `snippetSpec` is not specified, snippets are not included in the search response. */ @@ -2255,6 +2318,10 @@ export namespace discoveryengine_v1alpha { * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ numPreviousSegments?: number | null; + /** + * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`. + */ + returnExtractiveSegmentScore?: boolean | null; } /** * A specification for configuring snippets in a search response. @@ -2302,7 +2369,7 @@ export namespace discoveryengine_v1alpha { */ modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary. + * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */ summaryResultCount?: number | null; } @@ -2320,10 +2387,19 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. + * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */ version?: string | null; } + /** + * A struct to define data stores to filter on in a search call. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. + */ + dataStore?: string | null; + } /** * The specification that uses customized query embedding vector to do semantic document retrieval. */ @@ -2571,6 +2647,10 @@ export namespace discoveryengine_v1alpha { * Represents the search results. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult { + /** + * The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + */ + chunk?: Schema$GoogleCloudDiscoveryengineV1alphaChunk; /** * The document data snippet in the search response. Only fields that are marked as retrievable are populated. */ @@ -2746,7 +2826,7 @@ export namespace discoveryengine_v1alpha { */ modelId?: string | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string | null; /** @@ -2795,10 +2875,6 @@ export namespace discoveryengine_v1alpha { * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */ contentFreshnessCutoffDays?: number | null; - /** - * Specifies the content watched minutes threshold for demotion. - */ - contentWatchedMinutesThreshold?: number | null; /** * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */ @@ -2954,11 +3030,11 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput { /** - * The Cloud Storage corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: {"_id": "doc1", title: "relevant doc", "text": "relevant text"\} + * The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"\}` */ corpusDataPath?: string | null; /** - * The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\} + * The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\} */ queryDataPath?: string | null; /** @@ -2966,7 +3042,7 @@ export namespace discoveryengine_v1alpha { */ testDataPath?: string | null; /** - * Cloud Storage training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\tdoc1\t1 + * Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` */ trainDataPath?: string | null; } @@ -3202,6 +3278,10 @@ export namespace discoveryengine_v1alpha { * Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. */ allowPublicAccess?: boolean | null; + /** + * Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. + */ + collectionComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[]; /** * Output only. Unique obfuscated identifier of a WidgetConfig. */ @@ -3218,6 +3298,10 @@ export namespace discoveryengine_v1alpha { * Output only. The type of the parent data store. */ dataStoreType?: string | null; + /** + * Configurable UI configurations per data store. + */ + dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[]; /** * Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ @@ -3295,6 +3379,69 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Read-only collection component that contains data store collections fields that may be used for filtering + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent { + /** + * For the data store collection, list of the children data stores. + */ + dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[]; + /** + * The display name of the collection. + */ + displayName?: string | null; + /** + * Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. + */ + id?: string | null; + /** + * The name of the collection. It should be collection resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}`. For widget service usage, such look up widget config, returned name should be skipped. + */ + name?: string | null; + } + /** + * Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent { + /** + * The display name of the data store. + */ + displayName?: string | null; + /** + * Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. + */ + id?: string | null; + /** + * The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For widget service usage, such look up widget config, returned name should be skipped. + */ + name?: string | null; + } + /** + * UI component configuration for data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig { + /** + * Facet fields that store the mapping of fields to end user widget appearance. + */ + facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[]; + /** + * The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. + */ + fieldsUiComponentsMap?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField; + } | null; + /** + * Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. + */ + id?: string | null; + /** + * The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For widget service usage, such look up widget config, returned name should be skipped. + */ + name?: string | null; + } /** * Facet fields that store the mapping of fields to end user widget appearance. */ @@ -3582,10 +3729,6 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } - /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {} /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -3631,11 +3774,28 @@ export namespace discoveryengine_v1alpha { /** * Configurations applied to digital parser. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig; + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -3883,19 +4043,6 @@ export namespace discoveryengine_v1alpha { */ unjoinedEventsCount?: string | null; } - /** - * The OCR parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig { - /** - * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. - */ - enhancedDocumentElements?: string[] | null; - /** - * If true, will use native text instead of OCR text on pages containing native text. - */ - useNativeText?: boolean | null; - } /** * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4049,6 +4196,36 @@ export namespace discoveryengine_v1alpha { */ totalRequiredQuota?: string | null; } + /** + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + /** + * A sample of errors encountered while processing the data. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. + */ + modelStatus?: string | null; + } /** * Metadata for UpdateSchema LRO. */ @@ -4220,10 +4397,6 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } - /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {} /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4269,11 +4442,28 @@ export namespace discoveryengine_v1alpha { /** * Configurations applied to digital parser. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig; + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -4521,19 +4711,6 @@ export namespace discoveryengine_v1alpha { */ unjoinedEventsCount?: string | null; } - /** - * The OCR parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig { - /** - * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. - */ - enhancedDocumentElements?: string[] | null; - /** - * If true, will use native text instead of OCR text on pages containing native text. - */ - useNativeText?: boolean | null; - } /** * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -6999,8 +7176,13 @@ export namespace discoveryengine_v1alpha { export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { context: APIRequestContext; + chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; constructor(context: APIRequestContext) { this.context = context; + this.chunks = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( + this.context + ); } /** @@ -7661,104 +7843,327 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + extends StandardParameters { + /** + * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to true, and the Document is not found, a new Document will be created. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a list of Chunks. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create - extends StandardParameters { - /** - * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - documentId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import - extends StandardParameters { - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List extends StandardParameters { /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */ pageSize?: number; /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ pageToken?: string; /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch - extends StandardParameters { - /** - * If set to true, and the Document is not found, a new Document will be created. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. */ parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; } export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { @@ -10374,7 +10779,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -10389,14 +10794,14 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** @@ -15029,7 +15434,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -15044,14 +15449,14 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** @@ -16354,8 +16759,13 @@ export namespace discoveryengine_v1alpha { export class Resource$Projects$Locations$Datastores$Branches$Documents { context: APIRequestContext; + chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; constructor(context: APIRequestContext) { this.context = context; + this.chunks = + new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( + this.context + ); } /** @@ -17116,6 +17526,229 @@ export namespace discoveryengine_v1alpha { requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; } + export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a list of Chunks. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + extends StandardParameters { + /** + * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List + extends StandardParameters { + /** + * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export class Resource$Projects$Locations$Datastores$Branches$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -19499,7 +20132,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -19514,14 +20147,14 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 3ca8cf86610..bdcb96db77e 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -427,10 +427,6 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } - /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {} /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -452,6 +448,10 @@ export namespace discoveryengine_v1beta { * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig; /** * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */ @@ -460,10 +460,6 @@ export namespace discoveryengine_v1beta { * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. */ name?: string | null; - /** - * [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. - */ - ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig; /** * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */ @@ -473,6 +469,28 @@ export namespace discoveryengine_v1beta { ]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig; } | null; } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + */ + includeAncestorHeadings?: boolean | null; + } /** * Related configurations applied to a specific type of document parser. */ @@ -480,15 +498,36 @@ export namespace discoveryengine_v1beta { /** * Configurations applied to digital parser. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig; /** * Configurations applied to layout parser. */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig; + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig; + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -511,10 +550,6 @@ export namespace discoveryengine_v1beta { * Metadata that describes the training and serving parameters of an Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine { - /** - * Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. - */ - allowMultipleDataStoresSearchEngine?: boolean | null; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ @@ -896,40 +931,6 @@ export namespace discoveryengine_v1beta { */ unjoinedEventsCount?: string | null; } - /** - * The layout parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {} - /** - * The OCR options for parsing documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig { - /** - * Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. - */ - enabled?: boolean | null; - /** - * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. - */ - enhancedDocumentElements?: string[] | null; - /** - * If true, will use native text instead of OCR text on pages containing native text. - */ - useNativeText?: boolean | null; - } - /** - * The OCR parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig { - /** - * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. - */ - enhancedDocumentElements?: string[] | null; - /** - * If true, will use native text instead of OCR text on pages containing native text. - */ - useNativeText?: boolean | null; - } /** * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -1671,10 +1672,6 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } - /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {} /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -1807,11 +1804,28 @@ export namespace discoveryengine_v1beta { /** * Configurations applied to digital parser. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig; + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** * Double list. @@ -2334,19 +2348,6 @@ export namespace discoveryengine_v1beta { */ mediaProgressPercentage?: number | null; } - /** - * The OCR parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig { - /** - * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. - */ - enhancedDocumentElements?: string[] | null; - /** - * If true, will use native text instead of OCR text on pages containing native text. - */ - useNativeText?: boolean | null; - } /** * Detailed page information. */ @@ -2638,6 +2639,10 @@ export namespace discoveryengine_v1beta { * A specification for configuring the behavior of content search. */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; + /** + * A list of data store specs to apply on a search call. + */ + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */ @@ -2725,7 +2730,7 @@ export namespace discoveryengine_v1beta { */ boost?: number | null; /** - * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) + * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */ condition?: string | null; } @@ -2766,6 +2771,10 @@ export namespace discoveryengine_v1beta { * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ numPreviousSegments?: number | null; + /** + * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`. + */ + returnExtractiveSegmentScore?: boolean | null; } /** * A specification for configuring snippets in a search response. @@ -2813,7 +2822,7 @@ export namespace discoveryengine_v1beta { */ modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary. + * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */ summaryResultCount?: number | null; } @@ -2831,10 +2840,19 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. + * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */ version?: string | null; } + /** + * A struct to define data stores to filter on in a search call. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. + */ + dataStore?: string | null; + } /** * The specification that uses customized query embedding vector to do semantic document retrieval. */ @@ -3249,7 +3267,7 @@ export namespace discoveryengine_v1beta { */ modelId?: string | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string | null; /** @@ -3298,10 +3316,6 @@ export namespace discoveryengine_v1beta { * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */ contentFreshnessCutoffDays?: number | null; - /** - * Specifies the content watched minutes threshold for demotion. - */ - contentWatchedMinutesThreshold?: number | null; /** * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */ @@ -3422,6 +3436,74 @@ export namespace discoveryengine_v1beta { */ input?: string | null; } + /** + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for SearchTuningService.TrainCustomModel method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest { + /** + * The desired location of errors incurred during the data ingestion and training. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + /** + * Cloud Storage training input. + */ + gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput; + /** + * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. + */ + modelType?: string | null; + } + /** + * Cloud Storage training data input. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput { + /** + * The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"\}` + */ + corpusDataPath?: string | null; + /** + * The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\} + */ + queryDataPath?: string | null; + /** + * Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. + */ + testDataPath?: string | null; + /** + * Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` + */ + trainDataPath?: string | null; + } + /** + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + /** + * A sample of errors encountered while processing the data. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. + */ + modelStatus?: string | null; + } /** * A transaction represents the entire purchase transaction. */ @@ -3714,10 +3796,6 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } - /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {} /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -3763,11 +3841,28 @@ export namespace discoveryengine_v1beta { /** * Configurations applied to digital parser. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; /** * Configurations applied to OCR parser. Currently it only applies to PDFs. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig; + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -4015,19 +4110,6 @@ export namespace discoveryengine_v1beta { */ unjoinedEventsCount?: string | null; } - /** - * The OCR parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig { - /** - * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. - */ - enhancedDocumentElements?: string[] | null; - /** - * If true, will use native text instead of OCR text on pages containing native text. - */ - useNativeText?: boolean | null; - } /** * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -5293,6 +5375,102 @@ export namespace discoveryengine_v1beta { ); } } + + /** + * Trains a custom model. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: StreamMethodOptions + ): GaxiosPromise; + trainCustomModel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options?: MethodOptions + ): GaxiosPromise; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + callback: BodyResponseCallback + ): void; + trainCustomModel( + callback: BodyResponseCallback + ): void; + trainCustomModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+dataStore}:trainCustomModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery @@ -5394,6 +5572,18 @@ export namespace discoveryengine_v1beta { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + extends StandardParameters { + /** + * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + */ + dataStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest; + } export class Resource$Projects$Locations$Collections$Datastores$Branches { context: APIRequestContext; @@ -8785,7 +8975,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -8800,14 +8990,14 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** @@ -13005,7 +13195,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -13020,14 +13210,14 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** @@ -17258,7 +17448,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -17273,14 +17463,14 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** From 0a0acce896d648437ed2676ea5923d10784e8e34 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:50 +0000 Subject: [PATCH 37/78] fix(displayvideo): update the API #### displayvideo:v2 The following keys were changed: - schemas.CreateSdfDownloadTaskRequest.properties.version.enumDeprecated - schemas.CreateSdfDownloadTaskRequest.properties.version.enumDescriptions - schemas.SdfConfig.properties.version.enumDeprecated - schemas.SdfConfig.properties.version.enumDescriptions - schemas.SdfDownloadTaskMetadata.properties.version.enumDeprecated - schemas.SdfDownloadTaskMetadata.properties.version.enumDescriptions - schemas.YoutubeAndPartnersBiddingStrategy.properties.value.description #### displayvideo:v3 The following keys were changed: - schemas.CreateSdfDownloadTaskRequest.properties.version.enumDeprecated - schemas.CreateSdfDownloadTaskRequest.properties.version.enumDescriptions - schemas.SdfConfig.properties.version.enumDeprecated - schemas.SdfConfig.properties.version.enumDescriptions - schemas.SdfDownloadTaskMetadata.properties.version.enumDeprecated - schemas.SdfDownloadTaskMetadata.properties.version.enumDescriptions - schemas.YoutubeAndPartnersBiddingStrategy.properties.value.description --- discovery/displayvideo-v2.json | 16 ++++++++-------- discovery/displayvideo-v3.json | 16 ++++++++-------- src/apis/displayvideo/v2.ts | 2 +- src/apis/displayvideo/v3.ts | 2 +- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/discovery/displayvideo-v2.json b/discovery/displayvideo-v2.json index 3fb656d0168..02ec3fd8ba6 100644 --- a/discovery/displayvideo-v2.json +++ b/discovery/displayvideo-v2.json @@ -9267,7 +9267,7 @@ } } }, - "revision": "20240222", + "revision": "20240307", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -12339,7 +12339,7 @@ true, true, true, - false, + true, false, false, false @@ -12357,7 +12357,7 @@ "SDF version 5.4", "SDF version 5.5", "SDF version 6", - "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version. Currently in beta. Only available for use by a subset of users." + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." ], "type": "string" } @@ -19822,7 +19822,7 @@ true, true, true, - false, + true, false, false, false @@ -19840,7 +19840,7 @@ "SDF version 5.4", "SDF version 5.5", "SDF version 6", - "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version. Currently in beta. Only available for use by a subset of users." + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." ], "type": "string" } @@ -19899,7 +19899,7 @@ true, true, true, - false, + true, false, false, false @@ -19917,7 +19917,7 @@ "SDF version 5.4", "SDF version 5.5", "SDF version 6", - "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version. Currently in beta. Only available for use by a subset of users." + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." ], "type": "string" } @@ -21428,7 +21428,7 @@ "type": "string" }, "value": { - "description": "The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.", + "description": "The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.", "format": "int64", "type": "string" } diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index 0adfc0d4f4a..a75c8fca882 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -9222,7 +9222,7 @@ } } }, - "revision": "20240222", + "revision": "20240307", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -12910,7 +12910,7 @@ true, true, true, - false, + true, false, false, false @@ -12928,7 +12928,7 @@ "SDF version 5.4", "SDF version 5.5", "SDF version 6", - "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version. Currently in beta. Only available for use by a subset of users." + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." ], "type": "string" } @@ -20532,7 +20532,7 @@ true, true, true, - false, + true, false, false, false @@ -20550,7 +20550,7 @@ "SDF version 5.4", "SDF version 5.5", "SDF version 6", - "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version. Currently in beta. Only available for use by a subset of users." + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." ], "type": "string" } @@ -20609,7 +20609,7 @@ true, true, true, - false, + true, false, false, false @@ -20627,7 +20627,7 @@ "SDF version 5.4", "SDF version 5.5", "SDF version 6", - "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version. Currently in beta. Only available for use by a subset of users." + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." ], "type": "string" } @@ -21964,7 +21964,7 @@ "type": "string" }, "value": { - "description": "The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.", + "description": "The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.", "format": "int64", "type": "string" } diff --git a/src/apis/displayvideo/v2.ts b/src/apis/displayvideo/v2.ts index fef4a5c4101..c77443580cf 100644 --- a/src/apis/displayvideo/v2.ts +++ b/src/apis/displayvideo/v2.ts @@ -5975,7 +5975,7 @@ export namespace displayvideo_v2 { */ type?: string | null; /** - * The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0. + * The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0. */ value?: string | null; } diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index f7b3635b6d1..f6d47955e2b 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -6193,7 +6193,7 @@ export namespace displayvideo_v3 { */ type?: string | null; /** - * The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0. + * The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0. */ value?: string | null; } From 37c56f8ad74b4f41e05500aa7c94fb025f5b8bdb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 38/78] feat(dlp): update the API #### dlp:v2 The following keys were added: - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.description - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.flatPath - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.httpMethod - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.id - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.parameterOrder - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.location - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.pattern - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.required - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.type - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.path - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.response.$ref - resources.organizations.resources.locations.resources.columnDataProfiles.methods.get.scopes - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.description - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.flatPath - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.httpMethod - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.id - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameterOrder - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.filter.description - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.filter.location - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.filter.type - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.orderBy.description - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.orderBy.location - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.orderBy.type - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageSize.format - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageSize.location - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageSize.type - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageToken.location - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageToken.type - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.location - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.pattern - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.required - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.type - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.path - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.response.$ref - resources.organizations.resources.locations.resources.columnDataProfiles.methods.list.scopes - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.description - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.flatPath - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.httpMethod - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.id - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.parameterOrder - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.location - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.pattern - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.required - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.type - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.path - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.response.$ref - resources.organizations.resources.locations.resources.projectDataProfiles.methods.get.scopes - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.description - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.flatPath - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.httpMethod - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.id - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameterOrder - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.filter.description - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.filter.location - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.filter.type - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.orderBy.description - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.orderBy.location - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.orderBy.type - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageSize.format - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageSize.location - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageSize.type - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageToken.location - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageToken.type - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.location - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.pattern - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.required - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.type - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.path - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.response.$ref - resources.organizations.resources.locations.resources.projectDataProfiles.methods.list.scopes - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.description - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.flatPath - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.httpMethod - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.id - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.parameterOrder - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.location - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.pattern - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.required - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.type - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.path - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.response.$ref - resources.organizations.resources.locations.resources.tableDataProfiles.methods.get.scopes - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.description - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.flatPath - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.httpMethod - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.id - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameterOrder - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.filter.description - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.filter.location - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.filter.type - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.orderBy.description - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.orderBy.location - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.orderBy.type - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageSize.format - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageSize.location - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageSize.type - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageToken.location - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageToken.type - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.location - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.pattern - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.required - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.type - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.path - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.response.$ref - resources.organizations.resources.locations.resources.tableDataProfiles.methods.list.scopes - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.description - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.flatPath - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.httpMethod - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.id - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.parameterOrder - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.description - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.location - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.required - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.parameters.name.type - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.path - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.response.$ref - resources.projects.resources.locations.resources.columnDataProfiles.methods.get.scopes - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.description - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.flatPath - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.httpMethod - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.id - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameterOrder - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.path - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.response.$ref - resources.projects.resources.locations.resources.columnDataProfiles.methods.list.scopes - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.description - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.flatPath - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.httpMethod - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.id - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.parameterOrder - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.description - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.location - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.required - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.parameters.name.type - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.path - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.response.$ref - resources.projects.resources.locations.resources.projectDataProfiles.methods.get.scopes - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.description - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.flatPath - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.httpMethod - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.id - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameterOrder - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.path - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.response.$ref - resources.projects.resources.locations.resources.projectDataProfiles.methods.list.scopes - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.description - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.flatPath - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.httpMethod - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.id - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.parameterOrder - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.description - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.location - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.required - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.parameters.name.type - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.path - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.response.$ref - resources.projects.resources.locations.resources.tableDataProfiles.methods.get.scopes - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.description - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.flatPath - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.httpMethod - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.id - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameterOrder - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.path - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.response.$ref - resources.projects.resources.locations.resources.tableDataProfiles.methods.list.scopes - schemas.GooglePrivacyDlpV2DataProfileConfigSnapshot.properties.inspectTemplateModifiedTime.description - schemas.GooglePrivacyDlpV2DataProfileConfigSnapshot.properties.inspectTemplateModifiedTime.format - schemas.GooglePrivacyDlpV2DataProfileConfigSnapshot.properties.inspectTemplateModifiedTime.type - schemas.GooglePrivacyDlpV2DataProfileConfigSnapshot.properties.inspectTemplateName.description - schemas.GooglePrivacyDlpV2DataProfileConfigSnapshot.properties.inspectTemplateName.type - schemas.GooglePrivacyDlpV2ListColumnDataProfilesResponse.description - schemas.GooglePrivacyDlpV2ListColumnDataProfilesResponse.id - schemas.GooglePrivacyDlpV2ListColumnDataProfilesResponse.properties.columnDataProfiles.description - schemas.GooglePrivacyDlpV2ListColumnDataProfilesResponse.properties.columnDataProfiles.items.$ref - schemas.GooglePrivacyDlpV2ListColumnDataProfilesResponse.properties.columnDataProfiles.type - schemas.GooglePrivacyDlpV2ListColumnDataProfilesResponse.properties.nextPageToken.description - schemas.GooglePrivacyDlpV2ListColumnDataProfilesResponse.properties.nextPageToken.type - schemas.GooglePrivacyDlpV2ListColumnDataProfilesResponse.type - schemas.GooglePrivacyDlpV2ListProjectDataProfilesResponse.description - schemas.GooglePrivacyDlpV2ListProjectDataProfilesResponse.id - schemas.GooglePrivacyDlpV2ListProjectDataProfilesResponse.properties.nextPageToken.description - schemas.GooglePrivacyDlpV2ListProjectDataProfilesResponse.properties.nextPageToken.type - schemas.GooglePrivacyDlpV2ListProjectDataProfilesResponse.properties.projectDataProfiles.description - schemas.GooglePrivacyDlpV2ListProjectDataProfilesResponse.properties.projectDataProfiles.items.$ref - schemas.GooglePrivacyDlpV2ListProjectDataProfilesResponse.properties.projectDataProfiles.type - schemas.GooglePrivacyDlpV2ListProjectDataProfilesResponse.type - schemas.GooglePrivacyDlpV2ListTableDataProfilesResponse.description - schemas.GooglePrivacyDlpV2ListTableDataProfilesResponse.id - schemas.GooglePrivacyDlpV2ListTableDataProfilesResponse.properties.nextPageToken.description - schemas.GooglePrivacyDlpV2ListTableDataProfilesResponse.properties.nextPageToken.type - schemas.GooglePrivacyDlpV2ListTableDataProfilesResponse.properties.tableDataProfiles.description - schemas.GooglePrivacyDlpV2ListTableDataProfilesResponse.properties.tableDataProfiles.items.$ref - schemas.GooglePrivacyDlpV2ListTableDataProfilesResponse.properties.tableDataProfiles.type - schemas.GooglePrivacyDlpV2ListTableDataProfilesResponse.type - schemas.GooglePrivacyDlpV2ProjectDataProfile.description - schemas.GooglePrivacyDlpV2ProjectDataProfile.id - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.dataRiskLevel.$ref - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.dataRiskLevel.description - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.name.description - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.name.type - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.profileLastGenerated.description - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.profileLastGenerated.format - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.profileLastGenerated.type - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.profileStatus.$ref - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.profileStatus.description - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.projectId.description - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.projectId.type - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.sensitivityScore.$ref - schemas.GooglePrivacyDlpV2ProjectDataProfile.properties.sensitivityScore.description - schemas.GooglePrivacyDlpV2ProjectDataProfile.type The following keys were changed: - documentationLink - resources.infoTypes.methods.list.description - resources.locations.resources.infoTypes.methods.list.description - resources.organizations.resources.deidentifyTemplates.methods.create.description - resources.organizations.resources.deidentifyTemplates.methods.create.parameters.parent.description - resources.organizations.resources.deidentifyTemplates.methods.delete.description - resources.organizations.resources.deidentifyTemplates.methods.get.description - resources.organizations.resources.deidentifyTemplates.methods.list.description - resources.organizations.resources.deidentifyTemplates.methods.list.parameters.parent.description - resources.organizations.resources.deidentifyTemplates.methods.patch.description - resources.organizations.resources.inspectTemplates.methods.create.description - resources.organizations.resources.inspectTemplates.methods.create.parameters.parent.description - resources.organizations.resources.inspectTemplates.methods.delete.description - resources.organizations.resources.inspectTemplates.methods.get.description - resources.organizations.resources.inspectTemplates.methods.list.description - resources.organizations.resources.inspectTemplates.methods.list.parameters.parent.description - resources.organizations.resources.inspectTemplates.methods.patch.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.create.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.delete.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.get.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.list.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.patch.description - resources.organizations.resources.locations.resources.dlpJobs.methods.list.description - resources.organizations.resources.locations.resources.dlpJobs.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.create.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.delete.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.get.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.list.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.patch.description - resources.organizations.resources.locations.resources.jobTriggers.methods.create.description - resources.organizations.resources.locations.resources.jobTriggers.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.jobTriggers.methods.delete.description - resources.organizations.resources.locations.resources.jobTriggers.methods.get.description - resources.organizations.resources.locations.resources.jobTriggers.methods.list.description - resources.organizations.resources.locations.resources.jobTriggers.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.jobTriggers.methods.patch.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.create.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.delete.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.get.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.list.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.patch.description - resources.organizations.resources.storedInfoTypes.methods.create.description - resources.organizations.resources.storedInfoTypes.methods.create.parameters.parent.description - resources.organizations.resources.storedInfoTypes.methods.delete.description - resources.organizations.resources.storedInfoTypes.methods.get.description - resources.organizations.resources.storedInfoTypes.methods.list.description - resources.organizations.resources.storedInfoTypes.methods.list.parameters.parent.description - resources.organizations.resources.storedInfoTypes.methods.patch.description - resources.projects.resources.content.methods.deidentify.description - resources.projects.resources.content.methods.deidentify.parameters.parent.description - resources.projects.resources.content.methods.inspect.description - resources.projects.resources.content.methods.inspect.parameters.parent.description - resources.projects.resources.content.methods.reidentify.description - resources.projects.resources.content.methods.reidentify.parameters.parent.description - resources.projects.resources.deidentifyTemplates.methods.create.description - resources.projects.resources.deidentifyTemplates.methods.create.parameters.parent.description - resources.projects.resources.deidentifyTemplates.methods.delete.description - resources.projects.resources.deidentifyTemplates.methods.get.description - resources.projects.resources.deidentifyTemplates.methods.list.description - resources.projects.resources.deidentifyTemplates.methods.list.parameters.parent.description - resources.projects.resources.deidentifyTemplates.methods.patch.description - resources.projects.resources.dlpJobs.methods.cancel.description - resources.projects.resources.dlpJobs.methods.create.description - resources.projects.resources.dlpJobs.methods.create.parameters.parent.description - resources.projects.resources.dlpJobs.methods.delete.description - resources.projects.resources.dlpJobs.methods.get.description - resources.projects.resources.dlpJobs.methods.list.description - resources.projects.resources.dlpJobs.methods.list.parameters.parent.description - resources.projects.resources.image.methods.redact.description - resources.projects.resources.image.methods.redact.parameters.parent.description - resources.projects.resources.inspectTemplates.methods.create.description - resources.projects.resources.inspectTemplates.methods.create.parameters.parent.description - resources.projects.resources.inspectTemplates.methods.delete.description - resources.projects.resources.inspectTemplates.methods.get.description - resources.projects.resources.inspectTemplates.methods.list.description - resources.projects.resources.inspectTemplates.methods.list.parameters.parent.description - resources.projects.resources.inspectTemplates.methods.patch.description - resources.projects.resources.jobTriggers.methods.create.description - resources.projects.resources.jobTriggers.methods.create.parameters.parent.description - resources.projects.resources.jobTriggers.methods.delete.description - resources.projects.resources.jobTriggers.methods.get.description - resources.projects.resources.jobTriggers.methods.list.description - resources.projects.resources.jobTriggers.methods.list.parameters.parent.description - resources.projects.resources.jobTriggers.methods.patch.description - resources.projects.resources.locations.resources.content.methods.deidentify.description - resources.projects.resources.locations.resources.content.methods.deidentify.parameters.parent.description - resources.projects.resources.locations.resources.content.methods.inspect.description - resources.projects.resources.locations.resources.content.methods.inspect.parameters.parent.description - resources.projects.resources.locations.resources.content.methods.reidentify.description - resources.projects.resources.locations.resources.content.methods.reidentify.parameters.parent.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.create.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.delete.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.get.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.list.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.patch.description - resources.projects.resources.locations.resources.dlpJobs.methods.cancel.description - resources.projects.resources.locations.resources.dlpJobs.methods.create.description - resources.projects.resources.locations.resources.dlpJobs.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.dlpJobs.methods.delete.description - resources.projects.resources.locations.resources.dlpJobs.methods.get.description - resources.projects.resources.locations.resources.dlpJobs.methods.list.description - resources.projects.resources.locations.resources.dlpJobs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.image.methods.redact.description - resources.projects.resources.locations.resources.image.methods.redact.parameters.parent.description - resources.projects.resources.locations.resources.inspectTemplates.methods.create.description - resources.projects.resources.locations.resources.inspectTemplates.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.inspectTemplates.methods.delete.description - resources.projects.resources.locations.resources.inspectTemplates.methods.get.description - resources.projects.resources.locations.resources.inspectTemplates.methods.list.description - resources.projects.resources.locations.resources.inspectTemplates.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.inspectTemplates.methods.patch.description - resources.projects.resources.locations.resources.jobTriggers.methods.create.description - resources.projects.resources.locations.resources.jobTriggers.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.jobTriggers.methods.delete.description - resources.projects.resources.locations.resources.jobTriggers.methods.get.description - resources.projects.resources.locations.resources.jobTriggers.methods.list.description - resources.projects.resources.locations.resources.jobTriggers.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.jobTriggers.methods.patch.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.create.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.delete.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.get.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.list.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.patch.description - resources.projects.resources.storedInfoTypes.methods.create.description - resources.projects.resources.storedInfoTypes.methods.create.parameters.parent.description - resources.projects.resources.storedInfoTypes.methods.delete.description - resources.projects.resources.storedInfoTypes.methods.get.description - resources.projects.resources.storedInfoTypes.methods.list.description - resources.projects.resources.storedInfoTypes.methods.list.parameters.parent.description - resources.projects.resources.storedInfoTypes.methods.patch.description - schemas.GooglePrivacyDlpV2Action.description - schemas.GooglePrivacyDlpV2BigQueryOptions.properties.rowsLimitPercent.description - schemas.GooglePrivacyDlpV2BucketingConfig.description - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.bytesLimitPerFile.description - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.bytesLimitPerFilePercent.description - schemas.GooglePrivacyDlpV2CloudStoragePath.properties.path.description - schemas.GooglePrivacyDlpV2ColumnDataProfile.properties.datasetProjectId.description - schemas.GooglePrivacyDlpV2ColumnDataProfile.properties.tableFullResource.description - schemas.GooglePrivacyDlpV2ContentItem.properties.table.description - schemas.GooglePrivacyDlpV2CryptoHashConfig.description - schemas.GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig.description - schemas.GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig.properties.surrogateInfoType.description - schemas.GooglePrivacyDlpV2DataProfileJobConfig.description - schemas.GooglePrivacyDlpV2DataProfileJobConfig.properties.inspectTemplates.description - schemas.GooglePrivacyDlpV2DateShiftConfig.description - schemas.GooglePrivacyDlpV2DeidentifyTemplate.description - schemas.GooglePrivacyDlpV2Dictionary.description - schemas.GooglePrivacyDlpV2DiscoveryConfig.description - schemas.GooglePrivacyDlpV2DiscoveryConfig.properties.inspectTemplates.description - schemas.GooglePrivacyDlpV2FixedSizeBucketingConfig.description - schemas.GooglePrivacyDlpV2HotwordRule.properties.proximity.description - schemas.GooglePrivacyDlpV2InfoType.properties.name.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.customInfoTypes.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.infoTypes.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.minLikelihood.description - schemas.GooglePrivacyDlpV2InspectTemplate.description - schemas.GooglePrivacyDlpV2JobTrigger.description - schemas.GooglePrivacyDlpV2KmsWrappedCryptoKey.description - schemas.GooglePrivacyDlpV2LargeCustomDictionaryConfig.description - schemas.GooglePrivacyDlpV2Proximity.properties.windowBefore.description - schemas.GooglePrivacyDlpV2PublishToPubSub.description - schemas.GooglePrivacyDlpV2RecordKey.properties.datastoreKey.description - schemas.GooglePrivacyDlpV2ReplaceDictionaryConfig.properties.wordList.description - schemas.GooglePrivacyDlpV2RiskAnalysisJobConfig.description - schemas.GooglePrivacyDlpV2StoredInfoTypeConfig.description - schemas.GooglePrivacyDlpV2SurrogateType.description - schemas.GooglePrivacyDlpV2Table.description - schemas.GooglePrivacyDlpV2TableDataProfile.properties.datasetId.description - schemas.GooglePrivacyDlpV2TableDataProfile.properties.datasetLocation.description - schemas.GooglePrivacyDlpV2TableDataProfile.properties.datasetProjectId.description - schemas.GooglePrivacyDlpV2TableDataProfile.properties.fullResource.description - schemas.GooglePrivacyDlpV2TableDataProfile.properties.tableId.description - schemas.GooglePrivacyDlpV2TimespanConfig.properties.timestampField.description --- discovery/dlp-v2.json | 913 ++++++++++++++---- src/apis/dlp/v2.ts | 2113 ++++++++++++++++++++++++++++++++++------- 2 files changed, 2519 insertions(+), 507 deletions(-) diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index beb58a2c412..81c495ebb97 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -14,7 +14,7 @@ "canonicalName": "DLP", "description": "Discover and protect your sensitive data. A fully managed service designed to help you discover, classify, and protect your valuable data assets with ease.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/dlp/docs/", + "documentationLink": "https://cloud.google.com/sensitive-data-protection/docs/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -108,7 +108,7 @@ "infoTypes": { "methods": { "list": { - "description": "Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.", + "description": "Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", "flatPath": "v2/infoTypes", "httpMethod": "GET", "id": "dlp.infoTypes.list", @@ -150,7 +150,7 @@ "infoTypes": { "methods": { "list": { - "description": "Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.", + "description": "Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", "flatPath": "v2/locations/{locationsId}/infoTypes", "httpMethod": "GET", "id": "dlp.locations.infoTypes.list", @@ -198,7 +198,7 @@ "deidentifyTemplates": { "methods": { "create": { - "description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.organizations.deidentifyTemplates.create", @@ -207,7 +207,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -226,7 +226,7 @@ ] }, "delete": { - "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.deidentifyTemplates.delete", @@ -251,7 +251,7 @@ ] }, "get": { - "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.deidentifyTemplates.get", @@ -276,7 +276,7 @@ ] }, "list": { - "description": "Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.organizations.deidentifyTemplates.list", @@ -306,7 +306,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -322,7 +322,7 @@ ] }, "patch": { - "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.deidentifyTemplates.patch", @@ -354,7 +354,7 @@ "inspectTemplates": { "methods": { "create": { - "description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.organizations.inspectTemplates.create", @@ -363,7 +363,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -382,7 +382,7 @@ ] }, "delete": { - "description": "Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.inspectTemplates.delete", @@ -407,7 +407,7 @@ ] }, "get": { - "description": "Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.inspectTemplates.get", @@ -432,7 +432,7 @@ ] }, "list": { - "description": "Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.organizations.inspectTemplates.list", @@ -462,7 +462,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -478,7 +478,7 @@ ] }, "patch": { - "description": "Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.inspectTemplates.patch", @@ -509,10 +509,85 @@ }, "locations": { "resources": { + "columnDataProfiles": { + "methods": { + "get": { + "description": "Gets a column data profile.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}", + "httpMethod": "GET", + "id": "dlp.organizations.locations.columnDataProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name, for example `organizations/12345/locations/us/columnDataProfiles/53234423`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/columnDataProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GooglePrivacyDlpV2ColumnDataProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data profiles for an organization.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles", + "httpMethod": "GET", + "id": "dlp.organizations.locations.columnDataProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `table_data_profile_name` - The name of the related table data profile. - `project_id` - The Google Cloud project ID. (REQUIRED) - `dataset_id` - The BigQuery dataset ID. (REQUIRED) - `table_id` - The BigQuery table ID. (REQUIRED) - `field_id` - The ID of the BigQuery field. - `info_type` - The infotype detected in the resource. - `sensitivity_level` - HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data. - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token to continue retrieval.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or projects/project-id/locations/asia.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/columnDataProfiles", + "response": { + "$ref": "GooglePrivacyDlpV2ListColumnDataProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "deidentifyTemplates": { "methods": { "create": { - "description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.organizations.locations.deidentifyTemplates.create", @@ -521,7 +596,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -540,7 +615,7 @@ ] }, "delete": { - "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.deidentifyTemplates.delete", @@ -565,7 +640,7 @@ ] }, "get": { - "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.deidentifyTemplates.get", @@ -590,7 +665,7 @@ ] }, "list": { - "description": "Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.organizations.locations.deidentifyTemplates.list", @@ -620,7 +695,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -636,7 +711,7 @@ ] }, "patch": { - "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.deidentifyTemplates.patch", @@ -819,7 +894,7 @@ "dlpJobs": { "methods": { "list": { - "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs", "httpMethod": "GET", "id": "dlp.organizations.locations.dlpJobs.list", @@ -854,7 +929,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -889,7 +964,7 @@ "inspectTemplates": { "methods": { "create": { - "description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.organizations.locations.inspectTemplates.create", @@ -898,7 +973,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -917,7 +992,7 @@ ] }, "delete": { - "description": "Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.inspectTemplates.delete", @@ -942,7 +1017,7 @@ ] }, "get": { - "description": "Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.inspectTemplates.get", @@ -967,7 +1042,7 @@ ] }, "list": { - "description": "Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.organizations.locations.inspectTemplates.list", @@ -997,7 +1072,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1013,7 +1088,7 @@ ] }, "patch": { - "description": "Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.inspectTemplates.patch", @@ -1045,7 +1120,7 @@ "jobTriggers": { "methods": { "create": { - "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers", "httpMethod": "POST", "id": "dlp.organizations.locations.jobTriggers.create", @@ -1054,7 +1129,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1073,7 +1148,7 @@ ] }, "delete": { - "description": "Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.jobTriggers.delete", @@ -1098,7 +1173,7 @@ ] }, "get": { - "description": "Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "GET", "id": "dlp.organizations.locations.jobTriggers.get", @@ -1123,7 +1198,7 @@ ] }, "list": { - "description": "Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers", "httpMethod": "GET", "id": "dlp.organizations.locations.jobTriggers.list", @@ -1158,7 +1233,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1189,7 +1264,7 @@ ] }, "patch": { - "description": "Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.jobTriggers.patch", @@ -1218,10 +1293,85 @@ } } }, + "projectDataProfiles": { + "methods": { + "get": { + "description": "Gets a project data profile.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}", + "httpMethod": "GET", + "id": "dlp.organizations.locations.projectDataProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name, for example `organizations/12345/locations/us/projectDataProfiles/53234423`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/projectDataProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GooglePrivacyDlpV2ProjectDataProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data profiles for an organization.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles", + "httpMethod": "GET", + "id": "dlp.organizations.locations.projectDataProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: GCP project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token to continue retrieval.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. organizations/{org_id}/locations/{loc_id}", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/projectDataProfiles", + "response": { + "$ref": "GooglePrivacyDlpV2ListProjectDataProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "storedInfoTypes": { "methods": { "create": { - "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.organizations.locations.storedInfoTypes.create", @@ -1230,7 +1380,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1249,7 +1399,7 @@ ] }, "delete": { - "description": "Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.storedInfoTypes.delete", @@ -1274,7 +1424,7 @@ ] }, "get": { - "description": "Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.storedInfoTypes.get", @@ -1299,7 +1449,7 @@ ] }, "list": { - "description": "Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.organizations.locations.storedInfoTypes.list", @@ -1329,7 +1479,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1345,7 +1495,7 @@ ] }, "patch": { - "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.storedInfoTypes.patch", @@ -1373,13 +1523,88 @@ ] } } + }, + "tableDataProfiles": { + "methods": { + "get": { + "description": "Gets a table data profile.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}", + "httpMethod": "GET", + "id": "dlp.organizations.locations.tableDataProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name, for example `organizations/12345/locations/us/tableDataProfiles/53234423`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/tableDataProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GooglePrivacyDlpV2TableDataProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data profiles for an organization.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles", + "httpMethod": "GET", + "id": "dlp.organizations.locations.tableDataProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The GCP project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND resource_visibility = PUBLIC The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The GCP project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token to continue retrieval.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/tableDataProfiles", + "response": { + "$ref": "GooglePrivacyDlpV2ListTableDataProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, "storedInfoTypes": { "methods": { "create": { - "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.organizations.storedInfoTypes.create", @@ -1388,7 +1613,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1407,7 +1632,7 @@ ] }, "delete": { - "description": "Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.organizations.storedInfoTypes.delete", @@ -1432,7 +1657,7 @@ ] }, "get": { - "description": "Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.organizations.storedInfoTypes.get", @@ -1457,7 +1682,7 @@ ] }, "list": { - "description": "Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.organizations.storedInfoTypes.list", @@ -1487,7 +1712,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1503,7 +1728,7 @@ ] }, "patch": { - "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.organizations.storedInfoTypes.patch", @@ -1539,7 +1764,7 @@ "content": { "methods": { "deidentify": { - "description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", + "description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/content:deidentify", "httpMethod": "POST", "id": "dlp.projects.content.deidentify", @@ -1548,7 +1773,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1567,7 +1792,7 @@ ] }, "inspect": { - "description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,", + "description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,", "flatPath": "v2/projects/{projectsId}/content:inspect", "httpMethod": "POST", "id": "dlp.projects.content.inspect", @@ -1576,7 +1801,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1595,7 +1820,7 @@ ] }, "reidentify": { - "description": "Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", + "description": "Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", "flatPath": "v2/projects/{projectsId}/content:reidentify", "httpMethod": "POST", "id": "dlp.projects.content.reidentify", @@ -1604,7 +1829,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1627,7 +1852,7 @@ "deidentifyTemplates": { "methods": { "create": { - "description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.projects.deidentifyTemplates.create", @@ -1636,7 +1861,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1655,7 +1880,7 @@ ] }, "delete": { - "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.deidentifyTemplates.delete", @@ -1680,7 +1905,7 @@ ] }, "get": { - "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.deidentifyTemplates.get", @@ -1705,7 +1930,7 @@ ] }, "list": { - "description": "Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.projects.deidentifyTemplates.list", @@ -1735,7 +1960,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1751,7 +1976,7 @@ ] }, "patch": { - "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.deidentifyTemplates.patch", @@ -1783,7 +2008,7 @@ "dlpJobs": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel", "httpMethod": "POST", "id": "dlp.projects.dlpJobs.cancel", @@ -1811,7 +2036,7 @@ ] }, "create": { - "description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", + "description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/dlpJobs", "httpMethod": "POST", "id": "dlp.projects.dlpJobs.create", @@ -1820,7 +2045,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1839,7 +2064,7 @@ ] }, "delete": { - "description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}", "httpMethod": "DELETE", "id": "dlp.projects.dlpJobs.delete", @@ -1864,7 +2089,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}", "httpMethod": "GET", "id": "dlp.projects.dlpJobs.get", @@ -1889,7 +2114,7 @@ ] }, "list": { - "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs", "httpMethod": "GET", "id": "dlp.projects.dlpJobs.list", @@ -1924,7 +2149,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1959,7 +2184,7 @@ "image": { "methods": { "redact": { - "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", + "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/image:redact", "httpMethod": "POST", "id": "dlp.projects.image.redact", @@ -1968,7 +2193,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1991,7 +2216,7 @@ "inspectTemplates": { "methods": { "create": { - "description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.projects.inspectTemplates.create", @@ -2000,7 +2225,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2019,7 +2244,7 @@ ] }, "delete": { - "description": "Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.inspectTemplates.delete", @@ -2044,7 +2269,7 @@ ] }, "get": { - "description": "Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.inspectTemplates.get", @@ -2069,7 +2294,7 @@ ] }, "list": { - "description": "Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.projects.inspectTemplates.list", @@ -2099,7 +2324,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2115,7 +2340,7 @@ ] }, "patch": { - "description": "Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.inspectTemplates.patch", @@ -2175,7 +2400,7 @@ ] }, "create": { - "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers", "httpMethod": "POST", "id": "dlp.projects.jobTriggers.create", @@ -2184,7 +2409,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2203,7 +2428,7 @@ ] }, "delete": { - "description": "Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "DELETE", "id": "dlp.projects.jobTriggers.delete", @@ -2228,7 +2453,7 @@ ] }, "get": { - "description": "Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "GET", "id": "dlp.projects.jobTriggers.get", @@ -2253,7 +2478,7 @@ ] }, "list": { - "description": "Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers", "httpMethod": "GET", "id": "dlp.projects.jobTriggers.list", @@ -2288,7 +2513,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2319,7 +2544,7 @@ ] }, "patch": { - "description": "Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "PATCH", "id": "dlp.projects.jobTriggers.patch", @@ -2350,10 +2575,85 @@ }, "locations": { "resources": { + "columnDataProfiles": { + "methods": { + "get": { + "description": "Gets a column data profile.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}", + "httpMethod": "GET", + "id": "dlp.projects.locations.columnDataProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name, for example `organizations/12345/locations/us/columnDataProfiles/53234423`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/columnDataProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GooglePrivacyDlpV2ColumnDataProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data profiles for an organization.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles", + "httpMethod": "GET", + "id": "dlp.projects.locations.columnDataProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `table_data_profile_name` - The name of the related table data profile. - `project_id` - The Google Cloud project ID. (REQUIRED) - `dataset_id` - The BigQuery dataset ID. (REQUIRED) - `table_id` - The BigQuery table ID. (REQUIRED) - `field_id` - The ID of the BigQuery field. - `info_type` - The infotype detected in the resource. - `sensitivity_level` - HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data. - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token to continue retrieval.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or projects/project-id/locations/asia.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/columnDataProfiles", + "response": { + "$ref": "GooglePrivacyDlpV2ListColumnDataProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "content": { "methods": { "deidentify": { - "description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", + "description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:deidentify", "httpMethod": "POST", "id": "dlp.projects.locations.content.deidentify", @@ -2362,7 +2662,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2381,7 +2681,7 @@ ] }, "inspect": { - "description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,", + "description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:inspect", "httpMethod": "POST", "id": "dlp.projects.locations.content.inspect", @@ -2390,7 +2690,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2409,7 +2709,7 @@ ] }, "reidentify": { - "description": "Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", + "description": "Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:reidentify", "httpMethod": "POST", "id": "dlp.projects.locations.content.reidentify", @@ -2418,7 +2718,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2441,7 +2741,7 @@ "deidentifyTemplates": { "methods": { "create": { - "description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.projects.locations.deidentifyTemplates.create", @@ -2450,7 +2750,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2469,7 +2769,7 @@ ] }, "delete": { - "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.deidentifyTemplates.delete", @@ -2494,7 +2794,7 @@ ] }, "get": { - "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.locations.deidentifyTemplates.get", @@ -2519,7 +2819,7 @@ ] }, "list": { - "description": "Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.projects.locations.deidentifyTemplates.list", @@ -2549,7 +2849,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2565,7 +2865,7 @@ ] }, "patch": { - "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", + "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.deidentifyTemplates.patch", @@ -2748,7 +3048,7 @@ "dlpJobs": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.cancel", @@ -2776,7 +3076,7 @@ ] }, "create": { - "description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", + "description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.create", @@ -2785,7 +3085,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2804,7 +3104,7 @@ ] }, "delete": { - "description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.dlpJobs.delete", @@ -2857,7 +3157,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}", "httpMethod": "GET", "id": "dlp.projects.locations.dlpJobs.get", @@ -2910,7 +3210,7 @@ ] }, "list": { - "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs", "httpMethod": "GET", "id": "dlp.projects.locations.dlpJobs.list", @@ -2945,7 +3245,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2980,7 +3280,7 @@ "image": { "methods": { "redact": { - "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", + "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/image:redact", "httpMethod": "POST", "id": "dlp.projects.locations.image.redact", @@ -2989,7 +3289,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3012,7 +3312,7 @@ "inspectTemplates": { "methods": { "create": { - "description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.projects.locations.inspectTemplates.create", @@ -3021,7 +3321,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3040,7 +3340,7 @@ ] }, "delete": { - "description": "Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.inspectTemplates.delete", @@ -3065,7 +3365,7 @@ ] }, "get": { - "description": "Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.locations.inspectTemplates.get", @@ -3090,7 +3390,7 @@ ] }, "list": { - "description": "Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.projects.locations.inspectTemplates.list", @@ -3120,7 +3420,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3136,7 +3436,7 @@ ] }, "patch": { - "description": "Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.inspectTemplates.patch", @@ -3196,7 +3496,7 @@ ] }, "create": { - "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers", "httpMethod": "POST", "id": "dlp.projects.locations.jobTriggers.create", @@ -3205,7 +3505,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3224,7 +3524,7 @@ ] }, "delete": { - "description": "Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.jobTriggers.delete", @@ -3249,7 +3549,7 @@ ] }, "get": { - "description": "Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "GET", "id": "dlp.projects.locations.jobTriggers.get", @@ -3302,7 +3602,7 @@ ] }, "list": { - "description": "Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers", "httpMethod": "GET", "id": "dlp.projects.locations.jobTriggers.list", @@ -3337,7 +3637,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3368,7 +3668,7 @@ ] }, "patch": { - "description": "Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.jobTriggers.patch", @@ -3397,10 +3697,85 @@ } } }, + "projectDataProfiles": { + "methods": { + "get": { + "description": "Gets a project data profile.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}", + "httpMethod": "GET", + "id": "dlp.projects.locations.projectDataProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name, for example `organizations/12345/locations/us/projectDataProfiles/53234423`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/projectDataProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GooglePrivacyDlpV2ProjectDataProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data profiles for an organization.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles", + "httpMethod": "GET", + "id": "dlp.projects.locations.projectDataProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: GCP project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token to continue retrieval.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. organizations/{org_id}/locations/{loc_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/projectDataProfiles", + "response": { + "$ref": "GooglePrivacyDlpV2ListProjectDataProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "storedInfoTypes": { "methods": { "create": { - "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.projects.locations.storedInfoTypes.create", @@ -3409,7 +3784,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3428,7 +3803,7 @@ ] }, "delete": { - "description": "Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.storedInfoTypes.delete", @@ -3453,7 +3828,7 @@ ] }, "get": { - "description": "Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.projects.locations.storedInfoTypes.get", @@ -3478,7 +3853,7 @@ ] }, "list": { - "description": "Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.projects.locations.storedInfoTypes.list", @@ -3508,7 +3883,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3524,7 +3899,7 @@ ] }, "patch": { - "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.storedInfoTypes.patch", @@ -3552,13 +3927,88 @@ ] } } + }, + "tableDataProfiles": { + "methods": { + "get": { + "description": "Gets a table data profile.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}", + "httpMethod": "GET", + "id": "dlp.projects.locations.tableDataProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name, for example `organizations/12345/locations/us/tableDataProfiles/53234423`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tableDataProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GooglePrivacyDlpV2TableDataProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data profiles for an organization.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles", + "httpMethod": "GET", + "id": "dlp.projects.locations.tableDataProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The GCP project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND resource_visibility = PUBLIC The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The GCP project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token to continue retrieval.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/tableDataProfiles", + "response": { + "$ref": "GooglePrivacyDlpV2ListTableDataProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, "storedInfoTypes": { "methods": { "create": { - "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.projects.storedInfoTypes.create", @@ -3567,7 +4017,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -3586,7 +4036,7 @@ ] }, "delete": { - "description": "Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.projects.storedInfoTypes.delete", @@ -3611,7 +4061,7 @@ ] }, "get": { - "description": "Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.projects.storedInfoTypes.get", @@ -3636,7 +4086,7 @@ ] }, "list": { - "description": "Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.projects.storedInfoTypes.list", @@ -3666,7 +4116,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -3682,7 +4132,7 @@ ] }, "patch": { - "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", + "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.projects.storedInfoTypes.patch", @@ -3714,11 +4164,11 @@ } } }, - "revision": "20240212", + "revision": "20240303", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { - "description": "A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.", + "description": "A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.", "id": "GooglePrivacyDlpV2Action", "properties": { "deidentify": { @@ -3937,7 +4387,7 @@ "type": "string" }, "rowsLimitPercent": { - "description": "Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/dlp/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead.", + "description": "Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead.", "format": "int32", "type": "integer" }, @@ -4096,7 +4546,7 @@ "type": "object" }, "GooglePrivacyDlpV2BucketingConfig": { - "description": "Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.", + "description": "Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more.", "id": "GooglePrivacyDlpV2BucketingConfig", "properties": { "buckets": { @@ -4296,12 +4746,12 @@ "id": "GooglePrivacyDlpV2CloudStorageOptions", "properties": { "bytesLimitPerFile": { - "description": "Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/dlp/docs/supported-file-types#max-byte-size-per-file).", + "description": "Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).", "format": "int64", "type": "string" }, "bytesLimitPerFilePercent": { - "description": "Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/dlp/docs/supported-file-types#max-byte-size-per-file).", + "description": "Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).", "format": "int32", "type": "integer" }, @@ -4369,7 +4819,7 @@ "id": "GooglePrivacyDlpV2CloudStoragePath", "properties": { "path": { - "description": "A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt", + "description": "A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`", "type": "string" } }, @@ -4485,7 +4935,7 @@ "type": "string" }, "datasetProjectId": { - "description": "The Google Cloud project ID that owns the BigQuery dataset.", + "description": "The Google Cloud project ID that owns the profiled resource.", "type": "string" }, "estimatedNullPercentage": { @@ -4582,7 +5032,7 @@ "type": "string" }, "tableFullResource": { - "description": "The resource name of the table this column is within.", + "description": "The resource name of the resource this column is within.", "type": "string" }, "tableId": { @@ -4691,7 +5141,7 @@ }, "table": { "$ref": "GooglePrivacyDlpV2Table", - "description": "Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more." + "description": "Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more." }, "value": { "description": "String data to inspect or redact.", @@ -4870,7 +5320,7 @@ "type": "object" }, "GooglePrivacyDlpV2CryptoHashConfig": { - "description": "Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/dlp/docs/pseudonymization to learn more.", + "description": "Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more.", "id": "GooglePrivacyDlpV2CryptoHashConfig", "properties": { "cryptoKey": { @@ -4900,7 +5350,7 @@ "type": "object" }, "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig": { - "description": "Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity.", + "description": "Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity.", "id": "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig", "properties": { "commonAlphabet": { @@ -4940,7 +5390,7 @@ }, "surrogateInfoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE" + "description": "The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE" } }, "type": "object" @@ -5061,12 +5511,21 @@ "inspectConfig": { "$ref": "GooglePrivacyDlpV2InspectConfig", "description": "A copy of the inspection config used to generate this profile. This is a copy of the inspect_template specified in `DataProfileJobConfig`." + }, + "inspectTemplateModifiedTime": { + "description": "Timestamp when the template was modified", + "format": "google-datetime", + "type": "string" + }, + "inspectTemplateName": { + "description": "Name of the inspection template used to generate this profile", + "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2DataProfileJobConfig": { - "description": "Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/dlp/docs/data-profiles#retention).", + "description": "Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).", "id": "GooglePrivacyDlpV2DataProfileJobConfig", "properties": { "dataProfileActions": { @@ -5077,7 +5536,7 @@ "type": "array" }, "inspectTemplates": { - "description": "Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data-residency.", + "description": "Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.", "items": { "type": "string" }, @@ -5213,7 +5672,7 @@ "type": "object" }, "GooglePrivacyDlpV2DateShiftConfig": { - "description": "Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting to learn more.", + "description": "Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more.", "id": "GooglePrivacyDlpV2DateShiftConfig", "properties": { "context": { @@ -5439,7 +5898,7 @@ "type": "object" }, "GooglePrivacyDlpV2DeidentifyTemplate": { - "description": "DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.", + "description": "DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.", "id": "GooglePrivacyDlpV2DeidentifyTemplate", "properties": { "createTime": { @@ -5578,7 +6037,7 @@ "type": "object" }, "GooglePrivacyDlpV2Dictionary": { - "description": "Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\", \"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word \"jen\" will match the first three letters of the text \"jen123\" but will return no matches for \"jennifer\". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API.", + "description": "Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\", \"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word \"jen\" will match the first three letters of the text \"jen123\" but will return no matches for \"jennifer\". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API.", "id": "GooglePrivacyDlpV2Dictionary", "properties": { "cloudStoragePath": { @@ -5648,7 +6107,7 @@ "type": "object" }, "GooglePrivacyDlpV2DiscoveryConfig": { - "description": "Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/dlp/docs/data-profiles#retention).", + "description": "Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).", "id": "GooglePrivacyDlpV2DiscoveryConfig", "properties": { "actions": { @@ -5677,7 +6136,7 @@ "type": "array" }, "inspectTemplates": { - "description": "Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data-residency.", + "description": "Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.", "items": { "type": "string" }, @@ -6248,7 +6707,7 @@ "type": "object" }, "GooglePrivacyDlpV2FixedSizeBucketingConfig": { - "description": "Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with \"10-20\". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.", + "description": "Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with \"10-20\". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more.", "id": "GooglePrivacyDlpV2FixedSizeBucketingConfig", "properties": { "bucketSize": { @@ -6281,7 +6740,7 @@ }, "proximity": { "$ref": "GooglePrivacyDlpV2Proximity", - "description": "Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex \"\\(\\d{3}\\) \\d{3}-\\d{4}\" if the area code is known to be the area code of a company's office. In this case, use the hotword regex \"\\(xxx\\)\", where \"xxx\" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values)." + "description": "Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex \"\\(\\d{3}\\) \\d{3}-\\d{4}\" if the area code is known to be the area code of a company's office. In this case, use the hotword regex \"\\(xxx\\)\", where \"xxx\" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values)." } }, "type": "object" @@ -6487,7 +6946,7 @@ "id": "GooglePrivacyDlpV2InfoType", "properties": { "name": { - "description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.", + "description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.", "type": "string" }, "sensitivityScore": { @@ -6832,7 +7291,7 @@ "type": "array" }, "customInfoTypes": { - "description": "CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.", + "description": "CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more.", "items": { "$ref": "GooglePrivacyDlpV2CustomInfoType" }, @@ -6847,7 +7306,7 @@ "type": "boolean" }, "infoTypes": { - "description": "Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.", + "description": "Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.", "items": { "$ref": "GooglePrivacyDlpV2InfoType" }, @@ -6858,7 +7317,7 @@ "description": "Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values." }, "minLikelihood": { - "description": "Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://cloud.google.com/dlp/docs/likelihood).", + "description": "Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood).", "enum": [ "LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", @@ -6988,7 +7447,7 @@ "type": "object" }, "GooglePrivacyDlpV2InspectTemplate": { - "description": "The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.", + "description": "The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.", "id": "GooglePrivacyDlpV2InspectTemplate", "properties": { "createTime": { @@ -7066,7 +7525,7 @@ "type": "object" }, "GooglePrivacyDlpV2JobTrigger": { - "description": "Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.", + "description": "Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.", "id": "GooglePrivacyDlpV2JobTrigger", "properties": { "createTime": { @@ -7344,7 +7803,7 @@ "type": "object" }, "GooglePrivacyDlpV2KmsWrappedCryptoKey": { - "description": "Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/dlp/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing).", + "description": "Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing).", "id": "GooglePrivacyDlpV2KmsWrappedCryptoKey", "properties": { "cryptoKeyName": { @@ -7457,7 +7916,7 @@ "type": "object" }, "GooglePrivacyDlpV2LargeCustomDictionaryConfig": { - "description": "Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements.", + "description": "Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements.", "id": "GooglePrivacyDlpV2LargeCustomDictionaryConfig", "properties": { "bigQueryField": { @@ -7525,6 +7984,24 @@ }, "type": "object" }, + "GooglePrivacyDlpV2ListColumnDataProfilesResponse": { + "description": "List of profiles generated for a given organization or project.", + "id": "GooglePrivacyDlpV2ListColumnDataProfilesResponse", + "properties": { + "columnDataProfiles": { + "description": "List of data profiles.", + "items": { + "$ref": "GooglePrivacyDlpV2ColumnDataProfile" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The next page token.", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse": { "description": "Response message for ListDeidentifyTemplates.", "id": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse", @@ -7629,6 +8106,24 @@ }, "type": "object" }, + "GooglePrivacyDlpV2ListProjectDataProfilesResponse": { + "description": "List of profiles generated for a given organization or project.", + "id": "GooglePrivacyDlpV2ListProjectDataProfilesResponse", + "properties": { + "nextPageToken": { + "description": "The next page token.", + "type": "string" + }, + "projectDataProfiles": { + "description": "List of data profiles.", + "items": { + "$ref": "GooglePrivacyDlpV2ProjectDataProfile" + }, + "type": "array" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2ListStoredInfoTypesResponse": { "description": "Response message for ListStoredInfoTypes.", "id": "GooglePrivacyDlpV2ListStoredInfoTypesResponse", @@ -7647,6 +8142,24 @@ }, "type": "object" }, + "GooglePrivacyDlpV2ListTableDataProfilesResponse": { + "description": "List of profiles generated for a given organization or project.", + "id": "GooglePrivacyDlpV2ListTableDataProfilesResponse", + "properties": { + "nextPageToken": { + "description": "The next page token.", + "type": "string" + }, + "tableDataProfiles": { + "description": "List of data profiles.", + "items": { + "$ref": "GooglePrivacyDlpV2TableDataProfile" + }, + "type": "array" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2Location": { "description": "Specifies the location of the finding.", "id": "GooglePrivacyDlpV2Location", @@ -7955,6 +8468,38 @@ }, "type": "object" }, + "GooglePrivacyDlpV2ProjectDataProfile": { + "description": "An aggregated profile for this project, based on the resources profiled within it.", + "id": "GooglePrivacyDlpV2ProjectDataProfile", + "properties": { + "dataRiskLevel": { + "$ref": "GooglePrivacyDlpV2DataRiskLevel", + "description": "The data risk level of this project." + }, + "name": { + "description": "The resource name of the profile.", + "type": "string" + }, + "profileLastGenerated": { + "description": "The last time the profile was generated.", + "format": "google-datetime", + "type": "string" + }, + "profileStatus": { + "$ref": "GooglePrivacyDlpV2ProfileStatus", + "description": "Success or error status of the last attempt to profile the project." + }, + "projectId": { + "description": "Project ID that was profiled.", + "type": "string" + }, + "sensitivityScore": { + "$ref": "GooglePrivacyDlpV2SensitivityScore", + "description": "The sensitivity score of this project." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2Proximity": { "description": "Message for specifying a window around a finding to apply a detection rule.", "id": "GooglePrivacyDlpV2Proximity", @@ -7965,7 +8510,7 @@ "type": "integer" }, "windowBefore": { - "description": "Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).", + "description": "Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).", "format": "int32", "type": "integer" } @@ -8095,7 +8640,7 @@ "type": "object" }, "GooglePrivacyDlpV2PublishToPubSub": { - "description": "Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk", + "description": "Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk", "id": "GooglePrivacyDlpV2PublishToPubSub", "properties": { "topic": { @@ -8213,7 +8758,7 @@ }, "datastoreKey": { "$ref": "GooglePrivacyDlpV2DatastoreKey", - "description": "Bigquery key" + "description": "BigQuery key" }, "idValues": { "description": "Values of identifying columns in the given row. Order of values matches the order of `identifying_fields` specified in the scanning request.", @@ -8423,7 +8968,7 @@ "properties": { "wordList": { "$ref": "GooglePrivacyDlpV2WordList", - "description": "A list of words to select from for random replacement. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries." + "description": "A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries." } }, "type": "object" @@ -8519,7 +9064,7 @@ "type": "object" }, "GooglePrivacyDlpV2RiskAnalysisJobConfig": { - "description": "Configuration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more.", + "description": "Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more.", "id": "GooglePrivacyDlpV2RiskAnalysisJobConfig", "properties": { "actions": { @@ -8697,7 +9242,7 @@ "type": "object" }, "GooglePrivacyDlpV2StoredInfoTypeConfig": { - "description": "Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes.", + "description": "Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes.", "id": "GooglePrivacyDlpV2StoredInfoTypeConfig", "properties": { "description": { @@ -8826,13 +9371,13 @@ "type": "object" }, "GooglePrivacyDlpV2SurrogateType": { - "description": "Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a \"surrogate\" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`.", + "description": "Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a \"surrogate\" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`.", "id": "GooglePrivacyDlpV2SurrogateType", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2Table": { - "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more.", + "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more.", "id": "GooglePrivacyDlpV2Table", "properties": { "headers": { @@ -8874,15 +9419,15 @@ "description": "The resource type that was profiled." }, "datasetId": { - "description": "The BigQuery dataset ID.", + "description": "If the resource is BigQuery, the dataset ID.", "type": "string" }, "datasetLocation": { - "description": "The BigQuery location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.", + "description": "If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.", "type": "string" }, "datasetProjectId": { - "description": "The Google Cloud project ID that owns the BigQuery dataset.", + "description": "The Google Cloud project ID that owns the resource.", "type": "string" }, "encryptionStatus": { @@ -8910,7 +9455,7 @@ "type": "string" }, "fullResource": { - "description": "The resource name of the table. https://cloud.google.com/apis/design/resource_names#full_resource_name", + "description": "The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "lastModifiedTime": { @@ -8999,7 +9544,7 @@ "type": "string" }, "tableId": { - "description": "The BigQuery table ID.", + "description": "If the resource is BigQuery, the BigQuery table ID.", "type": "string" }, "tableSizeBytes": { @@ -9126,7 +9671,7 @@ }, "timestampField": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/dlp/docs/known-issues#bq-timespan) related to this operation." + "description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation." } }, "type": "object" diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 6034888a75e..60ab4b30f7a 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -131,7 +131,7 @@ export namespace dlp_v2 { } /** - * A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more. + * A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. */ export interface Schema$GooglePrivacyDlpV2Action { /** @@ -314,7 +314,7 @@ export namespace dlp_v2 { */ rowsLimit?: string | null; /** - * Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/dlp/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + * Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. */ rowsLimitPercent?: number | null; /** @@ -426,7 +426,7 @@ export namespace dlp_v2 { replacementValue?: Schema$GooglePrivacyDlpV2Value; } /** - * Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -\> LOW 31-65 -\> MEDIUM 66-100 -\> HIGH This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. + * Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -\> LOW 31-65 -\> MEDIUM 66-100 -\> HIGH This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. */ export interface Schema$GooglePrivacyDlpV2BucketingConfig { /** @@ -542,11 +542,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CloudStorageOptions { /** - * Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/dlp/docs/supported-file-types#max-byte-size-per-file). + * Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). */ bytesLimitPerFile?: string | null; /** - * Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/dlp/docs/supported-file-types#max-byte-size-per-file). + * Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). */ bytesLimitPerFilePercent?: number | null; /** @@ -571,7 +571,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CloudStoragePath { /** - * A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt + * A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` */ path?: string | null; } @@ -638,7 +638,7 @@ export namespace dlp_v2 { */ datasetLocation?: string | null; /** - * The Google Cloud project ID that owns the BigQuery dataset. + * The Google Cloud project ID that owns the profiled resource. */ datasetProjectId?: string | null; /** @@ -686,7 +686,7 @@ export namespace dlp_v2 { */ tableDataProfile?: string | null; /** - * The resource name of the table this column is within. + * The resource name of the resource this column is within. */ tableFullResource?: string | null; /** @@ -762,7 +762,7 @@ export namespace dlp_v2 { */ byteItem?: Schema$GooglePrivacyDlpV2ByteContentItem; /** - * Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + * Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. */ table?: Schema$GooglePrivacyDlpV2Table; /** @@ -923,7 +923,7 @@ export namespace dlp_v2 { surrogateInfoType?: Schema$GooglePrivacyDlpV2InfoType; } /** - * Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. + * Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. */ export interface Schema$GooglePrivacyDlpV2CryptoHashConfig { /** @@ -949,7 +949,7 @@ export namespace dlp_v2 { unwrapped?: Schema$GooglePrivacyDlpV2UnwrappedCryptoKey; } /** - * Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. + * Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. */ export interface Schema$GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig { /** @@ -973,7 +973,7 @@ export namespace dlp_v2 { */ radix?: number | null; /** - * The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE + * The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE */ surrogateInfoType?: Schema$GooglePrivacyDlpV2InfoType; } @@ -1060,9 +1060,17 @@ export namespace dlp_v2 { * A copy of the inspection config used to generate this profile. This is a copy of the inspect_template specified in `DataProfileJobConfig`. */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; + /** + * Timestamp when the template was modified + */ + inspectTemplateModifiedTime?: string | null; + /** + * Name of the inspection template used to generate this profile + */ + inspectTemplateName?: string | null; } /** - * Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/dlp/docs/data-profiles#retention). + * Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). */ export interface Schema$GooglePrivacyDlpV2DataProfileJobConfig { /** @@ -1070,7 +1078,7 @@ export namespace dlp_v2 { */ dataProfileActions?: Schema$GooglePrivacyDlpV2DataProfileAction[]; /** - * Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data-residency. + * Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. */ inspectTemplates?: string[] | null; /** @@ -1158,7 +1166,7 @@ export namespace dlp_v2 { partitionId?: Schema$GooglePrivacyDlpV2PartitionId; } /** - * Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting to learn more. + * Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. */ export interface Schema$GooglePrivacyDlpV2DateShiftConfig { /** @@ -1314,7 +1322,7 @@ export namespace dlp_v2 { transformedBytes?: string | null; } /** - * DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. + * DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. */ export interface Schema$GooglePrivacyDlpV2DeidentifyTemplate { /** @@ -1416,7 +1424,7 @@ export namespace dlp_v2 { hotwordRule?: Schema$GooglePrivacyDlpV2HotwordRule; } /** - * Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. + * Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. */ export interface Schema$GooglePrivacyDlpV2Dictionary { /** @@ -1467,7 +1475,7 @@ export namespace dlp_v2 { tables?: Schema$GooglePrivacyDlpV2BigQueryTableCollection; } /** - * Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/dlp/docs/data-profiles#retention). + * Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). */ export interface Schema$GooglePrivacyDlpV2DiscoveryConfig { /** @@ -1487,7 +1495,7 @@ export namespace dlp_v2 { */ errors?: Schema$GooglePrivacyDlpV2Error[]; /** - * Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data-residency. + * Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. */ inspectTemplates?: string[] | null; /** @@ -1851,7 +1859,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2FinishDlpJobRequest {} /** - * Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound\}-{upper_bound\}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. + * Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound\}-{upper_bound\}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. */ export interface Schema$GooglePrivacyDlpV2FixedSizeBucketingConfig { /** @@ -1880,7 +1888,7 @@ export namespace dlp_v2 { */ likelihoodAdjustment?: Schema$GooglePrivacyDlpV2LikelihoodAdjustment; /** - * Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3\}\) \d{3\}-\d{4\}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). + * Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3\}\) \d{3\}-\d{4\}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). */ proximity?: Schema$GooglePrivacyDlpV2Proximity; } @@ -2043,7 +2051,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2InfoType { /** - * Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64\}`. + * Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64\}`. */ name?: string | null; /** @@ -2188,7 +2196,7 @@ export namespace dlp_v2 { */ contentOptions?: string[] | null; /** - * CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. + * CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. */ customInfoTypes?: Schema$GooglePrivacyDlpV2CustomInfoType[]; /** @@ -2200,7 +2208,7 @@ export namespace dlp_v2 { */ includeQuote?: boolean | null; /** - * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. + * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; /** @@ -2208,7 +2216,7 @@ export namespace dlp_v2 { */ limits?: Schema$GooglePrivacyDlpV2FindingLimits; /** - * Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://cloud.google.com/dlp/docs/likelihood). + * Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). */ minLikelihood?: string | null; /** @@ -2324,7 +2332,7 @@ export namespace dlp_v2 { findingsTruncated?: boolean | null; } /** - * The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. + * The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. */ export interface Schema$GooglePrivacyDlpV2InspectTemplate { /** @@ -2357,7 +2365,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2JobNotificationEmails {} /** - * Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. + * Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. */ export interface Schema$GooglePrivacyDlpV2JobTrigger { /** @@ -2548,7 +2556,7 @@ export namespace dlp_v2 { kMapEstimationHistogram?: Schema$GooglePrivacyDlpV2KMapEstimationHistogramBucket[]; } /** - * Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/dlp/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). + * Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). */ export interface Schema$GooglePrivacyDlpV2KmsWrappedCryptoKey { /** @@ -2561,7 +2569,7 @@ export namespace dlp_v2 { wrappedKey?: string | null; } /** - * Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. + * Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. */ export interface Schema$GooglePrivacyDlpV2LargeCustomDictionaryConfig { /** @@ -2671,6 +2679,19 @@ export namespace dlp_v2 { */ relativeLikelihood?: number | null; } + /** + * List of profiles generated for a given organization or project. + */ + export interface Schema$GooglePrivacyDlpV2ListColumnDataProfilesResponse { + /** + * List of data profiles. + */ + columnDataProfiles?: Schema$GooglePrivacyDlpV2ColumnDataProfile[]; + /** + * The next page token. + */ + nextPageToken?: string | null; + } /** * Response message for ListDeidentifyTemplates. */ @@ -2745,6 +2766,19 @@ export namespace dlp_v2 { */ nextPageToken?: string | null; } + /** + * List of profiles generated for a given organization or project. + */ + export interface Schema$GooglePrivacyDlpV2ListProjectDataProfilesResponse { + /** + * The next page token. + */ + nextPageToken?: string | null; + /** + * List of data profiles. + */ + projectDataProfiles?: Schema$GooglePrivacyDlpV2ProjectDataProfile[]; + } /** * Response message for ListStoredInfoTypes. */ @@ -2758,6 +2792,19 @@ export namespace dlp_v2 { */ storedInfoTypes?: Schema$GooglePrivacyDlpV2StoredInfoType[]; } + /** + * List of profiles generated for a given organization or project. + */ + export interface Schema$GooglePrivacyDlpV2ListTableDataProfilesResponse { + /** + * The next page token. + */ + nextPageToken?: string | null; + /** + * List of data profiles. + */ + tableDataProfiles?: Schema$GooglePrivacyDlpV2TableDataProfile[]; + } /** * Specifies the location of the finding. */ @@ -3003,6 +3050,35 @@ export namespace dlp_v2 { */ timestamp?: string | null; } + /** + * An aggregated profile for this project, based on the resources profiled within it. + */ + export interface Schema$GooglePrivacyDlpV2ProjectDataProfile { + /** + * The data risk level of this project. + */ + dataRiskLevel?: Schema$GooglePrivacyDlpV2DataRiskLevel; + /** + * The resource name of the profile. + */ + name?: string | null; + /** + * The last time the profile was generated. + */ + profileLastGenerated?: string | null; + /** + * Success or error status of the last attempt to profile the project. + */ + profileStatus?: Schema$GooglePrivacyDlpV2ProfileStatus; + /** + * Project ID that was profiled. + */ + projectId?: string | null; + /** + * The sensitivity score of this project. + */ + sensitivityScore?: Schema$GooglePrivacyDlpV2SensitivityScore; + } /** * Message for specifying a window around a finding to apply a detection rule. */ @@ -3012,7 +3088,7 @@ export namespace dlp_v2 { */ windowAfter?: number | null; /** - * Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). + * Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). */ windowBefore?: number | null; } @@ -3025,7 +3101,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2PublishSummaryToCscc {} /** - * Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk + * Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk */ export interface Schema$GooglePrivacyDlpV2PublishToPubSub { /** @@ -3171,7 +3247,7 @@ export namespace dlp_v2 { */ bigQueryKey?: Schema$GooglePrivacyDlpV2BigQueryKey; /** - * Bigquery key + * BigQuery key */ datastoreKey?: Schema$GooglePrivacyDlpV2DatastoreKey; /** @@ -3341,7 +3417,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ReplaceDictionaryConfig { /** - * A list of words to select from for random replacement. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. + * A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. */ wordList?: Schema$GooglePrivacyDlpV2WordList; } @@ -3419,7 +3495,7 @@ export namespace dlp_v2 { totalEstimatedBytes?: string | null; } /** - * Configuration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more. + * Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. */ export interface Schema$GooglePrivacyDlpV2RiskAnalysisJobConfig { /** @@ -3549,7 +3625,7 @@ export namespace dlp_v2 { pendingVersions?: Schema$GooglePrivacyDlpV2StoredInfoTypeVersion[]; } /** - * Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. + * Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. */ export interface Schema$GooglePrivacyDlpV2StoredInfoTypeConfig { /** @@ -3638,11 +3714,11 @@ export namespace dlp_v2 { details?: string | null; } /** - * Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. + * Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. */ export interface Schema$GooglePrivacyDlpV2SurrogateType {} /** - * Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. + * Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. */ export interface Schema$GooglePrivacyDlpV2Table { /** @@ -3671,15 +3747,15 @@ export namespace dlp_v2 { */ dataRiskLevel?: Schema$GooglePrivacyDlpV2DataRiskLevel; /** - * The BigQuery dataset ID. + * If the resource is BigQuery, the dataset ID. */ datasetId?: string | null; /** - * The BigQuery location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. + * If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. */ datasetLocation?: string | null; /** - * The Google Cloud project ID that owns the BigQuery dataset. + * The Google Cloud project ID that owns the resource. */ datasetProjectId?: string | null; /** @@ -3699,7 +3775,7 @@ export namespace dlp_v2 { */ failedColumnCount?: string | null; /** - * The resource name of the table. https://cloud.google.com/apis/design/resource_names#full_resource_name + * The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name */ fullResource?: string | null; /** @@ -3755,7 +3831,7 @@ export namespace dlp_v2 { */ state?: string | null; /** - * The BigQuery table ID. + * If the resource is BigQuery, the BigQuery table ID. */ tableId?: string | null; /** @@ -3832,7 +3908,7 @@ export namespace dlp_v2 { */ startTime?: string | null; /** - * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/dlp/docs/known-issues#bq-timespan) related to this operation. + * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. */ timestampField?: Schema$GooglePrivacyDlpV2FieldId; } @@ -4245,7 +4321,7 @@ export namespace dlp_v2 { } /** - * Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more. + * Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4372,7 +4448,7 @@ export namespace dlp_v2 { } /** - * Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more. + * Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4516,7 +4592,7 @@ export namespace dlp_v2 { } /** - * Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4612,7 +4688,7 @@ export namespace dlp_v2 { } /** - * Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4699,7 +4775,7 @@ export namespace dlp_v2 { } /** - * Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4792,7 +4868,7 @@ export namespace dlp_v2 { } /** - * Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4888,7 +4964,7 @@ export namespace dlp_v2 { } /** - * Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4984,7 +5060,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Deidentifytemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -5026,7 +5102,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -5050,7 +5126,7 @@ export namespace dlp_v2 { } /** - * Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5146,7 +5222,7 @@ export namespace dlp_v2 { } /** - * Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5233,7 +5309,7 @@ export namespace dlp_v2 { } /** - * Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5326,7 +5402,7 @@ export namespace dlp_v2 { } /** - * Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5422,7 +5498,7 @@ export namespace dlp_v2 { } /** - * Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5518,7 +5594,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Inspecttemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -5560,7 +5636,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -5579,14 +5655,19 @@ export namespace dlp_v2 { export class Resource$Organizations$Locations { context: APIRequestContext; + columnDataProfiles: Resource$Organizations$Locations$Columndataprofiles; deidentifyTemplates: Resource$Organizations$Locations$Deidentifytemplates; discoveryConfigs: Resource$Organizations$Locations$Discoveryconfigs; dlpJobs: Resource$Organizations$Locations$Dlpjobs; inspectTemplates: Resource$Organizations$Locations$Inspecttemplates; jobTriggers: Resource$Organizations$Locations$Jobtriggers; + projectDataProfiles: Resource$Organizations$Locations$Projectdataprofiles; storedInfoTypes: Resource$Organizations$Locations$Storedinfotypes; + tableDataProfiles: Resource$Organizations$Locations$Tabledataprofiles; constructor(context: APIRequestContext) { this.context = context; + this.columnDataProfiles = + new Resource$Organizations$Locations$Columndataprofiles(this.context); this.deidentifyTemplates = new Resource$Organizations$Locations$Deidentifytemplates(this.context); this.discoveryConfigs = @@ -5597,11 +5678,244 @@ export namespace dlp_v2 { this.jobTriggers = new Resource$Organizations$Locations$Jobtriggers( this.context ); + this.projectDataProfiles = + new Resource$Organizations$Locations$Projectdataprofiles(this.context); this.storedInfoTypes = new Resource$Organizations$Locations$Storedinfotypes(this.context); + this.tableDataProfiles = + new Resource$Organizations$Locations$Tabledataprofiles(this.context); + } + } + + export class Resource$Organizations$Locations$Columndataprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a column data profile. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Organizations$Locations$Columndataprofiles$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Organizations$Locations$Columndataprofiles$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Columndataprofiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Columndataprofiles$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Columndataprofiles$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Columndataprofiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Columndataprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Columndataprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists data profiles for an organization. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Organizations$Locations$Columndataprofiles$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Columndataprofiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Columndataprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Columndataprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Columndataprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Columndataprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Columndataprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Columndataprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/columnDataProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } } + export interface Params$Resource$Organizations$Locations$Columndataprofiles$Get + extends StandardParameters { + /** + * Required. Resource name, for example `organizations/12345/locations/us/columnDataProfiles/53234423`. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Columndataprofiles$List + extends StandardParameters { + /** + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `table_data_profile_name` - The name of the related table data profile. - `project_id` - The Google Cloud project ID. (REQUIRED) - `dataset_id` - The BigQuery dataset ID. (REQUIRED) - `table_id` - The BigQuery table ID. (REQUIRED) - `field_id` - The ID of the BigQuery field. - `info_type` - The infotype detected in the resource. - `sensitivity_level` - HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data. - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + */ + orderBy?: string; + /** + * Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. + */ + pageSize?: number; + /** + * Page token to continue retrieval. + */ + pageToken?: string; + /** + * Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or projects/project-id/locations/asia. + */ + parent?: string; + } + export class Resource$Organizations$Locations$Deidentifytemplates { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -5609,7 +5923,7 @@ export namespace dlp_v2 { } /** - * Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5706,7 +6020,7 @@ export namespace dlp_v2 { } /** - * Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5794,7 +6108,7 @@ export namespace dlp_v2 { } /** - * Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5888,7 +6202,7 @@ export namespace dlp_v2 { } /** - * Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5985,7 +6299,7 @@ export namespace dlp_v2 { } /** - * Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6082,7 +6396,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Deidentifytemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -6124,7 +6438,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -6683,7 +6997,7 @@ export namespace dlp_v2 { } /** - * Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6802,7 +7116,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -6818,7 +7132,7 @@ export namespace dlp_v2 { } /** - * Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6915,7 +7229,7 @@ export namespace dlp_v2 { } /** - * Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7003,7 +7317,7 @@ export namespace dlp_v2 { } /** - * Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7097,7 +7411,7 @@ export namespace dlp_v2 { } /** - * Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7194,7 +7508,7 @@ export namespace dlp_v2 { } /** - * Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7291,7 +7605,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Inspecttemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -7333,7 +7647,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -7357,7 +7671,7 @@ export namespace dlp_v2 { } /** - * Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7454,7 +7768,7 @@ export namespace dlp_v2 { } /** - * Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7542,7 +7856,7 @@ export namespace dlp_v2 { } /** - * Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7635,7 +7949,7 @@ export namespace dlp_v2 { } /** - * Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7731,7 +8045,7 @@ export namespace dlp_v2 { } /** - * Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7828,7 +8142,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Jobtriggers$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -7874,7 +8188,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -7895,46 +8209,275 @@ export namespace dlp_v2 { requestBody?: Schema$GooglePrivacyDlpV2UpdateJobTriggerRequest; } - export class Resource$Organizations$Locations$Storedinfotypes { + export class Resource$Organizations$Locations$Projectdataprofiles { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Gets a project data profile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + get( + params: Params$Resource$Organizations$Locations$Projectdataprofiles$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + get( + params?: Params$Resource$Organizations$Locations$Projectdataprofiles$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Projectdataprofiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + get( + params: Params$Resource$Organizations$Locations$Projectdataprofiles$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Storedinfotypes$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Projectdataprofiles$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Projectdataprofiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Projectdataprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Projectdataprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists data profiles for an organization. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Organizations$Locations$Projectdataprofiles$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Projectdataprofiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Projectdataprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Projectdataprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Projectdataprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Projectdataprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Projectdataprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Projectdataprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/projectDataProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Organizations$Locations$Projectdataprofiles$Get + extends StandardParameters { + /** + * Required. Resource name, for example `organizations/12345/locations/us/projectDataProfiles/53234423`. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Projectdataprofiles$List + extends StandardParameters { + /** + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: GCP project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + */ + orderBy?: string; + /** + * Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. + */ + pageSize?: number; + /** + * Page token to continue retrieval. + */ + pageToken?: string; + /** + * Required. organizations/{org_id\}/locations/{loc_id\} + */ + parent?: string; + } + + export class Resource$Organizations$Locations$Storedinfotypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Locations$Storedinfotypes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback ): void; create( paramsOrCallback?: @@ -7999,7 +8542,7 @@ export namespace dlp_v2 { } /** - * Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8087,7 +8630,7 @@ export namespace dlp_v2 { } /** - * Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8181,7 +8724,7 @@ export namespace dlp_v2 { } /** - * Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8278,7 +8821,7 @@ export namespace dlp_v2 { } /** - * Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8375,7 +8918,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Storedinfotypes$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -8417,7 +8960,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -8434,71 +8977,72 @@ export namespace dlp_v2 { requestBody?: Schema$GooglePrivacyDlpV2UpdateStoredInfoTypeRequest; } - export class Resource$Organizations$Storedinfotypes { + export class Resource$Organizations$Locations$Tabledataprofiles { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Gets a table data profile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Organizations$Storedinfotypes$Create, + get( + params: Params$Resource$Organizations$Locations$Tabledataprofiles$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Storedinfotypes$Create, + get( + params?: Params$Resource$Organizations$Locations$Tabledataprofiles$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Storedinfotypes$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Tabledataprofiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Storedinfotypes$Create, + get( + params: Params$Resource$Organizations$Locations$Tabledataprofiles$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Storedinfotypes$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Tabledataprofiles$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Organizations$Storedinfotypes$Create - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Tabledataprofiles$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Storedinfotypes$Create; + {}) as Params$Resource$Organizations$Locations$Tabledataprofiles$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Storedinfotypes$Create; + params = + {} as Params$Resource$Organizations$Locations$Tabledataprofiles$Get; options = {}; } @@ -8511,60 +9055,288 @@ export namespace dlp_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/storedInfoTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Lists data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Organizations$Storedinfotypes$Delete, + list( + params: Params$Resource$Organizations$Locations$Tabledataprofiles$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Storedinfotypes$Delete, + list( + params?: Params$Resource$Organizations$Locations$Tabledataprofiles$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Storedinfotypes$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Tabledataprofiles$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Storedinfotypes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Tabledataprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Storedinfotypes$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Tabledataprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Tabledataprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Tabledataprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Tabledataprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/tableDataProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Organizations$Locations$Tabledataprofiles$Get + extends StandardParameters { + /** + * Required. Resource name, for example `organizations/12345/locations/us/tableDataProfiles/53234423`. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Tabledataprofiles$List + extends StandardParameters { + /** + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The GCP project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND resource_visibility = PUBLIC The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The GCP project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. + */ + orderBy?: string; + /** + * Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. + */ + pageSize?: number; + /** + * Page token to continue retrieval. + */ + pageToken?: string; + /** + * Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. + */ + parent?: string; + } + + export class Resource$Organizations$Storedinfotypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Organizations$Storedinfotypes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Organizations$Storedinfotypes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Storedinfotypes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Storedinfotypes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Storedinfotypes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Storedinfotypes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Storedinfotypes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Storedinfotypes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/storedInfoTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Organizations$Storedinfotypes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Organizations$Storedinfotypes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Storedinfotypes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Storedinfotypes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Storedinfotypes$Delete, + callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( @@ -8624,7 +9396,7 @@ export namespace dlp_v2 { } /** - * Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8717,7 +9489,7 @@ export namespace dlp_v2 { } /** - * Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8813,7 +9585,7 @@ export namespace dlp_v2 { } /** - * Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8909,7 +9681,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Storedinfotypes$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -8951,7 +9723,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -9004,7 +9776,7 @@ export namespace dlp_v2 { } /** - * De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9100,7 +9872,7 @@ export namespace dlp_v2 { } /** - * Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, + * Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9196,7 +9968,7 @@ export namespace dlp_v2 { } /** - * Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. + * Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9295,7 +10067,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Content$Deidentify extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -9307,7 +10079,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Content$Inspect extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -9319,7 +10091,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Content$Reidentify extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -9336,7 +10108,7 @@ export namespace dlp_v2 { } /** - * Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9432,7 +10204,7 @@ export namespace dlp_v2 { } /** - * Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9519,7 +10291,7 @@ export namespace dlp_v2 { } /** - * Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9612,7 +10384,7 @@ export namespace dlp_v2 { } /** - * Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9708,7 +10480,7 @@ export namespace dlp_v2 { } /** - * Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9804,7 +10576,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Deidentifytemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -9846,7 +10618,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -9870,7 +10642,7 @@ export namespace dlp_v2 { } /** - * Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9957,7 +10729,7 @@ export namespace dlp_v2 { } /** - * Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10051,7 +10823,7 @@ export namespace dlp_v2 { } /** - * Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10138,7 +10910,7 @@ export namespace dlp_v2 { } /** - * Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10227,7 +10999,7 @@ export namespace dlp_v2 { } /** - * Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10338,7 +11110,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Dlpjobs$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -10384,7 +11156,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -10400,7 +11172,7 @@ export namespace dlp_v2 { } /** - * Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10499,7 +11271,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Image$Redact extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -10516,7 +11288,7 @@ export namespace dlp_v2 { } /** - * Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10612,7 +11384,7 @@ export namespace dlp_v2 { } /** - * Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10699,7 +11471,7 @@ export namespace dlp_v2 { } /** - * Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10792,7 +11564,7 @@ export namespace dlp_v2 { } /** - * Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10888,7 +11660,7 @@ export namespace dlp_v2 { } /** - * Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10984,7 +11756,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Inspecttemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -11026,7 +11798,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -11144,7 +11916,7 @@ export namespace dlp_v2 { } /** - * Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11240,7 +12012,7 @@ export namespace dlp_v2 { } /** - * Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11327,7 +12099,7 @@ export namespace dlp_v2 { } /** - * Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11420,7 +12192,7 @@ export namespace dlp_v2 { } /** - * Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11516,7 +12288,7 @@ export namespace dlp_v2 { } /** - * Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11624,7 +12396,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Jobtriggers$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -11670,7 +12442,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -11693,6 +12465,7 @@ export namespace dlp_v2 { export class Resource$Projects$Locations { context: APIRequestContext; + columnDataProfiles: Resource$Projects$Locations$Columndataprofiles; content: Resource$Projects$Locations$Content; deidentifyTemplates: Resource$Projects$Locations$Deidentifytemplates; discoveryConfigs: Resource$Projects$Locations$Discoveryconfigs; @@ -11700,9 +12473,13 @@ export namespace dlp_v2 { image: Resource$Projects$Locations$Image; inspectTemplates: Resource$Projects$Locations$Inspecttemplates; jobTriggers: Resource$Projects$Locations$Jobtriggers; + projectDataProfiles: Resource$Projects$Locations$Projectdataprofiles; storedInfoTypes: Resource$Projects$Locations$Storedinfotypes; + tableDataProfiles: Resource$Projects$Locations$Tabledataprofiles; constructor(context: APIRequestContext) { this.context = context; + this.columnDataProfiles = + new Resource$Projects$Locations$Columndataprofiles(this.context); this.content = new Resource$Projects$Locations$Content(this.context); this.deidentifyTemplates = new Resource$Projects$Locations$Deidentifytemplates(this.context); @@ -11717,77 +12494,82 @@ export namespace dlp_v2 { this.jobTriggers = new Resource$Projects$Locations$Jobtriggers( this.context ); + this.projectDataProfiles = + new Resource$Projects$Locations$Projectdataprofiles(this.context); this.storedInfoTypes = new Resource$Projects$Locations$Storedinfotypes( this.context ); + this.tableDataProfiles = + new Resource$Projects$Locations$Tabledataprofiles(this.context); } } - export class Resource$Projects$Locations$Content { + export class Resource$Projects$Locations$Columndataprofiles { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * Gets a column data profile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deidentify( - params: Params$Resource$Projects$Locations$Content$Deidentify, + get( + params: Params$Resource$Projects$Locations$Columndataprofiles$Get, options: StreamMethodOptions ): GaxiosPromise; - deidentify( - params?: Params$Resource$Projects$Locations$Content$Deidentify, + get( + params?: Params$Resource$Projects$Locations$Columndataprofiles$Get, options?: MethodOptions - ): GaxiosPromise; - deidentify( - params: Params$Resource$Projects$Locations$Content$Deidentify, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Columndataprofiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deidentify( - params: Params$Resource$Projects$Locations$Content$Deidentify, + get( + params: Params$Resource$Projects$Locations$Columndataprofiles$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deidentify( - params: Params$Resource$Projects$Locations$Content$Deidentify, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Columndataprofiles$Get, + callback: BodyResponseCallback ): void; - deidentify( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - deidentify( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Content$Deidentify - | BodyResponseCallback + | Params$Resource$Projects$Locations$Columndataprofiles$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Content$Deidentify; + {}) as Params$Resource$Projects$Locations$Columndataprofiles$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Content$Deidentify; + params = + {} as Params$Resource$Projects$Locations$Columndataprofiles$Get; options = {}; } @@ -11800,40 +12582,268 @@ export namespace dlp_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/content:deidentify').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, + * Lists data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - inspect( + list( + params: Params$Resource$Projects$Locations$Columndataprofiles$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Columndataprofiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Columndataprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Columndataprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Columndataprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Columndataprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Columndataprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Columndataprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/columnDataProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Columndataprofiles$Get + extends StandardParameters { + /** + * Required. Resource name, for example `organizations/12345/locations/us/columnDataProfiles/53234423`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Columndataprofiles$List + extends StandardParameters { + /** + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `table_data_profile_name` - The name of the related table data profile. - `project_id` - The Google Cloud project ID. (REQUIRED) - `dataset_id` - The BigQuery dataset ID. (REQUIRED) - `table_id` - The BigQuery table ID. (REQUIRED) - `field_id` - The ID of the BigQuery field. - `info_type` - The infotype detected in the resource. - `sensitivity_level` - HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data. - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + */ + orderBy?: string; + /** + * Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. + */ + pageSize?: number; + /** + * Page token to continue retrieval. + */ + pageToken?: string; + /** + * Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or projects/project-id/locations/asia. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Content { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deidentify( + params: Params$Resource$Projects$Locations$Content$Deidentify, + options: StreamMethodOptions + ): GaxiosPromise; + deidentify( + params?: Params$Resource$Projects$Locations$Content$Deidentify, + options?: MethodOptions + ): GaxiosPromise; + deidentify( + params: Params$Resource$Projects$Locations$Content$Deidentify, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deidentify( + params: Params$Resource$Projects$Locations$Content$Deidentify, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deidentify( + params: Params$Resource$Projects$Locations$Content$Deidentify, + callback: BodyResponseCallback + ): void; + deidentify( + callback: BodyResponseCallback + ): void; + deidentify( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Content$Deidentify + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Content$Deidentify; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Content$Deidentify; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/content:deidentify').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + inspect( params: Params$Resource$Projects$Locations$Content$Inspect, options: StreamMethodOptions ): GaxiosPromise; @@ -11922,7 +12932,7 @@ export namespace dlp_v2 { } /** - * Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. + * Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12021,7 +13031,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Content$Deidentify extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -12033,7 +13043,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Content$Inspect extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -12045,7 +13055,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Content$Reidentify extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -12062,7 +13072,7 @@ export namespace dlp_v2 { } /** - * Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12159,7 +13169,7 @@ export namespace dlp_v2 { } /** - * Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12247,7 +13257,7 @@ export namespace dlp_v2 { } /** - * Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12341,7 +13351,7 @@ export namespace dlp_v2 { } /** - * Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12438,7 +13448,7 @@ export namespace dlp_v2 { } /** - * Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12535,7 +13545,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Deidentifytemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -12577,7 +13587,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -13134,7 +14144,7 @@ export namespace dlp_v2 { } /** - * Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13221,7 +14231,7 @@ export namespace dlp_v2 { } /** - * Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13315,7 +14325,7 @@ export namespace dlp_v2 { } /** - * Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13489,7 +14499,7 @@ export namespace dlp_v2 { } /** - * Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13674,7 +14684,7 @@ export namespace dlp_v2 { } /** - * Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13785,7 +14795,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Dlpjobs$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -13855,7 +14865,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -13871,7 +14881,7 @@ export namespace dlp_v2 { } /** - * Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13970,7 +14980,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Image$Redact extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -13987,7 +14997,7 @@ export namespace dlp_v2 { } /** - * Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14084,7 +15094,7 @@ export namespace dlp_v2 { } /** - * Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14172,7 +15182,7 @@ export namespace dlp_v2 { } /** - * Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14265,7 +15275,7 @@ export namespace dlp_v2 { } /** - * Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14361,7 +15371,7 @@ export namespace dlp_v2 { } /** - * Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. + * Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14458,7 +15468,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Inspecttemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -14500,7 +15510,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -14618,7 +15628,7 @@ export namespace dlp_v2 { } /** - * Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14714,7 +15724,7 @@ export namespace dlp_v2 { } /** - * Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14801,7 +15811,7 @@ export namespace dlp_v2 { } /** - * Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14991,7 +16001,7 @@ export namespace dlp_v2 { } /** - * Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15087,7 +16097,7 @@ export namespace dlp_v2 { } /** - * Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15195,7 +16205,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Jobtriggers$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -15253,7 +16263,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -15274,72 +16284,72 @@ export namespace dlp_v2 { requestBody?: Schema$GooglePrivacyDlpV2UpdateJobTriggerRequest; } - export class Resource$Projects$Locations$Storedinfotypes { + export class Resource$Projects$Locations$Projectdataprofiles { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Gets a project data profile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Storedinfotypes$Create, + get( + params: Params$Resource$Projects$Locations$Projectdataprofiles$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Storedinfotypes$Create, + get( + params?: Params$Resource$Projects$Locations$Projectdataprofiles$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Storedinfotypes$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Projectdataprofiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Storedinfotypes$Create, + get( + params: Params$Resource$Projects$Locations$Projectdataprofiles$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Storedinfotypes$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Projectdataprofiles$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Storedinfotypes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Projectdataprofiles$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Storedinfotypes$Create; + {}) as Params$Resource$Projects$Locations$Projectdataprofiles$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Storedinfotypes$Create; + {} as Params$Resource$Projects$Locations$Projectdataprofiles$Get; options = {}; } @@ -15352,49 +16362,278 @@ export namespace dlp_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/storedInfoTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Lists data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Storedinfotypes$Delete, + list( + params: Params$Resource$Projects$Locations$Projectdataprofiles$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Storedinfotypes$Delete, + list( + params?: Params$Resource$Projects$Locations$Projectdataprofiles$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Storedinfotypes$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Projectdataprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Projectdataprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Projectdataprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Projectdataprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Projectdataprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Projectdataprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/projectDataProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Projectdataprofiles$Get + extends StandardParameters { + /** + * Required. Resource name, for example `organizations/12345/locations/us/projectDataProfiles/53234423`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Projectdataprofiles$List + extends StandardParameters { + /** + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: GCP project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + */ + orderBy?: string; + /** + * Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. + */ + pageSize?: number; + /** + * Page token to continue retrieval. + */ + pageToken?: string; + /** + * Required. organizations/{org_id\}/locations/{loc_id\} + */ + parent?: string; + } + + export class Resource$Projects$Locations$Storedinfotypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Storedinfotypes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Storedinfotypes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Storedinfotypes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Storedinfotypes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Storedinfotypes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Storedinfotypes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Storedinfotypes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Storedinfotypes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/storedInfoTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Storedinfotypes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Storedinfotypes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Storedinfotypes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; @@ -15466,7 +16705,7 @@ export namespace dlp_v2 { } /** - * Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15559,7 +16798,7 @@ export namespace dlp_v2 { } /** - * Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15655,7 +16894,7 @@ export namespace dlp_v2 { } /** - * Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15751,7 +16990,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Storedinfotypes$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -15793,7 +17032,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -15810,6 +17049,234 @@ export namespace dlp_v2 { requestBody?: Schema$GooglePrivacyDlpV2UpdateStoredInfoTypeRequest; } + export class Resource$Projects$Locations$Tabledataprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a table data profile. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Tabledataprofiles$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Tabledataprofiles$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Tabledataprofiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Tabledataprofiles$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Tabledataprofiles$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tabledataprofiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tabledataprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tabledataprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists data profiles for an organization. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Tabledataprofiles$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Tabledataprofiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Tabledataprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Tabledataprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Tabledataprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tabledataprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tabledataprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tabledataprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/tableDataProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Tabledataprofiles$Get + extends StandardParameters { + /** + * Required. Resource name, for example `organizations/12345/locations/us/tableDataProfiles/53234423`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tabledataprofiles$List + extends StandardParameters { + /** + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The GCP project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND resource_visibility = PUBLIC The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The GCP project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. + */ + orderBy?: string; + /** + * Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. + */ + pageSize?: number; + /** + * Page token to continue retrieval. + */ + pageToken?: string; + /** + * Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. + */ + parent?: string; + } + export class Resource$Projects$Storedinfotypes { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -15817,7 +17284,7 @@ export namespace dlp_v2 { } /** - * Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15913,7 +17380,7 @@ export namespace dlp_v2 { } /** - * Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16000,7 +17467,7 @@ export namespace dlp_v2 { } /** - * Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16093,7 +17560,7 @@ export namespace dlp_v2 { } /** - * Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16189,7 +17656,7 @@ export namespace dlp_v2 { } /** - * Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. + * Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16285,7 +17752,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Storedinfotypes$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -16327,7 +17794,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } From ab06b132a7d00b4f684bd938c6d5c1f7301a5415 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 39/78] feat(dns): update the API #### dns:v1beta2 The following keys were added: - schemas.Quota.properties.nameserversPerDelegation.description - schemas.Quota.properties.nameserversPerDelegation.format - schemas.Quota.properties.nameserversPerDelegation.type #### dns:v1 The following keys were added: - schemas.Quota.properties.nameserversPerDelegation.description - schemas.Quota.properties.nameserversPerDelegation.format - schemas.Quota.properties.nameserversPerDelegation.type --- discovery/dns-v1.json | 7 ++++++- discovery/dns-v1beta2.json | 7 ++++++- src/apis/dns/v1.ts | 4 ++++ src/apis/dns/v1beta2.ts | 4 ++++ 4 files changed, 20 insertions(+), 2 deletions(-) diff --git a/discovery/dns-v1.json b/discovery/dns-v1.json index a05e23fe823..fbb78ea9e43 100644 --- a/discovery/dns-v1.json +++ b/discovery/dns-v1.json @@ -1824,7 +1824,7 @@ } } }, - "revision": "20240129", + "revision": "20240304", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2938,6 +2938,11 @@ "format": "int32", "type": "integer" }, + "nameserversPerDelegation": { + "description": "Maximum number of nameservers per delegation, meant to prevent abuse", + "format": "int32", + "type": "integer" + }, "networksPerManagedZone": { "description": "Maximum allowed number of networks to which a privately scoped zone can be attached.", "format": "int32", diff --git a/discovery/dns-v1beta2.json b/discovery/dns-v1beta2.json index fc6566d83b1..ee4d920ec70 100644 --- a/discovery/dns-v1beta2.json +++ b/discovery/dns-v1beta2.json @@ -1821,7 +1821,7 @@ } } }, - "revision": "20240129", + "revision": "20240304", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2935,6 +2935,11 @@ "format": "int32", "type": "integer" }, + "nameserversPerDelegation": { + "description": "Maximum number of nameservers per delegation, meant to prevent abuse", + "format": "int32", + "type": "integer" + }, "networksPerManagedZone": { "description": "Maximum allowed number of networks to which a privately scoped zone can be attached.", "format": "int32", diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index 300b66629a3..61c40c7618e 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -822,6 +822,10 @@ export namespace dns_v1 { * Maximum allowed number of managed zones which can be attached to a network. */ managedZonesPerNetwork?: number | null; + /** + * Maximum number of nameservers per delegation, meant to prevent abuse + */ + nameserversPerDelegation?: number | null; /** * Maximum allowed number of networks to which a privately scoped zone can be attached. */ diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 06d63808022..665e32229c0 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -822,6 +822,10 @@ export namespace dns_v1beta2 { * Maximum allowed number of managed zones which can be attached to a network. */ managedZonesPerNetwork?: number | null; + /** + * Maximum number of nameservers per delegation, meant to prevent abuse + */ + nameserversPerDelegation?: number | null; /** * Maximum allowed number of networks to which a privately scoped zone can be attached. */ From d0ec267bc5d9320e0e2bef96e9ee36106ce187bf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 40/78] fix(doubleclickbidmanager): update the API #### doubleclickbidmanager:v2 The following keys were changed: - schemas.Options.properties.pathQueryOptions.description - schemas.Parameters.properties.type.enumDescriptions --- discovery/doubleclickbidmanager-v2.json | 8 ++++---- src/apis/doubleclickbidmanager/v2.ts | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/discovery/doubleclickbidmanager-v2.json b/discovery/doubleclickbidmanager-v2.json index 41de15cd911..e5781dbc80e 100644 --- a/discovery/doubleclickbidmanager-v2.json +++ b/discovery/doubleclickbidmanager-v2.json @@ -319,7 +319,7 @@ } } }, - "revision": "20230703", + "revision": "20240305", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { @@ -511,7 +511,7 @@ }, "pathQueryOptions": { "$ref": "PathQueryOptions", - "description": "Options that contain Path Filters and Custom Channel Groupings." + "description": "Options that contain Path Filters and Custom Channel Groupings. This field is deprecated and will sunset on **May 1, 2024**. After sunset, requests using this field will return an error." } }, "type": "object" @@ -586,8 +586,8 @@ "YouTube Programmatic Guaranteed report.", "Reach report.", "Unique Reach Audience report.", - "Full Path report.", - "Path Attribution report." + "Full Path report. This report type is deprecated and will sunset on **May 1, 2024**. After sunset, requests retrieving, creating, or running reports of this type will return an error.", + "Path Attribution report. This report type is deprecated and will sunset on **May 1, 2024**. After sunset, requests retrieving, creating, or running reports of this type will return an error." ], "type": "string" } diff --git a/src/apis/doubleclickbidmanager/v2.ts b/src/apis/doubleclickbidmanager/v2.ts index f537cb4d31c..06eac9282c7 100644 --- a/src/apis/doubleclickbidmanager/v2.ts +++ b/src/apis/doubleclickbidmanager/v2.ts @@ -235,7 +235,7 @@ export namespace doubleclickbidmanager_v2 { */ includeOnlyTargetedUserLists?: boolean | null; /** - * Options that contain Path Filters and Custom Channel Groupings. + * Options that contain Path Filters and Custom Channel Groupings. This field is deprecated and will sunset on **May 1, 2024**. After sunset, requests using this field will return an error. */ pathQueryOptions?: Schema$PathQueryOptions; } From ff74297097a094fb9a67ade6a24e8a83d0d19404 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 41/78] feat(file): update the API #### file:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.instances.methods.promoteReplica.description - resources.projects.resources.locations.resources.instances.methods.promoteReplica.flatPath - resources.projects.resources.locations.resources.instances.methods.promoteReplica.httpMethod - resources.projects.resources.locations.resources.instances.methods.promoteReplica.id - resources.projects.resources.locations.resources.instances.methods.promoteReplica.parameterOrder - resources.projects.resources.locations.resources.instances.methods.promoteReplica.parameters.name.description - resources.projects.resources.locations.resources.instances.methods.promoteReplica.parameters.name.location - resources.projects.resources.locations.resources.instances.methods.promoteReplica.parameters.name.pattern - resources.projects.resources.locations.resources.instances.methods.promoteReplica.parameters.name.required - resources.projects.resources.locations.resources.instances.methods.promoteReplica.parameters.name.type - resources.projects.resources.locations.resources.instances.methods.promoteReplica.path - resources.projects.resources.locations.resources.instances.methods.promoteReplica.request.$ref - resources.projects.resources.locations.resources.instances.methods.promoteReplica.response.$ref - resources.projects.resources.locations.resources.instances.methods.promoteReplica.scopes - schemas.PromoteReplicaRequest.description - schemas.PromoteReplicaRequest.id - schemas.PromoteReplicaRequest.type The following keys were changed: - resources.projects.resources.locations.resources.instances.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.instances.methods.revert.parameters.name.description - schemas.Instance.properties.directoryServices.description - schemas.Instance.properties.state.enum - schemas.Instance.properties.state.enumDescriptions - schemas.MaintenancePolicy.description - schemas.ManagedActiveDirectoryConfig.properties.computer.description - schemas.ManagedActiveDirectoryConfig.properties.domain.description #### file:v1 The following keys were changed: - resources.projects.resources.locations.resources.instances.methods.revert.parameters.name.description --- discovery/file-v1.json | 4 +- discovery/file-v1beta1.json | 54 ++++++++++++++--- src/apis/file/v1.ts | 2 +- src/apis/file/v1beta1.ts | 116 ++++++++++++++++++++++++++++++++++-- 4 files changed, 158 insertions(+), 18 deletions(-) diff --git a/discovery/file-v1.json b/discovery/file-v1.json index 47e13942bc6..d119f9e3082 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -557,7 +557,7 @@ ], "parameters": { "name": { - "description": "Required. `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. The resource name of the instance, in the format", + "description": "Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, @@ -874,7 +874,7 @@ } } }, - "revision": "20231213", + "revision": "20240304", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index 83577e8e071..5a2372ed644 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -502,7 +502,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * \"description\" * \"file_shares\" * \"labels\"", + "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * \"description\" * \"directory_services\" * \"file_shares\" * \"labels\"", "format": "google-fieldmask", "location": "query", "type": "string" @@ -519,6 +519,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "promoteReplica": { + "description": "Promote an standby instance (replica).", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:promoteReplica", + "httpMethod": "POST", + "id": "file.projects.locations.instances.promoteReplica", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:promoteReplica", + "request": { + "$ref": "PromoteReplicaRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "restore": { "description": "Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restore", @@ -557,7 +585,7 @@ ], "parameters": { "name": { - "description": "Required. `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. The resource name of the instance, in the format", + "description": "Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, @@ -1041,7 +1069,7 @@ } } }, - "revision": "20231213", + "revision": "20240307", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1570,7 +1598,7 @@ }, "directoryServices": { "$ref": "DirectoryServicesConfig", - "description": "Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is \"NFS_V4_1\"." + "description": "Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is \"NFS_V4_1\"." }, "etag": { "description": "Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.", @@ -1658,7 +1686,8 @@ "SUSPENDED", "REVERTING", "SUSPENDING", - "RESUMING" + "RESUMING", + "PROMOTING" ], "enumDescriptions": [ "State not set.", @@ -1671,7 +1700,8 @@ "The instance is suspended. You can get further details from the `suspension_reasons` field of the `Instance` resource.", "The instance is reverting to a snapshot.", "The instance is in the process of becoming suspended.", - "The instance is in the process of becoming active." + "The instance is in the process of becoming active.", + "The replica instance is being promoted." ], "readOnly": true, "type": "string" @@ -1890,7 +1920,7 @@ "type": "object" }, "MaintenancePolicy": { - "description": "LINT.IfChange Defines policies to service maintenance events.", + "description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { @@ -1959,11 +1989,11 @@ "id": "ManagedActiveDirectoryConfig", "properties": { "computer": { - "description": "The computer name is used as a prefix to the mount remote target. Example: if the computer_name is `my-computer`, the mount command will look like: `$mount -o vers=4,sec=krb5 my-computer.filestore.:`.", + "description": "Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `.", "type": "string" }, "domain": { - "description": "Fully qualified domain name.", + "description": "Required. The domain resource name, in the format `projects/{project_id}/locations/global/domains/{domain}`.", "type": "string" } }, @@ -2173,6 +2203,12 @@ }, "type": "object" }, + "PromoteReplicaRequest": { + "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", + "id": "PromoteReplicaRequest", + "properties": {}, + "type": "object" + }, "RestoreInstanceRequest": { "description": "RestoreInstanceRequest restores an existing instance's file share from a backup.", "id": "RestoreInstanceRequest", diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 5f1a2c8d226..e64e1aa2ed9 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -2350,7 +2350,7 @@ export namespace file_v1 { export interface Params$Resource$Projects$Locations$Instances$Revert extends StandardParameters { /** - * Required. `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. The resource name of the instance, in the format + * Required. The resource name of the instance, in the format `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. */ name?: string; diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 4b99d2da681..d6c40c3e18b 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -496,7 +496,7 @@ export namespace file_v1beta1 { */ description?: string | null; /** - * Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". + * Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". */ directoryServices?: Schema$DirectoryServicesConfig; /** @@ -680,7 +680,7 @@ export namespace file_v1beta1 { name?: string | null; } /** - * LINT.IfChange Defines policies to service maintenance events. + * Defines policies to service maintenance events. */ export interface Schema$MaintenancePolicy { /** @@ -730,11 +730,11 @@ export namespace file_v1beta1 { */ export interface Schema$ManagedActiveDirectoryConfig { /** - * The computer name is used as a prefix to the mount remote target. Example: if the computer_name is `my-computer`, the mount command will look like: `$mount -o vers=4,sec=krb5 my-computer.filestore.:`. + * Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. */ computer?: string | null; /** - * Fully qualified domain name. + * Required. The domain resource name, in the format `projects/{project_id\}/locations/global/domains/{domain\}`. */ domain?: string | null; } @@ -850,6 +850,10 @@ export namespace file_v1beta1 { */ verb?: string | null; } + /** + * PromoteReplicaRequest promotes a Filestore standby instance (replica). + */ + export interface Schema$PromoteReplicaRequest {} /** * RestoreInstanceRequest restores an existing instance's file share from a backup. */ @@ -2210,6 +2214,94 @@ export namespace file_v1beta1 { } } + /** + * Promote an standby instance (replica). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + promoteReplica( + params: Params$Resource$Projects$Locations$Instances$Promotereplica, + options: StreamMethodOptions + ): GaxiosPromise; + promoteReplica( + params?: Params$Resource$Projects$Locations$Instances$Promotereplica, + options?: MethodOptions + ): GaxiosPromise; + promoteReplica( + params: Params$Resource$Projects$Locations$Instances$Promotereplica, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + promoteReplica( + params: Params$Resource$Projects$Locations$Instances$Promotereplica, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + promoteReplica( + params: Params$Resource$Projects$Locations$Instances$Promotereplica, + callback: BodyResponseCallback + ): void; + promoteReplica(callback: BodyResponseCallback): void; + promoteReplica( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Promotereplica + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Promotereplica; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Instances$Promotereplica; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://file.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:promoteReplica').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier). * @@ -2449,7 +2541,7 @@ export namespace file_v1beta1 { */ name?: string; /** - * Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" + * Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "directory_services" * "file_shares" * "labels" */ updateMask?: string; @@ -2458,6 +2550,18 @@ export namespace file_v1beta1 { */ requestBody?: Schema$Instance; } + export interface Params$Resource$Projects$Locations$Instances$Promotereplica + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PromoteReplicaRequest; + } export interface Params$Resource$Projects$Locations$Instances$Restore extends StandardParameters { /** @@ -2473,7 +2577,7 @@ export namespace file_v1beta1 { export interface Params$Resource$Projects$Locations$Instances$Revert extends StandardParameters { /** - * Required. `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. The resource name of the instance, in the format + * Required. The resource name of the instance, in the format `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. */ name?: string; From cc3dda9a041414bf1901983851d2b9f3b31e46a0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 42/78] fix(firebaseappcheck): update the API #### firebaseappcheck:v1beta The following keys were changed: - resources.oauthClients.methods.exchangeAppAttestAssertion.parameters.app.description - resources.oauthClients.methods.exchangeAppAttestAttestation.parameters.app.description - resources.oauthClients.methods.exchangeDebugToken.parameters.app.description - resources.oauthClients.methods.generateAppAttestChallenge.parameters.app.description - resources.projects.resources.apps.methods.exchangeAppAttestAssertion.parameters.app.description - resources.projects.resources.apps.methods.exchangeAppAttestAttestation.parameters.app.description - resources.projects.resources.apps.methods.exchangeDebugToken.parameters.app.description - resources.projects.resources.apps.methods.generateAppAttestChallenge.parameters.app.description - schemas.GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest.properties.updateMask.description - schemas.GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse.properties.nextPageToken.description --- discovery/firebaseappcheck-v1beta.json | 22 +++++++++++----------- src/apis/firebaseappcheck/v1beta.ts | 20 ++++++++++---------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/discovery/firebaseappcheck-v1beta.json b/discovery/firebaseappcheck-v1beta.json index a23e7206307..837463fd259 100644 --- a/discovery/firebaseappcheck-v1beta.json +++ b/discovery/firebaseappcheck-v1beta.json @@ -150,7 +150,7 @@ ], "parameters": { "app": { - "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", + "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.", "location": "path", "pattern": "^oauthClients/[^/]+$", "required": true, @@ -179,7 +179,7 @@ ], "parameters": { "app": { - "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", + "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.", "location": "path", "pattern": "^oauthClients/[^/]+$", "required": true, @@ -208,7 +208,7 @@ ], "parameters": { "app": { - "description": "Required. The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", + "description": "Required. The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.", "location": "path", "pattern": "^oauthClients/[^/]+$", "required": true, @@ -237,7 +237,7 @@ ], "parameters": { "app": { - "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", + "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.", "location": "path", "pattern": "^oauthClients/[^/]+$", "required": true, @@ -303,7 +303,7 @@ ], "parameters": { "app": { - "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", + "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.", "location": "path", "pattern": "^projects/[^/]+/apps/[^/]+$", "required": true, @@ -332,7 +332,7 @@ ], "parameters": { "app": { - "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", + "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.", "location": "path", "pattern": "^projects/[^/]+/apps/[^/]+$", "required": true, @@ -390,7 +390,7 @@ ], "parameters": { "app": { - "description": "Required. The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", + "description": "Required. The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.", "location": "path", "pattern": "^projects/[^/]+/apps/[^/]+$", "required": true, @@ -595,7 +595,7 @@ ], "parameters": { "app": { - "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", + "description": "Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.", "location": "path", "pattern": "^projects/[^/]+/apps/[^/]+$", "required": true, @@ -1823,7 +1823,7 @@ } } }, - "revision": "20240122", + "revision": "20240304", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { @@ -1992,7 +1992,7 @@ "type": "array" }, "updateMask": { - "description": "Optional. A comma-separated list of names of fields in the ResourceConfigurations to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed.", + "description": "Optional. A comma-separated list of names of fields in the ResourcePolicy objects to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed.", "format": "google-fieldmask", "type": "string" } @@ -2349,7 +2349,7 @@ "id": "GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse", "properties": { "nextPageToken": { - "description": "If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicys. Page tokens are short-lived and should not be persisted.", + "description": "If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted.", "type": "string" }, "resourcePolicies": { diff --git a/src/apis/firebaseappcheck/v1beta.ts b/src/apis/firebaseappcheck/v1beta.ts index 5b0cf26a637..af87338ec15 100644 --- a/src/apis/firebaseappcheck/v1beta.ts +++ b/src/apis/firebaseappcheck/v1beta.ts @@ -243,7 +243,7 @@ export namespace firebaseappcheck_v1beta { */ requests?: Schema$GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest[]; /** - * Optional. A comma-separated list of names of fields in the ResourceConfigurations to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed. + * Optional. A comma-separated list of names of fields in the ResourcePolicy objects to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed. */ updateMask?: string | null; } @@ -527,7 +527,7 @@ export namespace firebaseappcheck_v1beta { */ export interface Schema$GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse { /** - * If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicys. Page tokens are short-lived and should not be persisted. + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted. */ nextPageToken?: string | null; /** @@ -1269,7 +1269,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Oauthclients$Exchangeappattestassertion extends StandardParameters { /** - * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. + * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id\} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. */ app?: string; @@ -1281,7 +1281,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Oauthclients$Exchangeappattestattestation extends StandardParameters { /** - * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. + * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id\} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. */ app?: string; @@ -1293,7 +1293,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Oauthclients$Exchangedebugtoken extends StandardParameters { /** - * Required. The relative resource name of the app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. + * Required. The relative resource name of the app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id\} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. */ app?: string; @@ -1305,7 +1305,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Oauthclients$Generateappattestchallenge extends StandardParameters { /** - * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. + * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id\} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. */ app?: string; @@ -2636,7 +2636,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Projects$Apps$Exchangeappattestassertion extends StandardParameters { /** - * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. + * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id\} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. */ app?: string; @@ -2648,7 +2648,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Projects$Apps$Exchangeappattestattestation extends StandardParameters { /** - * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. + * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id\} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. */ app?: string; @@ -2672,7 +2672,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Projects$Apps$Exchangedebugtoken extends StandardParameters { /** - * Required. The relative resource name of the app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. + * Required. The relative resource name of the app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id\} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. */ app?: string; @@ -2756,7 +2756,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Projects$Apps$Generateappattestchallenge extends StandardParameters { /** - * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. + * Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number\}/apps/{app_id\} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id\} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see [the documentation](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. */ app?: string; From 1e04a1a7926bfddb42adfacf5c1157fe1455de32 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 43/78] fix(firestore): update the API #### firestore:v1 The following keys were changed: - schemas.GoogleFirestoreAdminV1ListBackupsResponse.properties.backups.description --- discovery/firestore-v1.json | 4 ++-- src/apis/firestore/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index f004c1b35d1..bf56fb39f79 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1672,7 +1672,7 @@ } } }, - "revision": "20240215", + "revision": "20240307", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -3092,7 +3092,7 @@ "id": "GoogleFirestoreAdminV1ListBackupsResponse", "properties": { "backups": { - "description": "List of all backups for the project. Ordered by `location ASC, create_time DESC, name ASC`.", + "description": "List of all backups for the project.", "items": { "$ref": "GoogleFirestoreAdminV1Backup" }, diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 751c32f5f4b..e87db33e639 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -1033,7 +1033,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1ListBackupsResponse { /** - * List of all backups for the project. Ordered by `location ASC, create_time DESC, name ASC`. + * List of all backups for the project. */ backups?: Schema$GoogleFirestoreAdminV1Backup[]; /** From 105445d344768c413a68a12ac460e644c8b54e9a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 44/78] feat(gkehub): update the API #### gkehub:v1alpha The following keys were added: - resources.projects.resources.locations.resources.scopes.methods.listMemberships.description - resources.projects.resources.locations.resources.scopes.methods.listMemberships.flatPath - resources.projects.resources.locations.resources.scopes.methods.listMemberships.httpMethod - resources.projects.resources.locations.resources.scopes.methods.listMemberships.id - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameterOrder - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.filter.description - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.filter.location - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.filter.type - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.pageSize.description - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.pageSize.format - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.pageSize.location - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.pageSize.type - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.pageToken.description - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.pageToken.location - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.pageToken.type - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.scopeName.description - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.scopeName.location - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.scopeName.pattern - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.scopeName.required - resources.projects.resources.locations.resources.scopes.methods.listMemberships.parameters.scopeName.type - resources.projects.resources.locations.resources.scopes.methods.listMemberships.path - resources.projects.resources.locations.resources.scopes.methods.listMemberships.response.$ref - resources.projects.resources.locations.resources.scopes.methods.listMemberships.scopes - schemas.IdentityServiceAuthMethod.properties.samlConfig.$ref - schemas.IdentityServiceAuthMethod.properties.samlConfig.description - schemas.IdentityServiceAzureADConfig.properties.groupFormat.description - schemas.IdentityServiceAzureADConfig.properties.groupFormat.type - schemas.IdentityServiceAzureADConfig.properties.userClaim.description - schemas.IdentityServiceAzureADConfig.properties.userClaim.type - schemas.IdentityServiceSamlConfig.description - schemas.IdentityServiceSamlConfig.id - schemas.IdentityServiceSamlConfig.properties.attributeMapping.additionalProperties.type - schemas.IdentityServiceSamlConfig.properties.attributeMapping.description - schemas.IdentityServiceSamlConfig.properties.attributeMapping.type - schemas.IdentityServiceSamlConfig.properties.groupPrefix.description - schemas.IdentityServiceSamlConfig.properties.groupPrefix.type - schemas.IdentityServiceSamlConfig.properties.groupsAttribute.description - schemas.IdentityServiceSamlConfig.properties.groupsAttribute.type - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.description - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.items.type - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.type - schemas.IdentityServiceSamlConfig.properties.identityProviderId.description - schemas.IdentityServiceSamlConfig.properties.identityProviderId.type - schemas.IdentityServiceSamlConfig.properties.identityProviderSsoUri.description - schemas.IdentityServiceSamlConfig.properties.identityProviderSsoUri.type - schemas.IdentityServiceSamlConfig.properties.userAttribute.description - schemas.IdentityServiceSamlConfig.properties.userAttribute.type - schemas.IdentityServiceSamlConfig.properties.userPrefix.description - schemas.IdentityServiceSamlConfig.properties.userPrefix.type - schemas.IdentityServiceSamlConfig.type - schemas.ListBoundMembershipsResponse.description - schemas.ListBoundMembershipsResponse.id - schemas.ListBoundMembershipsResponse.properties.memberships.description - schemas.ListBoundMembershipsResponse.properties.memberships.items.$ref - schemas.ListBoundMembershipsResponse.properties.memberships.type - schemas.ListBoundMembershipsResponse.properties.nextPageToken.description - schemas.ListBoundMembershipsResponse.properties.nextPageToken.type - schemas.ListBoundMembershipsResponse.properties.unreachable.description - schemas.ListBoundMembershipsResponse.properties.unreachable.items.type - schemas.ListBoundMembershipsResponse.properties.unreachable.type - schemas.ListBoundMembershipsResponse.type #### gkehub:v1beta The following keys were added: - schemas.IdentityServiceAuthMethod.properties.samlConfig.$ref - schemas.IdentityServiceAuthMethod.properties.samlConfig.description - schemas.IdentityServiceAzureADConfig.properties.groupFormat.description - schemas.IdentityServiceAzureADConfig.properties.groupFormat.type - schemas.IdentityServiceAzureADConfig.properties.userClaim.description - schemas.IdentityServiceAzureADConfig.properties.userClaim.type - schemas.IdentityServiceSamlConfig.description - schemas.IdentityServiceSamlConfig.id - schemas.IdentityServiceSamlConfig.properties.attributeMapping.additionalProperties.type - schemas.IdentityServiceSamlConfig.properties.attributeMapping.description - schemas.IdentityServiceSamlConfig.properties.attributeMapping.type - schemas.IdentityServiceSamlConfig.properties.groupPrefix.description - schemas.IdentityServiceSamlConfig.properties.groupPrefix.type - schemas.IdentityServiceSamlConfig.properties.groupsAttribute.description - schemas.IdentityServiceSamlConfig.properties.groupsAttribute.type - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.description - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.items.type - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.type - schemas.IdentityServiceSamlConfig.properties.identityProviderId.description - schemas.IdentityServiceSamlConfig.properties.identityProviderId.type - schemas.IdentityServiceSamlConfig.properties.identityProviderSsoUri.description - schemas.IdentityServiceSamlConfig.properties.identityProviderSsoUri.type - schemas.IdentityServiceSamlConfig.properties.userAttribute.description - schemas.IdentityServiceSamlConfig.properties.userAttribute.type - schemas.IdentityServiceSamlConfig.properties.userPrefix.description - schemas.IdentityServiceSamlConfig.properties.userPrefix.type - schemas.IdentityServiceSamlConfig.type #### gkehub:v1 The following keys were added: - schemas.IdentityServiceAuthMethod.properties.samlConfig.$ref - schemas.IdentityServiceAuthMethod.properties.samlConfig.description - schemas.IdentityServiceAzureADConfig.properties.groupFormat.description - schemas.IdentityServiceAzureADConfig.properties.groupFormat.type - schemas.IdentityServiceAzureADConfig.properties.userClaim.description - schemas.IdentityServiceAzureADConfig.properties.userClaim.type - schemas.IdentityServiceSamlConfig.description - schemas.IdentityServiceSamlConfig.id - schemas.IdentityServiceSamlConfig.properties.attributeMapping.additionalProperties.type - schemas.IdentityServiceSamlConfig.properties.attributeMapping.description - schemas.IdentityServiceSamlConfig.properties.attributeMapping.type - schemas.IdentityServiceSamlConfig.properties.groupPrefix.description - schemas.IdentityServiceSamlConfig.properties.groupPrefix.type - schemas.IdentityServiceSamlConfig.properties.groupsAttribute.description - schemas.IdentityServiceSamlConfig.properties.groupsAttribute.type - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.description - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.items.type - schemas.IdentityServiceSamlConfig.properties.identityProviderCertificates.type - schemas.IdentityServiceSamlConfig.properties.identityProviderId.description - schemas.IdentityServiceSamlConfig.properties.identityProviderId.type - schemas.IdentityServiceSamlConfig.properties.identityProviderSsoUri.description - schemas.IdentityServiceSamlConfig.properties.identityProviderSsoUri.type - schemas.IdentityServiceSamlConfig.properties.userAttribute.description - schemas.IdentityServiceSamlConfig.properties.userAttribute.type - schemas.IdentityServiceSamlConfig.properties.userPrefix.description - schemas.IdentityServiceSamlConfig.properties.userPrefix.type - schemas.IdentityServiceSamlConfig.type --- discovery/gkehub-v1.json | 59 ++++++++++- discovery/gkehub-v1alpha.json | 125 ++++++++++++++++++++++- discovery/gkehub-v1beta.json | 59 ++++++++++- src/apis/gkehub/v1.ts | 49 +++++++++ src/apis/gkehub/v1alpha.ts | 182 ++++++++++++++++++++++++++++++++++ src/apis/gkehub/v1beta.ts | 49 +++++++++ 6 files changed, 520 insertions(+), 3 deletions(-) diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index ee5ecc8a8eb..e45638368c7 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -1834,7 +1834,7 @@ } } }, - "revision": "20240209", + "revision": "20240229", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -3733,6 +3733,10 @@ "proxy": { "description": "Proxy server address to use for auth method.", "type": "string" + }, + "samlConfig": { + "$ref": "IdentityServiceSamlConfig", + "description": "SAML specific configuration." } }, "type": "object" @@ -3755,6 +3759,10 @@ "readOnly": true, "type": "string" }, + "groupFormat": { + "description": "Optional. Format of the AzureAD groups that the client wants for auth.", + "type": "string" + }, "kubectlRedirectUri": { "description": "The redirect URL that kubectl uses for authorization.", "type": "string" @@ -3762,6 +3770,10 @@ "tenant": { "description": "Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.", "type": "string" + }, + "userClaim": { + "description": "Optional. Claim in the AzureAD ID Token that holds the user details.", + "type": "string" } }, "type": "object" @@ -3889,6 +3901,51 @@ }, "type": "object" }, + "IdentityServiceSamlConfig": { + "description": "Configuration for the SAML Auth flow.", + "id": "IdentityServiceSamlConfig", + "properties": { + "attributeMapping": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is \"attribute.nickname\" and `value` is \"assertion.nickname\".", + "type": "object" + }, + "groupPrefix": { + "description": "Optional. Prefix to prepend to group name.", + "type": "string" + }, + "groupsAttribute": { + "description": "Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).", + "type": "string" + }, + "identityProviderCertificates": { + "description": "Required. The list of IdP certificates to validate the SAML response against.", + "items": { + "type": "string" + }, + "type": "array" + }, + "identityProviderId": { + "description": "Required. The entity ID of the SAML IdP.", + "type": "string" + }, + "identityProviderSsoUri": { + "description": "Required. The URI where the SAML IdP exposes the SSO service.", + "type": "string" + }, + "userAttribute": { + "description": "Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).", + "type": "string" + }, + "userPrefix": { + "description": "Optional. Prefix to prepend to user name.", + "type": "string" + } + }, + "type": "object" + }, "KubernetesMetadata": { "description": "KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.", "id": "KubernetesMetadata", diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 007c572be6f..9fa12eb471d 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -1685,6 +1685,47 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listMemberships": { + "description": "Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:listMemberships", + "httpMethod": "GET", + "id": "gkehub.projects.locations.scopes.listMemberships", + "parameterOrder": [ + "scopeName" + ], + "parameters": { + "filter": { + "description": "Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's `name`, `labels`, `create_time`, `update_time`, and `unique_id`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. Pagination is currently not supported; therefore, setting this field does not have any impact for now.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token returned by previous call to `ListBoundMemberships` which specifies the position in the list from where to continue listing the resources.", + "location": "query", + "type": "string" + }, + "scopeName": { + "description": "Required. Name of the Scope, in the format `projects/*/locations/global/scopes/*`, to which the Memberships are bound.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+scopeName}:listMemberships", + "response": { + "$ref": "ListBoundMembershipsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "listPermitted": { "description": "Lists permitted Scopes.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes:listPermitted", @@ -2134,7 +2175,7 @@ } } }, - "revision": "20240216", + "revision": "20240229", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -4283,6 +4324,10 @@ "proxy": { "description": "Proxy server address to use for auth method.", "type": "string" + }, + "samlConfig": { + "$ref": "IdentityServiceSamlConfig", + "description": "SAML specific configuration." } }, "type": "object" @@ -4305,6 +4350,10 @@ "readOnly": true, "type": "string" }, + "groupFormat": { + "description": "Optional. Format of the AzureAD groups that the client wants for auth.", + "type": "string" + }, "kubectlRedirectUri": { "description": "The redirect URL that kubectl uses for authorization.", "type": "string" @@ -4312,6 +4361,10 @@ "tenant": { "description": "Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.", "type": "string" + }, + "userClaim": { + "description": "Optional. Claim in the AzureAD ID Token that holds the user details.", + "type": "string" } }, "type": "object" @@ -4439,6 +4492,51 @@ }, "type": "object" }, + "IdentityServiceSamlConfig": { + "description": "Configuration for the SAML Auth flow.", + "id": "IdentityServiceSamlConfig", + "properties": { + "attributeMapping": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is \"attribute.nickname\" and `value` is \"assertion.nickname\".", + "type": "object" + }, + "groupPrefix": { + "description": "Optional. Prefix to prepend to group name.", + "type": "string" + }, + "groupsAttribute": { + "description": "Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).", + "type": "string" + }, + "identityProviderCertificates": { + "description": "Required. The list of IdP certificates to validate the SAML response against.", + "items": { + "type": "string" + }, + "type": "array" + }, + "identityProviderId": { + "description": "Required. The entity ID of the SAML IdP.", + "type": "string" + }, + "identityProviderSsoUri": { + "description": "Required. The URI where the SAML IdP exposes the SSO service.", + "type": "string" + }, + "userAttribute": { + "description": "Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).", + "type": "string" + }, + "userPrefix": { + "description": "Optional. Prefix to prepend to user name.", + "type": "string" + } + }, + "type": "object" + }, "KubernetesMetadata": { "description": "KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.", "id": "KubernetesMetadata", @@ -4536,6 +4634,31 @@ }, "type": "object" }, + "ListBoundMembershipsResponse": { + "description": "List of Memberships bound to a Scope.", + "id": "ListBoundMembershipsResponse", + "properties": { + "memberships": { + "description": "The list of Memberships bound to the given Scope.", + "items": { + "$ref": "Membership" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to request the next page of resources from the `ListBoundMemberships` method. The value of an empty string means that there are no more resources to return.", + "type": "string" + }, + "unreachable": { + "description": "List of locations that could not be reached while fetching this list.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListFeaturesResponse": { "description": "Response message for the `GkeHub.ListFeatures` method.", "id": "ListFeaturesResponse", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index efd30037fcc..f70ab688002 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -2024,7 +2024,7 @@ } } }, - "revision": "20240209", + "revision": "20240307", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -4028,6 +4028,10 @@ "proxy": { "description": "Proxy server address to use for auth method.", "type": "string" + }, + "samlConfig": { + "$ref": "IdentityServiceSamlConfig", + "description": "SAML specific configuration." } }, "type": "object" @@ -4050,6 +4054,10 @@ "readOnly": true, "type": "string" }, + "groupFormat": { + "description": "Optional. Format of the AzureAD groups that the client wants for auth.", + "type": "string" + }, "kubectlRedirectUri": { "description": "The redirect URL that kubectl uses for authorization.", "type": "string" @@ -4057,6 +4065,10 @@ "tenant": { "description": "Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.", "type": "string" + }, + "userClaim": { + "description": "Optional. Claim in the AzureAD ID Token that holds the user details.", + "type": "string" } }, "type": "object" @@ -4184,6 +4196,51 @@ }, "type": "object" }, + "IdentityServiceSamlConfig": { + "description": "Configuration for the SAML Auth flow.", + "id": "IdentityServiceSamlConfig", + "properties": { + "attributeMapping": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is \"attribute.nickname\" and `value` is \"assertion.nickname\".", + "type": "object" + }, + "groupPrefix": { + "description": "Optional. Prefix to prepend to group name.", + "type": "string" + }, + "groupsAttribute": { + "description": "Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).", + "type": "string" + }, + "identityProviderCertificates": { + "description": "Required. The list of IdP certificates to validate the SAML response against.", + "items": { + "type": "string" + }, + "type": "array" + }, + "identityProviderId": { + "description": "Required. The entity ID of the SAML IdP.", + "type": "string" + }, + "identityProviderSsoUri": { + "description": "Required. The URI where the SAML IdP exposes the SSO service.", + "type": "string" + }, + "userAttribute": { + "description": "Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).", + "type": "string" + }, + "userPrefix": { + "description": "Optional. Prefix to prepend to user name.", + "type": "string" + } + }, + "type": "object" + }, "KubernetesMetadata": { "description": "KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.", "id": "KubernetesMetadata", diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index 2af6a2970da..749341384f6 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -1374,6 +1374,10 @@ export namespace gkehub_v1 { * Proxy server address to use for auth method. */ proxy?: string | null; + /** + * SAML specific configuration. + */ + samlConfig?: Schema$IdentityServiceSamlConfig; } /** * Configuration for the AzureAD Auth flow. @@ -1391,6 +1395,10 @@ export namespace gkehub_v1 { * Output only. Encrypted AzureAD client secret. */ encryptedClientSecret?: string | null; + /** + * Optional. Format of the AzureAD groups that the client wants for auth. + */ + groupFormat?: string | null; /** * The redirect URL that kubectl uses for authorization. */ @@ -1399,6 +1407,10 @@ export namespace gkehub_v1 { * Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. */ tenant?: string | null; + /** + * Optional. Claim in the AzureAD ID Token that holds the user details. + */ + userClaim?: string | null; } /** * Configuration for the Google Plugin Auth flow. @@ -1500,6 +1512,43 @@ export namespace gkehub_v1 { */ userPrefix?: string | null; } + /** + * Configuration for the SAML Auth flow. + */ + export interface Schema$IdentityServiceSamlConfig { + /** + * Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname". + */ + attributeMapping?: {[key: string]: string} | null; + /** + * Optional. Prefix to prepend to group name. + */ + groupPrefix?: string | null; + /** + * Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`). + */ + groupsAttribute?: string | null; + /** + * Required. The list of IdP certificates to validate the SAML response against. + */ + identityProviderCertificates?: string[] | null; + /** + * Required. The entity ID of the SAML IdP. + */ + identityProviderId?: string | null; + /** + * Required. The URI where the SAML IdP exposes the SSO service. + */ + identityProviderSsoUri?: string | null; + /** + * Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`). + */ + userAttribute?: string | null; + /** + * Optional. Prefix to prepend to user name. + */ + userPrefix?: string | null; + } /** * KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. */ diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index eb82d97ac37..04d90d5d88d 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -1545,6 +1545,10 @@ export namespace gkehub_v1alpha { * Proxy server address to use for auth method. */ proxy?: string | null; + /** + * SAML specific configuration. + */ + samlConfig?: Schema$IdentityServiceSamlConfig; } /** * Configuration for the AzureAD Auth flow. @@ -1562,6 +1566,10 @@ export namespace gkehub_v1alpha { * Output only. Encrypted AzureAD client secret. */ encryptedClientSecret?: string | null; + /** + * Optional. Format of the AzureAD groups that the client wants for auth. + */ + groupFormat?: string | null; /** * The redirect URL that kubectl uses for authorization. */ @@ -1570,6 +1578,10 @@ export namespace gkehub_v1alpha { * Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. */ tenant?: string | null; + /** + * Optional. Claim in the AzureAD ID Token that holds the user details. + */ + userClaim?: string | null; } /** * Configuration for the Google Plugin Auth flow. @@ -1671,6 +1683,43 @@ export namespace gkehub_v1alpha { */ userPrefix?: string | null; } + /** + * Configuration for the SAML Auth flow. + */ + export interface Schema$IdentityServiceSamlConfig { + /** + * Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname". + */ + attributeMapping?: {[key: string]: string} | null; + /** + * Optional. Prefix to prepend to group name. + */ + groupPrefix?: string | null; + /** + * Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`). + */ + groupsAttribute?: string | null; + /** + * Required. The list of IdP certificates to validate the SAML response against. + */ + identityProviderCertificates?: string[] | null; + /** + * Required. The entity ID of the SAML IdP. + */ + identityProviderId?: string | null; + /** + * Required. The URI where the SAML IdP exposes the SSO service. + */ + identityProviderSsoUri?: string | null; + /** + * Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`). + */ + userAttribute?: string | null; + /** + * Optional. Prefix to prepend to user name. + */ + userPrefix?: string | null; + } /** * KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. */ @@ -1738,6 +1787,23 @@ export namespace gkehub_v1alpha { */ unreachable?: string[] | null; } + /** + * List of Memberships bound to a Scope. + */ + export interface Schema$ListBoundMembershipsResponse { + /** + * The list of Memberships bound to the given Scope. + */ + memberships?: Schema$Membership[]; + /** + * A token to request the next page of resources from the `ListBoundMemberships` method. The value of an empty string means that there are no more resources to return. + */ + nextPageToken?: string | null; + /** + * List of locations that could not be reached while fetching this list. + */ + unreachable?: string[] | null; + } /** * Response message for the `GkeHub.ListFeatures` method. */ @@ -7905,6 +7971,103 @@ export namespace gkehub_v1alpha { } } + /** + * Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: StreamMethodOptions + ): GaxiosPromise; + listMemberships( + params?: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options?: MethodOptions + ): GaxiosPromise; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + callback: BodyResponseCallback + ): void; + listMemberships( + callback: BodyResponseCallback + ): void; + listMemberships( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Scopes$Listmemberships + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Scopes$Listmemberships; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Scopes$Listmemberships; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+scopeName}:listMemberships').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['scopeName'], + pathParams: ['scopeName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists permitted Scopes. * @@ -8322,6 +8485,25 @@ export namespace gkehub_v1alpha { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Scopes$Listmemberships + extends StandardParameters { + /** + * Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's `name`, `labels`, `create_time`, `update_time`, and `unique_id`. + */ + filter?: string; + /** + * Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. Pagination is currently not supported; therefore, setting this field does not have any impact for now. + */ + pageSize?: number; + /** + * Optional. Token returned by previous call to `ListBoundMemberships` which specifies the position in the list from where to continue listing the resources. + */ + pageToken?: string; + /** + * Required. Name of the Scope, in the format `projects/x/locations/global/scopes/x`, to which the Memberships are bound. + */ + scopeName?: string; + } export interface Params$Resource$Projects$Locations$Scopes$Listpermitted extends StandardParameters { /** diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index 738c2e31788..85326491c9d 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -1452,6 +1452,10 @@ export namespace gkehub_v1beta { * Proxy server address to use for auth method. */ proxy?: string | null; + /** + * SAML specific configuration. + */ + samlConfig?: Schema$IdentityServiceSamlConfig; } /** * Configuration for the AzureAD Auth flow. @@ -1469,6 +1473,10 @@ export namespace gkehub_v1beta { * Output only. Encrypted AzureAD client secret. */ encryptedClientSecret?: string | null; + /** + * Optional. Format of the AzureAD groups that the client wants for auth. + */ + groupFormat?: string | null; /** * The redirect URL that kubectl uses for authorization. */ @@ -1477,6 +1485,10 @@ export namespace gkehub_v1beta { * Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. */ tenant?: string | null; + /** + * Optional. Claim in the AzureAD ID Token that holds the user details. + */ + userClaim?: string | null; } /** * Configuration for the Google Plugin Auth flow. @@ -1578,6 +1590,43 @@ export namespace gkehub_v1beta { */ userPrefix?: string | null; } + /** + * Configuration for the SAML Auth flow. + */ + export interface Schema$IdentityServiceSamlConfig { + /** + * Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname". + */ + attributeMapping?: {[key: string]: string} | null; + /** + * Optional. Prefix to prepend to group name. + */ + groupPrefix?: string | null; + /** + * Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`). + */ + groupsAttribute?: string | null; + /** + * Required. The list of IdP certificates to validate the SAML response against. + */ + identityProviderCertificates?: string[] | null; + /** + * Required. The entity ID of the SAML IdP. + */ + identityProviderId?: string | null; + /** + * Required. The URI where the SAML IdP exposes the SSO service. + */ + identityProviderSsoUri?: string | null; + /** + * Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`). + */ + userAttribute?: string | null; + /** + * Optional. Prefix to prepend to user name. + */ + userPrefix?: string | null; + } /** * KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. */ From 1da4ff6a70f8859478e235eb321e134b74d30fcc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 45/78] fix(gkeonprem): update the API #### gkeonprem:v1 The following keys were changed: - schemas.VmwareNodeConfig.properties.imageType.description --- discovery/gkeonprem-v1.json | 4 ++-- src/apis/gkeonprem/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/gkeonprem-v1.json b/discovery/gkeonprem-v1.json index dce68c9acf3..53b1f97344f 100644 --- a/discovery/gkeonprem-v1.json +++ b/discovery/gkeonprem-v1.json @@ -2996,7 +2996,7 @@ } } }, - "revision": "20240124", + "revision": "20240228", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -6368,7 +6368,7 @@ "type": "string" }, "imageType": { - "description": "Required. The OS image to be used for each node in a node pool. Currently `cos`, `ubuntu`, `ubuntu_containerd` and `windows` are supported.", + "description": "Required. The OS image to be used for each node in a node pool. Currently `cos`, `cos_cgv2`, `ubuntu`, `ubuntu_cgv2`, `ubuntu_containerd` and `windows` are supported.", "type": "string" }, "labels": { diff --git a/src/apis/gkeonprem/v1.ts b/src/apis/gkeonprem/v1.ts index 1aeda316346..85035f4e169 100644 --- a/src/apis/gkeonprem/v1.ts +++ b/src/apis/gkeonprem/v1.ts @@ -2601,7 +2601,7 @@ export namespace gkeonprem_v1 { */ image?: string | null; /** - * Required. The OS image to be used for each node in a node pool. Currently `cos`, `ubuntu`, `ubuntu_containerd` and `windows` are supported. + * Required. The OS image to be used for each node in a node pool. Currently `cos`, `cos_cgv2`, `ubuntu`, `ubuntu_cgv2`, `ubuntu_containerd` and `windows` are supported. */ imageType?: string | null; /** From 0970e64300eebdd1f28f1386c7827bc5f81e533c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 46/78] fix(iamcredentials): update the API #### iamcredentials:v1 The following keys were changed: - description --- discovery/iamcredentials-v1.json | 4 ++-- src/apis/iamcredentials/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/iamcredentials-v1.json b/discovery/iamcredentials-v1.json index 0c82b86a100..633d334df40 100644 --- a/discovery/iamcredentials-v1.json +++ b/discovery/iamcredentials-v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://iamcredentials.googleapis.com/", "batchPath": "batch", "canonicalName": "IAM Credentials", - "description": "Creates short-lived credentials for impersonating IAM service accounts. To enable this API, you must enable the IAM API (iam.googleapis.com). ", + "description": "Creates short-lived credentials for impersonating IAM service accounts. Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials", "fullyEncodeReservedExpansion": true, @@ -226,7 +226,7 @@ } } }, - "revision": "20211203", + "revision": "20240227", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/src/apis/iamcredentials/v1.ts b/src/apis/iamcredentials/v1.ts index e1cf5132caf..5923e674812 100644 --- a/src/apis/iamcredentials/v1.ts +++ b/src/apis/iamcredentials/v1.ts @@ -102,7 +102,7 @@ export namespace iamcredentials_v1 { /** * IAM Service Account Credentials API * - * Creates short-lived credentials for impersonating IAM service accounts. To enable this API, you must enable the IAM API (iam.googleapis.com). + * Creates short-lived credentials for impersonating IAM service accounts. Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API. * * @example * ```js From 1972ea604b5d67ece5986888f12150f601980ab1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:51 +0000 Subject: [PATCH 47/78] feat(language)!: update the API BREAKING CHANGE: This release has breaking changes. #### language:v1 The following keys were deleted: - schemas.Features.description - schemas.Features.id - schemas.Features.properties.classificationModelOptions.$ref - schemas.Features.properties.classificationModelOptions.description - schemas.Features.properties.classifyText.description - schemas.Features.properties.classifyText.type - schemas.Features.properties.extractDocumentSentiment.description - schemas.Features.properties.extractDocumentSentiment.type - schemas.Features.properties.extractEntities.description - schemas.Features.properties.extractEntities.type - schemas.Features.properties.extractEntitySentiment.description - schemas.Features.properties.extractEntitySentiment.type - schemas.Features.properties.extractSyntax.description - schemas.Features.properties.extractSyntax.type - schemas.Features.properties.moderateText.description - schemas.Features.properties.moderateText.type - schemas.Features.type - schemas.V1Model.description - schemas.V1Model.id - schemas.V1Model.type - schemas.V2Model.description - schemas.V2Model.id - schemas.V2Model.properties.contentCategoriesVersion.description - schemas.V2Model.properties.contentCategoriesVersion.enum - schemas.V2Model.properties.contentCategoriesVersion.enumDescriptions - schemas.V2Model.properties.contentCategoriesVersion.type - schemas.V2Model.type The following keys were added: - schemas.AnnotateTextRequestFeatures.description - schemas.AnnotateTextRequestFeatures.id - schemas.AnnotateTextRequestFeatures.properties.classificationModelOptions.$ref - schemas.AnnotateTextRequestFeatures.properties.classificationModelOptions.description - schemas.AnnotateTextRequestFeatures.properties.classifyText.description - schemas.AnnotateTextRequestFeatures.properties.classifyText.type - schemas.AnnotateTextRequestFeatures.properties.extractDocumentSentiment.description - schemas.AnnotateTextRequestFeatures.properties.extractDocumentSentiment.type - schemas.AnnotateTextRequestFeatures.properties.extractEntities.description - schemas.AnnotateTextRequestFeatures.properties.extractEntities.type - schemas.AnnotateTextRequestFeatures.properties.extractEntitySentiment.description - schemas.AnnotateTextRequestFeatures.properties.extractEntitySentiment.type - schemas.AnnotateTextRequestFeatures.properties.extractSyntax.description - schemas.AnnotateTextRequestFeatures.properties.extractSyntax.type - schemas.AnnotateTextRequestFeatures.properties.moderateText.description - schemas.AnnotateTextRequestFeatures.properties.moderateText.type - schemas.AnnotateTextRequestFeatures.type - schemas.ClassificationModelOptionsV1Model.description - schemas.ClassificationModelOptionsV1Model.id - schemas.ClassificationModelOptionsV1Model.type - schemas.ClassificationModelOptionsV2Model.description - schemas.ClassificationModelOptionsV2Model.id - schemas.ClassificationModelOptionsV2Model.properties.contentCategoriesVersion.description - schemas.ClassificationModelOptionsV2Model.properties.contentCategoriesVersion.enum - schemas.ClassificationModelOptionsV2Model.properties.contentCategoriesVersion.enumDescriptions - schemas.ClassificationModelOptionsV2Model.properties.contentCategoriesVersion.type - schemas.ClassificationModelOptionsV2Model.type - schemas.Color.description - schemas.Color.id - schemas.Color.properties.alpha.description - schemas.Color.properties.alpha.format - schemas.Color.properties.alpha.type - schemas.Color.properties.blue.description - schemas.Color.properties.blue.format - schemas.Color.properties.blue.type - schemas.Color.properties.green.description - schemas.Color.properties.green.format - schemas.Color.properties.green.type - schemas.Color.properties.red.description - schemas.Color.properties.red.format - schemas.Color.properties.red.type - schemas.Color.type - schemas.CpuMetric.description - schemas.CpuMetric.id - schemas.CpuMetric.properties.coreNumber.description - schemas.CpuMetric.properties.coreNumber.format - schemas.CpuMetric.properties.coreNumber.type - schemas.CpuMetric.properties.coreSec.description - schemas.CpuMetric.properties.coreSec.format - schemas.CpuMetric.properties.coreSec.type - schemas.CpuMetric.properties.cpuType.description - schemas.CpuMetric.properties.cpuType.enum - schemas.CpuMetric.properties.cpuType.enumDescriptions - schemas.CpuMetric.properties.cpuType.type - schemas.CpuMetric.properties.machineSpec.description - schemas.CpuMetric.properties.machineSpec.enum - schemas.CpuMetric.properties.machineSpec.enumDescriptions - schemas.CpuMetric.properties.machineSpec.type - schemas.CpuMetric.properties.trackingLabels.additionalProperties.type - schemas.CpuMetric.properties.trackingLabels.description - schemas.CpuMetric.properties.trackingLabels.type - schemas.CpuMetric.type - schemas.DiskMetric.id - schemas.DiskMetric.properties.diskType.description - schemas.DiskMetric.properties.diskType.enum - schemas.DiskMetric.properties.diskType.enumDescriptions - schemas.DiskMetric.properties.diskType.type - schemas.DiskMetric.properties.gibSec.description - schemas.DiskMetric.properties.gibSec.format - schemas.DiskMetric.properties.gibSec.type - schemas.DiskMetric.type - schemas.GpuMetric.id - schemas.GpuMetric.properties.gpuSec.description - schemas.GpuMetric.properties.gpuSec.format - schemas.GpuMetric.properties.gpuSec.type - schemas.GpuMetric.properties.gpuType.description - schemas.GpuMetric.properties.gpuType.enum - schemas.GpuMetric.properties.gpuType.enumDescriptions - schemas.GpuMetric.properties.gpuType.type - schemas.GpuMetric.properties.machineSpec.description - schemas.GpuMetric.properties.machineSpec.enum - schemas.GpuMetric.properties.machineSpec.enumDescriptions - schemas.GpuMetric.properties.machineSpec.type - schemas.GpuMetric.properties.trackingLabels.additionalProperties.type - schemas.GpuMetric.properties.trackingLabels.description - schemas.GpuMetric.properties.trackingLabels.type - schemas.GpuMetric.type - schemas.InfraUsage.description - schemas.InfraUsage.id - schemas.InfraUsage.properties.cpuMetrics.description - schemas.InfraUsage.properties.cpuMetrics.items.$ref - schemas.InfraUsage.properties.cpuMetrics.type - schemas.InfraUsage.properties.diskMetrics.description - schemas.InfraUsage.properties.diskMetrics.items.$ref - schemas.InfraUsage.properties.diskMetrics.type - schemas.InfraUsage.properties.gpuMetrics.description - schemas.InfraUsage.properties.gpuMetrics.items.$ref - schemas.InfraUsage.properties.gpuMetrics.type - schemas.InfraUsage.properties.ramMetrics.description - schemas.InfraUsage.properties.ramMetrics.items.$ref - schemas.InfraUsage.properties.ramMetrics.type - schemas.InfraUsage.properties.tpuMetrics.description - schemas.InfraUsage.properties.tpuMetrics.items.$ref - schemas.InfraUsage.properties.tpuMetrics.type - schemas.InfraUsage.type - schemas.RamMetric.id - schemas.RamMetric.properties.gibSec.description - schemas.RamMetric.properties.gibSec.format - schemas.RamMetric.properties.gibSec.type - schemas.RamMetric.properties.machineSpec.description - schemas.RamMetric.properties.machineSpec.enum - schemas.RamMetric.properties.machineSpec.enumDescriptions - schemas.RamMetric.properties.machineSpec.type - schemas.RamMetric.properties.memories.description - schemas.RamMetric.properties.memories.format - schemas.RamMetric.properties.memories.type - schemas.RamMetric.properties.ramType.description - schemas.RamMetric.properties.ramType.enum - schemas.RamMetric.properties.ramType.enumDescriptions - schemas.RamMetric.properties.ramType.type - schemas.RamMetric.properties.trackingLabels.additionalProperties.type - schemas.RamMetric.properties.trackingLabels.description - schemas.RamMetric.properties.trackingLabels.type - schemas.RamMetric.type - schemas.TpuMetric.id - schemas.TpuMetric.properties.tpuSec.description - schemas.TpuMetric.properties.tpuSec.format - schemas.TpuMetric.properties.tpuSec.type - schemas.TpuMetric.properties.tpuType.description - schemas.TpuMetric.properties.tpuType.enum - schemas.TpuMetric.properties.tpuType.enumDescriptions - schemas.TpuMetric.properties.tpuType.type - schemas.TpuMetric.type - schemas.XPSArrayStats.description - schemas.XPSArrayStats.id - schemas.XPSArrayStats.properties.commonStats.$ref - schemas.XPSArrayStats.properties.memberStats.$ref - schemas.XPSArrayStats.properties.memberStats.description - schemas.XPSArrayStats.type - schemas.XPSBatchPredictResponse.id - schemas.XPSBatchPredictResponse.properties.exampleSet.$ref - schemas.XPSBatchPredictResponse.properties.exampleSet.description - schemas.XPSBatchPredictResponse.type - schemas.XPSBoundingBoxMetricsEntry.description - schemas.XPSBoundingBoxMetricsEntry.id - schemas.XPSBoundingBoxMetricsEntry.properties.confidenceMetricsEntries.description - schemas.XPSBoundingBoxMetricsEntry.properties.confidenceMetricsEntries.items.$ref - schemas.XPSBoundingBoxMetricsEntry.properties.confidenceMetricsEntries.type - schemas.XPSBoundingBoxMetricsEntry.properties.iouThreshold.description - schemas.XPSBoundingBoxMetricsEntry.properties.iouThreshold.format - schemas.XPSBoundingBoxMetricsEntry.properties.iouThreshold.type - schemas.XPSBoundingBoxMetricsEntry.properties.meanAveragePrecision.description - schemas.XPSBoundingBoxMetricsEntry.properties.meanAveragePrecision.format - schemas.XPSBoundingBoxMetricsEntry.properties.meanAveragePrecision.type - schemas.XPSBoundingBoxMetricsEntry.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.id - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.f1Score.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.f1Score.format - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.f1Score.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.precision.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.precision.format - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.precision.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.recall.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.recall.format - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.recall.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.type - schemas.XPSCategoryStats.description - schemas.XPSCategoryStats.id - schemas.XPSCategoryStats.properties.commonStats.$ref - schemas.XPSCategoryStats.properties.topCategoryStats.description - schemas.XPSCategoryStats.properties.topCategoryStats.items.$ref - schemas.XPSCategoryStats.properties.topCategoryStats.type - schemas.XPSCategoryStats.type - schemas.XPSCategoryStatsSingleCategoryStats.description - schemas.XPSCategoryStatsSingleCategoryStats.id - schemas.XPSCategoryStatsSingleCategoryStats.properties.count.description - schemas.XPSCategoryStatsSingleCategoryStats.properties.count.format - schemas.XPSCategoryStatsSingleCategoryStats.properties.count.type - schemas.XPSCategoryStatsSingleCategoryStats.properties.value.description - schemas.XPSCategoryStatsSingleCategoryStats.properties.value.type - schemas.XPSCategoryStatsSingleCategoryStats.type - schemas.XPSClassificationEvaluationMetrics.description - schemas.XPSClassificationEvaluationMetrics.id - schemas.XPSClassificationEvaluationMetrics.properties.auPrc.description - schemas.XPSClassificationEvaluationMetrics.properties.auPrc.format - schemas.XPSClassificationEvaluationMetrics.properties.auPrc.type - schemas.XPSClassificationEvaluationMetrics.properties.auRoc.description - schemas.XPSClassificationEvaluationMetrics.properties.auRoc.format - schemas.XPSClassificationEvaluationMetrics.properties.auRoc.type - schemas.XPSClassificationEvaluationMetrics.properties.baseAuPrc.description - schemas.XPSClassificationEvaluationMetrics.properties.baseAuPrc.format - schemas.XPSClassificationEvaluationMetrics.properties.baseAuPrc.type - schemas.XPSClassificationEvaluationMetrics.properties.confidenceMetricsEntries.description - schemas.XPSClassificationEvaluationMetrics.properties.confidenceMetricsEntries.items.$ref - schemas.XPSClassificationEvaluationMetrics.properties.confidenceMetricsEntries.type - schemas.XPSClassificationEvaluationMetrics.properties.confusionMatrix.$ref - schemas.XPSClassificationEvaluationMetrics.properties.confusionMatrix.description - schemas.XPSClassificationEvaluationMetrics.properties.evaluatedExamplesCount.description - schemas.XPSClassificationEvaluationMetrics.properties.evaluatedExamplesCount.format - schemas.XPSClassificationEvaluationMetrics.properties.evaluatedExamplesCount.type - schemas.XPSClassificationEvaluationMetrics.properties.logLoss.description - schemas.XPSClassificationEvaluationMetrics.properties.logLoss.format - schemas.XPSClassificationEvaluationMetrics.properties.logLoss.type - schemas.XPSClassificationEvaluationMetrics.type - schemas.XPSColorMap.description - schemas.XPSColorMap.id - schemas.XPSColorMap.properties.annotationSpecIdToken.description - schemas.XPSColorMap.properties.annotationSpecIdToken.type - schemas.XPSColorMap.properties.color.$ref - schemas.XPSColorMap.properties.color.deprecated - schemas.XPSColorMap.properties.color.description - schemas.XPSColorMap.properties.displayName.description - schemas.XPSColorMap.properties.displayName.type - schemas.XPSColorMap.properties.intColor.$ref - schemas.XPSColorMap.type - schemas.XPSColorMapIntColor.description - schemas.XPSColorMapIntColor.id - schemas.XPSColorMapIntColor.properties.blue.description - schemas.XPSColorMapIntColor.properties.blue.format - schemas.XPSColorMapIntColor.properties.blue.type - schemas.XPSColorMapIntColor.properties.green.description - schemas.XPSColorMapIntColor.properties.green.format - schemas.XPSColorMapIntColor.properties.green.type - schemas.XPSColorMapIntColor.properties.red.description - schemas.XPSColorMapIntColor.properties.red.format - schemas.XPSColorMapIntColor.properties.red.type - schemas.XPSColorMapIntColor.type - schemas.XPSColumnSpec.id - schemas.XPSColumnSpec.properties.columnId.description - schemas.XPSColumnSpec.properties.columnId.format - schemas.XPSColumnSpec.properties.columnId.type - schemas.XPSColumnSpec.properties.dataStats.$ref - schemas.XPSColumnSpec.properties.dataStats.description - schemas.XPSColumnSpec.properties.dataType.$ref - schemas.XPSColumnSpec.properties.dataType.description - schemas.XPSColumnSpec.properties.displayName.description - schemas.XPSColumnSpec.properties.displayName.type - schemas.XPSColumnSpec.properties.forecastingMetadata.$ref - schemas.XPSColumnSpec.properties.topCorrelatedColumns.description - schemas.XPSColumnSpec.properties.topCorrelatedColumns.items.$ref - schemas.XPSColumnSpec.properties.topCorrelatedColumns.type - schemas.XPSColumnSpec.type - schemas.XPSColumnSpecCorrelatedColumn.description - schemas.XPSColumnSpecCorrelatedColumn.id - schemas.XPSColumnSpecCorrelatedColumn.properties.columnId.format - schemas.XPSColumnSpecCorrelatedColumn.properties.columnId.type - schemas.XPSColumnSpecCorrelatedColumn.properties.correlationStats.$ref - schemas.XPSColumnSpecCorrelatedColumn.type - schemas.XPSColumnSpecForecastingMetadata.description - schemas.XPSColumnSpecForecastingMetadata.id - schemas.XPSColumnSpecForecastingMetadata.properties.columnType.description - schemas.XPSColumnSpecForecastingMetadata.properties.columnType.enum - schemas.XPSColumnSpecForecastingMetadata.properties.columnType.enumDescriptions - schemas.XPSColumnSpecForecastingMetadata.properties.columnType.type - schemas.XPSColumnSpecForecastingMetadata.type - schemas.XPSCommonStats.description - schemas.XPSCommonStats.id - schemas.XPSCommonStats.properties.distinctValueCount.format - schemas.XPSCommonStats.properties.distinctValueCount.type - schemas.XPSCommonStats.properties.nullValueCount.format - schemas.XPSCommonStats.properties.nullValueCount.type - schemas.XPSCommonStats.properties.validValueCount.format - schemas.XPSCommonStats.properties.validValueCount.type - schemas.XPSCommonStats.type - schemas.XPSConfidenceMetricsEntry.description - schemas.XPSConfidenceMetricsEntry.id - schemas.XPSConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSConfidenceMetricsEntry.properties.f1Score.description - schemas.XPSConfidenceMetricsEntry.properties.f1Score.format - schemas.XPSConfidenceMetricsEntry.properties.f1Score.type - schemas.XPSConfidenceMetricsEntry.properties.f1ScoreAt1.description - schemas.XPSConfidenceMetricsEntry.properties.f1ScoreAt1.format - schemas.XPSConfidenceMetricsEntry.properties.f1ScoreAt1.type - schemas.XPSConfidenceMetricsEntry.properties.falseNegativeCount.description - schemas.XPSConfidenceMetricsEntry.properties.falseNegativeCount.format - schemas.XPSConfidenceMetricsEntry.properties.falseNegativeCount.type - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveCount.description - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveCount.format - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveCount.type - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRate.description - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRate.format - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRate.type - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRateAt1.description - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRateAt1.format - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRateAt1.type - schemas.XPSConfidenceMetricsEntry.properties.positionThreshold.description - schemas.XPSConfidenceMetricsEntry.properties.positionThreshold.format - schemas.XPSConfidenceMetricsEntry.properties.positionThreshold.type - schemas.XPSConfidenceMetricsEntry.properties.precision.description - schemas.XPSConfidenceMetricsEntry.properties.precision.format - schemas.XPSConfidenceMetricsEntry.properties.precision.type - schemas.XPSConfidenceMetricsEntry.properties.precisionAt1.description - schemas.XPSConfidenceMetricsEntry.properties.precisionAt1.format - schemas.XPSConfidenceMetricsEntry.properties.precisionAt1.type - schemas.XPSConfidenceMetricsEntry.properties.recall.description - schemas.XPSConfidenceMetricsEntry.properties.recall.format - schemas.XPSConfidenceMetricsEntry.properties.recall.type - schemas.XPSConfidenceMetricsEntry.properties.recallAt1.description - schemas.XPSConfidenceMetricsEntry.properties.recallAt1.format - schemas.XPSConfidenceMetricsEntry.properties.recallAt1.type - schemas.XPSConfidenceMetricsEntry.properties.trueNegativeCount.description - schemas.XPSConfidenceMetricsEntry.properties.trueNegativeCount.format - schemas.XPSConfidenceMetricsEntry.properties.trueNegativeCount.type - schemas.XPSConfidenceMetricsEntry.properties.truePositiveCount.description - schemas.XPSConfidenceMetricsEntry.properties.truePositiveCount.format - schemas.XPSConfidenceMetricsEntry.properties.truePositiveCount.type - schemas.XPSConfidenceMetricsEntry.type - schemas.XPSConfusionMatrix.description - schemas.XPSConfusionMatrix.id - schemas.XPSConfusionMatrix.properties.annotationSpecIdToken.description - schemas.XPSConfusionMatrix.properties.annotationSpecIdToken.items.type - schemas.XPSConfusionMatrix.properties.annotationSpecIdToken.type - schemas.XPSConfusionMatrix.properties.category.description - schemas.XPSConfusionMatrix.properties.category.items.format - schemas.XPSConfusionMatrix.properties.category.items.type - schemas.XPSConfusionMatrix.properties.category.type - schemas.XPSConfusionMatrix.properties.row.description - schemas.XPSConfusionMatrix.properties.row.items.$ref - schemas.XPSConfusionMatrix.properties.row.type - schemas.XPSConfusionMatrix.properties.sentimentLabel.description - schemas.XPSConfusionMatrix.properties.sentimentLabel.items.format - schemas.XPSConfusionMatrix.properties.sentimentLabel.items.type - schemas.XPSConfusionMatrix.properties.sentimentLabel.type - schemas.XPSConfusionMatrix.type - schemas.XPSConfusionMatrixRow.description - schemas.XPSConfusionMatrixRow.id - schemas.XPSConfusionMatrixRow.properties.count.description - schemas.XPSConfusionMatrixRow.properties.count.items.format - schemas.XPSConfusionMatrixRow.properties.count.items.type - schemas.XPSConfusionMatrixRow.properties.count.type - schemas.XPSConfusionMatrixRow.properties.exampleCount.description - schemas.XPSConfusionMatrixRow.properties.exampleCount.items.format - schemas.XPSConfusionMatrixRow.properties.exampleCount.items.type - schemas.XPSConfusionMatrixRow.properties.exampleCount.type - schemas.XPSConfusionMatrixRow.type - schemas.XPSCoreMlFormat.description - schemas.XPSCoreMlFormat.id - schemas.XPSCoreMlFormat.type - schemas.XPSCorrelationStats.description - schemas.XPSCorrelationStats.id - schemas.XPSCorrelationStats.properties.cramersV.description - schemas.XPSCorrelationStats.properties.cramersV.format - schemas.XPSCorrelationStats.properties.cramersV.type - schemas.XPSCorrelationStats.type - schemas.XPSDataErrors.description - schemas.XPSDataErrors.id - schemas.XPSDataErrors.properties.count.description - schemas.XPSDataErrors.properties.count.format - schemas.XPSDataErrors.properties.count.type - schemas.XPSDataErrors.properties.errorType.description - schemas.XPSDataErrors.properties.errorType.enum - schemas.XPSDataErrors.properties.errorType.enumDescriptions - schemas.XPSDataErrors.properties.errorType.type - schemas.XPSDataErrors.type - schemas.XPSDataStats.description - schemas.XPSDataStats.id - schemas.XPSDataStats.properties.arrayStats.$ref - schemas.XPSDataStats.properties.arrayStats.description - schemas.XPSDataStats.properties.categoryStats.$ref - schemas.XPSDataStats.properties.categoryStats.description - schemas.XPSDataStats.properties.distinctValueCount.description - schemas.XPSDataStats.properties.distinctValueCount.format - schemas.XPSDataStats.properties.distinctValueCount.type - schemas.XPSDataStats.properties.float64Stats.$ref - schemas.XPSDataStats.properties.float64Stats.description - schemas.XPSDataStats.properties.nullValueCount.description - schemas.XPSDataStats.properties.nullValueCount.format - schemas.XPSDataStats.properties.nullValueCount.type - schemas.XPSDataStats.properties.stringStats.$ref - schemas.XPSDataStats.properties.stringStats.description - schemas.XPSDataStats.properties.structStats.$ref - schemas.XPSDataStats.properties.structStats.description - schemas.XPSDataStats.properties.timestampStats.$ref - schemas.XPSDataStats.properties.timestampStats.description - schemas.XPSDataStats.properties.validValueCount.description - schemas.XPSDataStats.properties.validValueCount.format - schemas.XPSDataStats.properties.validValueCount.type - schemas.XPSDataStats.type - schemas.XPSDataType.description - schemas.XPSDataType.id - schemas.XPSDataType.properties.compatibleDataTypes.description - schemas.XPSDataType.properties.compatibleDataTypes.items.$ref - schemas.XPSDataType.properties.compatibleDataTypes.type - schemas.XPSDataType.properties.listElementType.$ref - schemas.XPSDataType.properties.listElementType.description - schemas.XPSDataType.properties.nullable.description - schemas.XPSDataType.properties.nullable.type - schemas.XPSDataType.properties.structType.$ref - schemas.XPSDataType.properties.structType.description - schemas.XPSDataType.properties.timeFormat.description - schemas.XPSDataType.properties.timeFormat.type - schemas.XPSDataType.properties.typeCode.description - schemas.XPSDataType.properties.typeCode.enum - schemas.XPSDataType.properties.typeCode.enumDescriptions - schemas.XPSDataType.properties.typeCode.type - schemas.XPSDataType.type - schemas.XPSDockerFormat.description - schemas.XPSDockerFormat.id - schemas.XPSDockerFormat.properties.cpuArchitecture.description - schemas.XPSDockerFormat.properties.cpuArchitecture.enum - schemas.XPSDockerFormat.properties.cpuArchitecture.enumDescriptions - schemas.XPSDockerFormat.properties.cpuArchitecture.type - schemas.XPSDockerFormat.properties.gpuArchitecture.description - schemas.XPSDockerFormat.properties.gpuArchitecture.enum - schemas.XPSDockerFormat.properties.gpuArchitecture.enumDescriptions - schemas.XPSDockerFormat.properties.gpuArchitecture.type - schemas.XPSDockerFormat.type - schemas.XPSEdgeTpuTfLiteFormat.description - schemas.XPSEdgeTpuTfLiteFormat.id - schemas.XPSEdgeTpuTfLiteFormat.type - schemas.XPSEvaluationMetrics.description - schemas.XPSEvaluationMetrics.id - schemas.XPSEvaluationMetrics.properties.annotationSpecIdToken.description - schemas.XPSEvaluationMetrics.properties.annotationSpecIdToken.type - schemas.XPSEvaluationMetrics.properties.category.description - schemas.XPSEvaluationMetrics.properties.category.format - schemas.XPSEvaluationMetrics.properties.category.type - schemas.XPSEvaluationMetrics.properties.evaluatedExampleCount.description - schemas.XPSEvaluationMetrics.properties.evaluatedExampleCount.format - schemas.XPSEvaluationMetrics.properties.evaluatedExampleCount.type - schemas.XPSEvaluationMetrics.properties.imageClassificationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.imageObjectDetectionEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.imageSegmentationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.label.description - schemas.XPSEvaluationMetrics.properties.label.type - schemas.XPSEvaluationMetrics.properties.regressionEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.tablesClassificationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.tablesEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.textClassificationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.textExtractionEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.textSentimentEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.translationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.videoActionRecognitionEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.videoClassificationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.videoObjectTrackingEvalMetrics.$ref - schemas.XPSEvaluationMetrics.type - schemas.XPSEvaluationMetricsSet.description - schemas.XPSEvaluationMetricsSet.id - schemas.XPSEvaluationMetricsSet.properties.evaluationMetrics.description - schemas.XPSEvaluationMetricsSet.properties.evaluationMetrics.items.$ref - schemas.XPSEvaluationMetricsSet.properties.evaluationMetrics.type - schemas.XPSEvaluationMetricsSet.properties.fileSpec.$ref - schemas.XPSEvaluationMetricsSet.properties.fileSpec.description - schemas.XPSEvaluationMetricsSet.properties.numEvaluationMetrics.description - schemas.XPSEvaluationMetricsSet.properties.numEvaluationMetrics.format - schemas.XPSEvaluationMetricsSet.properties.numEvaluationMetrics.type - schemas.XPSEvaluationMetricsSet.type - schemas.XPSExampleSet.description - schemas.XPSExampleSet.id - schemas.XPSExampleSet.properties.fileSpec.$ref - schemas.XPSExampleSet.properties.fileSpec.description - schemas.XPSExampleSet.properties.fingerprint.description - schemas.XPSExampleSet.properties.fingerprint.format - schemas.XPSExampleSet.properties.fingerprint.type - schemas.XPSExampleSet.properties.numExamples.description - schemas.XPSExampleSet.properties.numExamples.format - schemas.XPSExampleSet.properties.numExamples.type - schemas.XPSExampleSet.properties.numInputSources.description - schemas.XPSExampleSet.properties.numInputSources.format - schemas.XPSExampleSet.properties.numInputSources.type - schemas.XPSExampleSet.type - schemas.XPSExportModelOutputConfig.id - schemas.XPSExportModelOutputConfig.properties.coreMlFormat.$ref - schemas.XPSExportModelOutputConfig.properties.dockerFormat.$ref - schemas.XPSExportModelOutputConfig.properties.edgeTpuTfLiteFormat.$ref - schemas.XPSExportModelOutputConfig.properties.exportFirebaseAuxiliaryInfo.description - schemas.XPSExportModelOutputConfig.properties.exportFirebaseAuxiliaryInfo.type - schemas.XPSExportModelOutputConfig.properties.outputGcrUri.description - schemas.XPSExportModelOutputConfig.properties.outputGcrUri.type - schemas.XPSExportModelOutputConfig.properties.outputGcsUri.description - schemas.XPSExportModelOutputConfig.properties.outputGcsUri.type - schemas.XPSExportModelOutputConfig.properties.tfJsFormat.$ref - schemas.XPSExportModelOutputConfig.properties.tfLiteFormat.$ref - schemas.XPSExportModelOutputConfig.properties.tfSavedModelFormat.$ref - schemas.XPSExportModelOutputConfig.type - schemas.XPSFileSpec.description - schemas.XPSFileSpec.id - schemas.XPSFileSpec.properties.directoryPath.deprecated - schemas.XPSFileSpec.properties.directoryPath.description - schemas.XPSFileSpec.properties.directoryPath.type - schemas.XPSFileSpec.properties.fileFormat.enum - schemas.XPSFileSpec.properties.fileFormat.enumDeprecated - schemas.XPSFileSpec.properties.fileFormat.enumDescriptions - schemas.XPSFileSpec.properties.fileFormat.type - schemas.XPSFileSpec.properties.fileSpec.description - schemas.XPSFileSpec.properties.fileSpec.type - schemas.XPSFileSpec.properties.singleFilePath.deprecated - schemas.XPSFileSpec.properties.singleFilePath.description - schemas.XPSFileSpec.properties.singleFilePath.type - schemas.XPSFileSpec.type - schemas.XPSFloat64Stats.description - schemas.XPSFloat64Stats.id - schemas.XPSFloat64Stats.properties.commonStats.$ref - schemas.XPSFloat64Stats.properties.histogramBuckets.description - schemas.XPSFloat64Stats.properties.histogramBuckets.items.$ref - schemas.XPSFloat64Stats.properties.histogramBuckets.type - schemas.XPSFloat64Stats.properties.mean.description - schemas.XPSFloat64Stats.properties.mean.format - schemas.XPSFloat64Stats.properties.mean.type - schemas.XPSFloat64Stats.properties.quantiles.description - schemas.XPSFloat64Stats.properties.quantiles.items.format - schemas.XPSFloat64Stats.properties.quantiles.items.type - schemas.XPSFloat64Stats.properties.quantiles.type - schemas.XPSFloat64Stats.properties.standardDeviation.description - schemas.XPSFloat64Stats.properties.standardDeviation.format - schemas.XPSFloat64Stats.properties.standardDeviation.type - schemas.XPSFloat64Stats.type - schemas.XPSFloat64StatsHistogramBucket.description - schemas.XPSFloat64StatsHistogramBucket.id - schemas.XPSFloat64StatsHistogramBucket.properties.count.description - schemas.XPSFloat64StatsHistogramBucket.properties.count.format - schemas.XPSFloat64StatsHistogramBucket.properties.count.type - schemas.XPSFloat64StatsHistogramBucket.properties.max.description - schemas.XPSFloat64StatsHistogramBucket.properties.max.format - schemas.XPSFloat64StatsHistogramBucket.properties.max.type - schemas.XPSFloat64StatsHistogramBucket.properties.min.description - schemas.XPSFloat64StatsHistogramBucket.properties.min.format - schemas.XPSFloat64StatsHistogramBucket.properties.min.type - schemas.XPSFloat64StatsHistogramBucket.type - schemas.XPSImageClassificationTrainResponse.id - schemas.XPSImageClassificationTrainResponse.properties.classCount.description - schemas.XPSImageClassificationTrainResponse.properties.classCount.format - schemas.XPSImageClassificationTrainResponse.properties.classCount.type - schemas.XPSImageClassificationTrainResponse.properties.exportModelSpec.$ref - schemas.XPSImageClassificationTrainResponse.properties.exportModelSpec.description - schemas.XPSImageClassificationTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSImageClassificationTrainResponse.properties.modelArtifactSpec.description - schemas.XPSImageClassificationTrainResponse.properties.modelServingSpec.$ref - schemas.XPSImageClassificationTrainResponse.properties.stopReason.description - schemas.XPSImageClassificationTrainResponse.properties.stopReason.enum - schemas.XPSImageClassificationTrainResponse.properties.stopReason.enumDescriptions - schemas.XPSImageClassificationTrainResponse.properties.stopReason.type - schemas.XPSImageClassificationTrainResponse.properties.trainCostInNodeTime.description - schemas.XPSImageClassificationTrainResponse.properties.trainCostInNodeTime.format - schemas.XPSImageClassificationTrainResponse.properties.trainCostInNodeTime.type - schemas.XPSImageClassificationTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSImageClassificationTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSImageClassificationTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSImageClassificationTrainResponse.type - schemas.XPSImageExportModelSpec.description - schemas.XPSImageExportModelSpec.id - schemas.XPSImageExportModelSpec.properties.exportModelOutputConfig.description - schemas.XPSImageExportModelSpec.properties.exportModelOutputConfig.items.$ref - schemas.XPSImageExportModelSpec.properties.exportModelOutputConfig.type - schemas.XPSImageExportModelSpec.type - schemas.XPSImageModelArtifactSpec.description - schemas.XPSImageModelArtifactSpec.id - schemas.XPSImageModelArtifactSpec.properties.checkpointArtifact.$ref - schemas.XPSImageModelArtifactSpec.properties.checkpointArtifact.description - schemas.XPSImageModelArtifactSpec.properties.exportArtifact.description - schemas.XPSImageModelArtifactSpec.properties.exportArtifact.items.$ref - schemas.XPSImageModelArtifactSpec.properties.exportArtifact.type - schemas.XPSImageModelArtifactSpec.properties.labelGcsUri.description - schemas.XPSImageModelArtifactSpec.properties.labelGcsUri.type - schemas.XPSImageModelArtifactSpec.properties.servingArtifact.$ref - schemas.XPSImageModelArtifactSpec.properties.servingArtifact.description - schemas.XPSImageModelArtifactSpec.properties.tfJsBinaryGcsPrefix.description - schemas.XPSImageModelArtifactSpec.properties.tfJsBinaryGcsPrefix.type - schemas.XPSImageModelArtifactSpec.properties.tfLiteMetadataGcsUri.description - schemas.XPSImageModelArtifactSpec.properties.tfLiteMetadataGcsUri.type - schemas.XPSImageModelArtifactSpec.type - schemas.XPSImageModelServingSpec.description - schemas.XPSImageModelServingSpec.id - schemas.XPSImageModelServingSpec.properties.modelThroughputEstimation.description - schemas.XPSImageModelServingSpec.properties.modelThroughputEstimation.items.$ref - schemas.XPSImageModelServingSpec.properties.modelThroughputEstimation.type - schemas.XPSImageModelServingSpec.properties.nodeQps.description - schemas.XPSImageModelServingSpec.properties.nodeQps.format - schemas.XPSImageModelServingSpec.properties.nodeQps.type - schemas.XPSImageModelServingSpec.properties.tfRuntimeVersion.description - schemas.XPSImageModelServingSpec.properties.tfRuntimeVersion.type - schemas.XPSImageModelServingSpec.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.id - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.computeEngineAcceleratorType.enum - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.computeEngineAcceleratorType.enumDescriptions - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.computeEngineAcceleratorType.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.latencyInMilliseconds.description - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.latencyInMilliseconds.format - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.latencyInMilliseconds.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.nodeQps.description - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.nodeQps.format - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.nodeQps.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.servomaticPartitionType.enum - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.servomaticPartitionType.enumDescriptions - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.servomaticPartitionType.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.type - schemas.XPSImageObjectDetectionEvaluationMetrics.description - schemas.XPSImageObjectDetectionEvaluationMetrics.id - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.description - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.format - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.type - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMetricsEntries.description - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMetricsEntries.items.$ref - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMetricsEntries.type - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.evaluatedBoundingBoxCount.description - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.evaluatedBoundingBoxCount.format - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.evaluatedBoundingBoxCount.type - schemas.XPSImageObjectDetectionEvaluationMetrics.type - schemas.XPSImageObjectDetectionModelSpec.id - schemas.XPSImageObjectDetectionModelSpec.properties.classCount.description - schemas.XPSImageObjectDetectionModelSpec.properties.classCount.format - schemas.XPSImageObjectDetectionModelSpec.properties.classCount.type - schemas.XPSImageObjectDetectionModelSpec.properties.exportModelSpec.$ref - schemas.XPSImageObjectDetectionModelSpec.properties.maxBoundingBoxCount.description - schemas.XPSImageObjectDetectionModelSpec.properties.maxBoundingBoxCount.format - schemas.XPSImageObjectDetectionModelSpec.properties.maxBoundingBoxCount.type - schemas.XPSImageObjectDetectionModelSpec.properties.modelArtifactSpec.$ref - schemas.XPSImageObjectDetectionModelSpec.properties.modelArtifactSpec.description - schemas.XPSImageObjectDetectionModelSpec.properties.modelServingSpec.$ref - schemas.XPSImageObjectDetectionModelSpec.properties.stopReason.description - schemas.XPSImageObjectDetectionModelSpec.properties.stopReason.enum - schemas.XPSImageObjectDetectionModelSpec.properties.stopReason.enumDescriptions - schemas.XPSImageObjectDetectionModelSpec.properties.stopReason.type - schemas.XPSImageObjectDetectionModelSpec.properties.trainCostNodeSeconds.description - schemas.XPSImageObjectDetectionModelSpec.properties.trainCostNodeSeconds.format - schemas.XPSImageObjectDetectionModelSpec.properties.trainCostNodeSeconds.type - schemas.XPSImageObjectDetectionModelSpec.type - schemas.XPSImageSegmentationEvaluationMetrics.description - schemas.XPSImageSegmentationEvaluationMetrics.id - schemas.XPSImageSegmentationEvaluationMetrics.properties.confidenceMetricsEntries.description - schemas.XPSImageSegmentationEvaluationMetrics.properties.confidenceMetricsEntries.items.$ref - schemas.XPSImageSegmentationEvaluationMetrics.properties.confidenceMetricsEntries.type - schemas.XPSImageSegmentationEvaluationMetrics.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.id - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confusionMatrix.$ref - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confusionMatrix.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.diceScoreCoefficient.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.diceScoreCoefficient.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.diceScoreCoefficient.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.iouScore.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.iouScore.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.iouScore.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.precision.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.precision.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.precision.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.recall.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.recall.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.recall.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.type - schemas.XPSImageSegmentationTrainResponse.id - schemas.XPSImageSegmentationTrainResponse.properties.colorMaps.description - schemas.XPSImageSegmentationTrainResponse.properties.colorMaps.items.$ref - schemas.XPSImageSegmentationTrainResponse.properties.colorMaps.type - schemas.XPSImageSegmentationTrainResponse.properties.exportModelSpec.$ref - schemas.XPSImageSegmentationTrainResponse.properties.exportModelSpec.description - schemas.XPSImageSegmentationTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSImageSegmentationTrainResponse.properties.modelArtifactSpec.description - schemas.XPSImageSegmentationTrainResponse.properties.modelServingSpec.$ref - schemas.XPSImageSegmentationTrainResponse.properties.stopReason.description - schemas.XPSImageSegmentationTrainResponse.properties.stopReason.enum - schemas.XPSImageSegmentationTrainResponse.properties.stopReason.enumDescriptions - schemas.XPSImageSegmentationTrainResponse.properties.stopReason.type - schemas.XPSImageSegmentationTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSImageSegmentationTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSImageSegmentationTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSImageSegmentationTrainResponse.type - schemas.XPSIntegratedGradientsAttribution.deprecated - schemas.XPSIntegratedGradientsAttribution.description - schemas.XPSIntegratedGradientsAttribution.id - schemas.XPSIntegratedGradientsAttribution.properties.stepCount.description - schemas.XPSIntegratedGradientsAttribution.properties.stepCount.format - schemas.XPSIntegratedGradientsAttribution.properties.stepCount.type - schemas.XPSIntegratedGradientsAttribution.type - schemas.XPSMetricEntry.id - schemas.XPSMetricEntry.properties.argentumMetricId.description - schemas.XPSMetricEntry.properties.argentumMetricId.type - schemas.XPSMetricEntry.properties.doubleValue.description - schemas.XPSMetricEntry.properties.doubleValue.format - schemas.XPSMetricEntry.properties.doubleValue.type - schemas.XPSMetricEntry.properties.int64Value.description - schemas.XPSMetricEntry.properties.int64Value.format - schemas.XPSMetricEntry.properties.int64Value.type - schemas.XPSMetricEntry.properties.metricName.description - schemas.XPSMetricEntry.properties.metricName.type - schemas.XPSMetricEntry.properties.systemLabels.description - schemas.XPSMetricEntry.properties.systemLabels.items.$ref - schemas.XPSMetricEntry.properties.systemLabels.type - schemas.XPSMetricEntry.type - schemas.XPSMetricEntryLabel.id - schemas.XPSMetricEntryLabel.properties.labelName.description - schemas.XPSMetricEntryLabel.properties.labelName.type - schemas.XPSMetricEntryLabel.properties.labelValue.description - schemas.XPSMetricEntryLabel.properties.labelValue.type - schemas.XPSMetricEntryLabel.type - schemas.XPSModelArtifactItem.description - schemas.XPSModelArtifactItem.id - schemas.XPSModelArtifactItem.properties.artifactFormat.description - schemas.XPSModelArtifactItem.properties.artifactFormat.enum - schemas.XPSModelArtifactItem.properties.artifactFormat.enumDescriptions - schemas.XPSModelArtifactItem.properties.artifactFormat.type - schemas.XPSModelArtifactItem.properties.gcsUri.description - schemas.XPSModelArtifactItem.properties.gcsUri.type - schemas.XPSModelArtifactItem.type - schemas.XPSPreprocessResponse.description - schemas.XPSPreprocessResponse.id - schemas.XPSPreprocessResponse.properties.outputExampleSet.$ref - schemas.XPSPreprocessResponse.properties.outputExampleSet.description - schemas.XPSPreprocessResponse.properties.speechPreprocessResp.$ref - schemas.XPSPreprocessResponse.properties.tablesPreprocessResponse.$ref - schemas.XPSPreprocessResponse.properties.translationPreprocessResp.$ref - schemas.XPSPreprocessResponse.type - schemas.XPSRegressionEvaluationMetrics.description - schemas.XPSRegressionEvaluationMetrics.id - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsoluteError.description - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsoluteError.format - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsoluteError.type - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsolutePercentageError.description - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsolutePercentageError.format - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsolutePercentageError.type - schemas.XPSRegressionEvaluationMetrics.properties.rSquared.description - schemas.XPSRegressionEvaluationMetrics.properties.rSquared.format - schemas.XPSRegressionEvaluationMetrics.properties.rSquared.type - schemas.XPSRegressionEvaluationMetrics.properties.regressionMetricsEntries.description - schemas.XPSRegressionEvaluationMetrics.properties.regressionMetricsEntries.items.$ref - schemas.XPSRegressionEvaluationMetrics.properties.regressionMetricsEntries.type - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredError.description - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredError.format - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredError.type - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredLogError.description - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredLogError.format - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredLogError.type - schemas.XPSRegressionEvaluationMetrics.type - schemas.XPSRegressionMetricsEntry.description - schemas.XPSRegressionMetricsEntry.id - schemas.XPSRegressionMetricsEntry.properties.predictedValue.description - schemas.XPSRegressionMetricsEntry.properties.predictedValue.format - schemas.XPSRegressionMetricsEntry.properties.predictedValue.type - schemas.XPSRegressionMetricsEntry.properties.trueValue.description - schemas.XPSRegressionMetricsEntry.properties.trueValue.format - schemas.XPSRegressionMetricsEntry.properties.trueValue.type - schemas.XPSRegressionMetricsEntry.type - schemas.XPSReportingMetrics.id - schemas.XPSReportingMetrics.properties.effectiveTrainingDuration.deprecated - schemas.XPSReportingMetrics.properties.effectiveTrainingDuration.description - schemas.XPSReportingMetrics.properties.effectiveTrainingDuration.format - schemas.XPSReportingMetrics.properties.effectiveTrainingDuration.type - schemas.XPSReportingMetrics.properties.metricEntries.description - schemas.XPSReportingMetrics.properties.metricEntries.items.$ref - schemas.XPSReportingMetrics.properties.metricEntries.type - schemas.XPSReportingMetrics.type - schemas.XPSResponseExplanationMetadata.deprecated - schemas.XPSResponseExplanationMetadata.id - schemas.XPSResponseExplanationMetadata.properties.inputs.additionalProperties.$ref - schemas.XPSResponseExplanationMetadata.properties.inputs.description - schemas.XPSResponseExplanationMetadata.properties.inputs.type - schemas.XPSResponseExplanationMetadata.properties.outputs.additionalProperties.$ref - schemas.XPSResponseExplanationMetadata.properties.outputs.description - schemas.XPSResponseExplanationMetadata.properties.outputs.type - schemas.XPSResponseExplanationMetadata.type - schemas.XPSResponseExplanationMetadataInputMetadata.description - schemas.XPSResponseExplanationMetadataInputMetadata.id - schemas.XPSResponseExplanationMetadataInputMetadata.properties.inputTensorName.description - schemas.XPSResponseExplanationMetadataInputMetadata.properties.inputTensorName.type - schemas.XPSResponseExplanationMetadataInputMetadata.properties.modality.description - schemas.XPSResponseExplanationMetadataInputMetadata.properties.modality.enum - schemas.XPSResponseExplanationMetadataInputMetadata.properties.modality.enumDescriptions - schemas.XPSResponseExplanationMetadataInputMetadata.properties.modality.type - schemas.XPSResponseExplanationMetadataInputMetadata.properties.visualizationConfig.$ref - schemas.XPSResponseExplanationMetadataInputMetadata.properties.visualizationConfig.description - schemas.XPSResponseExplanationMetadataInputMetadata.type - schemas.XPSResponseExplanationMetadataOutputMetadata.description - schemas.XPSResponseExplanationMetadataOutputMetadata.id - schemas.XPSResponseExplanationMetadataOutputMetadata.properties.outputTensorName.description - schemas.XPSResponseExplanationMetadataOutputMetadata.properties.outputTensorName.type - schemas.XPSResponseExplanationMetadataOutputMetadata.type - schemas.XPSResponseExplanationParameters.deprecated - schemas.XPSResponseExplanationParameters.id - schemas.XPSResponseExplanationParameters.properties.integratedGradientsAttribution.$ref - schemas.XPSResponseExplanationParameters.properties.integratedGradientsAttribution.description - schemas.XPSResponseExplanationParameters.properties.xraiAttribution.$ref - schemas.XPSResponseExplanationParameters.properties.xraiAttribution.description - schemas.XPSResponseExplanationParameters.type - schemas.XPSResponseExplanationSpec.deprecated - schemas.XPSResponseExplanationSpec.description - schemas.XPSResponseExplanationSpec.id - schemas.XPSResponseExplanationSpec.properties.explanationType.description - schemas.XPSResponseExplanationSpec.properties.explanationType.type - schemas.XPSResponseExplanationSpec.properties.metadata.$ref - schemas.XPSResponseExplanationSpec.properties.metadata.description - schemas.XPSResponseExplanationSpec.properties.parameters.$ref - schemas.XPSResponseExplanationSpec.properties.parameters.description - schemas.XPSResponseExplanationSpec.type - schemas.XPSRow.id - schemas.XPSRow.properties.columnIds.description - schemas.XPSRow.properties.columnIds.items.format - schemas.XPSRow.properties.columnIds.items.type - schemas.XPSRow.properties.columnIds.type - schemas.XPSRow.properties.values.description - schemas.XPSRow.properties.values.items.type - schemas.XPSRow.properties.values.type - schemas.XPSRow.type - schemas.XPSSpeechEvaluationMetrics.id - schemas.XPSSpeechEvaluationMetrics.properties.subModelEvaluationMetrics.description - schemas.XPSSpeechEvaluationMetrics.properties.subModelEvaluationMetrics.items.$ref - schemas.XPSSpeechEvaluationMetrics.properties.subModelEvaluationMetrics.type - schemas.XPSSpeechEvaluationMetrics.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.id - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.biasingModelType.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.biasingModelType.enum - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.biasingModelType.enumDescriptions - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.biasingModelType.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.isEnhancedModel.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.isEnhancedModel.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numDeletions.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numDeletions.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numInsertions.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numInsertions.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numSubstitutions.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numSubstitutions.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numUtterances.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numUtterances.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numUtterances.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numWords.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numWords.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numWords.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.sentenceAccuracy.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.sentenceAccuracy.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.sentenceAccuracy.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.wer.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.wer.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.wer.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.type - schemas.XPSSpeechModelSpec.id - schemas.XPSSpeechModelSpec.properties.datasetId.description - schemas.XPSSpeechModelSpec.properties.datasetId.format - schemas.XPSSpeechModelSpec.properties.datasetId.type - schemas.XPSSpeechModelSpec.properties.language.type - schemas.XPSSpeechModelSpec.properties.subModelSpecs.description - schemas.XPSSpeechModelSpec.properties.subModelSpecs.items.$ref - schemas.XPSSpeechModelSpec.properties.subModelSpecs.type - schemas.XPSSpeechModelSpec.type - schemas.XPSSpeechModelSpecSubModelSpec.id - schemas.XPSSpeechModelSpecSubModelSpec.properties.biasingModelType.description - schemas.XPSSpeechModelSpecSubModelSpec.properties.biasingModelType.enum - schemas.XPSSpeechModelSpecSubModelSpec.properties.biasingModelType.enumDescriptions - schemas.XPSSpeechModelSpecSubModelSpec.properties.biasingModelType.type - schemas.XPSSpeechModelSpecSubModelSpec.properties.clientId.description - schemas.XPSSpeechModelSpecSubModelSpec.properties.clientId.type - schemas.XPSSpeechModelSpecSubModelSpec.properties.contextId.description - schemas.XPSSpeechModelSpecSubModelSpec.properties.contextId.type - schemas.XPSSpeechModelSpecSubModelSpec.properties.isEnhancedModel.description - schemas.XPSSpeechModelSpecSubModelSpec.properties.isEnhancedModel.type - schemas.XPSSpeechModelSpecSubModelSpec.type - schemas.XPSSpeechPreprocessResponse.id - schemas.XPSSpeechPreprocessResponse.properties.cnsTestDataPath.description - schemas.XPSSpeechPreprocessResponse.properties.cnsTestDataPath.type - schemas.XPSSpeechPreprocessResponse.properties.cnsTrainDataPath.description - schemas.XPSSpeechPreprocessResponse.properties.cnsTrainDataPath.type - schemas.XPSSpeechPreprocessResponse.properties.prebuiltModelEvaluationMetrics.$ref - schemas.XPSSpeechPreprocessResponse.properties.prebuiltModelEvaluationMetrics.description - schemas.XPSSpeechPreprocessResponse.properties.speechPreprocessStats.$ref - schemas.XPSSpeechPreprocessResponse.properties.speechPreprocessStats.description - schemas.XPSSpeechPreprocessResponse.type - schemas.XPSSpeechPreprocessStats.id - schemas.XPSSpeechPreprocessStats.properties.dataErrors.description - schemas.XPSSpeechPreprocessStats.properties.dataErrors.items.$ref - schemas.XPSSpeechPreprocessStats.properties.dataErrors.type - schemas.XPSSpeechPreprocessStats.properties.numHumanLabeledExamples.description - schemas.XPSSpeechPreprocessStats.properties.numHumanLabeledExamples.format - schemas.XPSSpeechPreprocessStats.properties.numHumanLabeledExamples.type - schemas.XPSSpeechPreprocessStats.properties.numLogsExamples.description - schemas.XPSSpeechPreprocessStats.properties.numLogsExamples.format - schemas.XPSSpeechPreprocessStats.properties.numLogsExamples.type - schemas.XPSSpeechPreprocessStats.properties.numMachineTranscribedExamples.description - schemas.XPSSpeechPreprocessStats.properties.numMachineTranscribedExamples.format - schemas.XPSSpeechPreprocessStats.properties.numMachineTranscribedExamples.type - schemas.XPSSpeechPreprocessStats.properties.testExamplesCount.description - schemas.XPSSpeechPreprocessStats.properties.testExamplesCount.format - schemas.XPSSpeechPreprocessStats.properties.testExamplesCount.type - schemas.XPSSpeechPreprocessStats.properties.testSentencesCount.description - schemas.XPSSpeechPreprocessStats.properties.testSentencesCount.format - schemas.XPSSpeechPreprocessStats.properties.testSentencesCount.type - schemas.XPSSpeechPreprocessStats.properties.testWordsCount.description - schemas.XPSSpeechPreprocessStats.properties.testWordsCount.format - schemas.XPSSpeechPreprocessStats.properties.testWordsCount.type - schemas.XPSSpeechPreprocessStats.properties.trainExamplesCount.description - schemas.XPSSpeechPreprocessStats.properties.trainExamplesCount.format - schemas.XPSSpeechPreprocessStats.properties.trainExamplesCount.type - schemas.XPSSpeechPreprocessStats.properties.trainSentencesCount.description - schemas.XPSSpeechPreprocessStats.properties.trainSentencesCount.format - schemas.XPSSpeechPreprocessStats.properties.trainSentencesCount.type - schemas.XPSSpeechPreprocessStats.properties.trainWordsCount.description - schemas.XPSSpeechPreprocessStats.properties.trainWordsCount.format - schemas.XPSSpeechPreprocessStats.properties.trainWordsCount.type - schemas.XPSSpeechPreprocessStats.type - schemas.XPSStringStats.description - schemas.XPSStringStats.id - schemas.XPSStringStats.properties.commonStats.$ref - schemas.XPSStringStats.properties.topUnigramStats.description - schemas.XPSStringStats.properties.topUnigramStats.items.$ref - schemas.XPSStringStats.properties.topUnigramStats.type - schemas.XPSStringStats.type - schemas.XPSStringStatsUnigramStats.description - schemas.XPSStringStatsUnigramStats.id - schemas.XPSStringStatsUnigramStats.properties.count.description - schemas.XPSStringStatsUnigramStats.properties.count.format - schemas.XPSStringStatsUnigramStats.properties.count.type - schemas.XPSStringStatsUnigramStats.properties.value.description - schemas.XPSStringStatsUnigramStats.properties.value.type - schemas.XPSStringStatsUnigramStats.type - schemas.XPSStructStats.description - schemas.XPSStructStats.id - schemas.XPSStructStats.properties.commonStats.$ref - schemas.XPSStructStats.properties.fieldStats.additionalProperties.$ref - schemas.XPSStructStats.properties.fieldStats.description - schemas.XPSStructStats.properties.fieldStats.type - schemas.XPSStructStats.type - schemas.XPSStructType.description - schemas.XPSStructType.id - schemas.XPSStructType.properties.fields.additionalProperties.$ref - schemas.XPSStructType.properties.fields.description - schemas.XPSStructType.properties.fields.type - schemas.XPSStructType.type - schemas.XPSTableSpec.id - schemas.XPSTableSpec.properties.columnSpecs.additionalProperties.$ref - schemas.XPSTableSpec.properties.columnSpecs.description - schemas.XPSTableSpec.properties.columnSpecs.type - schemas.XPSTableSpec.properties.importedDataSizeInBytes.description - schemas.XPSTableSpec.properties.importedDataSizeInBytes.format - schemas.XPSTableSpec.properties.importedDataSizeInBytes.type - schemas.XPSTableSpec.properties.rowCount.description - schemas.XPSTableSpec.properties.rowCount.format - schemas.XPSTableSpec.properties.rowCount.type - schemas.XPSTableSpec.properties.timeColumnId.description - schemas.XPSTableSpec.properties.timeColumnId.format - schemas.XPSTableSpec.properties.timeColumnId.type - schemas.XPSTableSpec.properties.validRowCount.description - schemas.XPSTableSpec.properties.validRowCount.format - schemas.XPSTableSpec.properties.validRowCount.type - schemas.XPSTableSpec.type - schemas.XPSTablesClassificationMetrics.description - schemas.XPSTablesClassificationMetrics.id - schemas.XPSTablesClassificationMetrics.properties.curveMetrics.description - schemas.XPSTablesClassificationMetrics.properties.curveMetrics.items.$ref - schemas.XPSTablesClassificationMetrics.properties.curveMetrics.type - schemas.XPSTablesClassificationMetrics.type - schemas.XPSTablesClassificationMetricsCurveMetrics.description - schemas.XPSTablesClassificationMetricsCurveMetrics.id - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucPr.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucPr.format - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucPr.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucRoc.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucRoc.format - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucRoc.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.confidenceMetricsEntries.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.confidenceMetricsEntries.items.$ref - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.confidenceMetricsEntries.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.logLoss.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.logLoss.format - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.logLoss.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.positionThreshold.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.positionThreshold.format - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.positionThreshold.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.value.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.value.type - schemas.XPSTablesClassificationMetricsCurveMetrics.type - schemas.XPSTablesConfidenceMetricsEntry.description - schemas.XPSTablesConfidenceMetricsEntry.id - schemas.XPSTablesConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSTablesConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSTablesConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSTablesConfidenceMetricsEntry.properties.f1Score.description - schemas.XPSTablesConfidenceMetricsEntry.properties.f1Score.format - schemas.XPSTablesConfidenceMetricsEntry.properties.f1Score.type - schemas.XPSTablesConfidenceMetricsEntry.properties.falseNegativeCount.description - schemas.XPSTablesConfidenceMetricsEntry.properties.falseNegativeCount.format - schemas.XPSTablesConfidenceMetricsEntry.properties.falseNegativeCount.type - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveCount.description - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveCount.format - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveCount.type - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveRate.description - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveRate.format - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveRate.type - schemas.XPSTablesConfidenceMetricsEntry.properties.precision.description - schemas.XPSTablesConfidenceMetricsEntry.properties.precision.format - schemas.XPSTablesConfidenceMetricsEntry.properties.precision.type - schemas.XPSTablesConfidenceMetricsEntry.properties.recall.description - schemas.XPSTablesConfidenceMetricsEntry.properties.recall.format - schemas.XPSTablesConfidenceMetricsEntry.properties.recall.type - schemas.XPSTablesConfidenceMetricsEntry.properties.trueNegativeCount.description - schemas.XPSTablesConfidenceMetricsEntry.properties.trueNegativeCount.format - schemas.XPSTablesConfidenceMetricsEntry.properties.trueNegativeCount.type - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveCount.description - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveCount.format - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveCount.type - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveRate.description - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveRate.format - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveRate.type - schemas.XPSTablesConfidenceMetricsEntry.type - schemas.XPSTablesDatasetMetadata.description - schemas.XPSTablesDatasetMetadata.id - schemas.XPSTablesDatasetMetadata.properties.mlUseColumnId.description - schemas.XPSTablesDatasetMetadata.properties.mlUseColumnId.format - schemas.XPSTablesDatasetMetadata.properties.mlUseColumnId.type - schemas.XPSTablesDatasetMetadata.properties.primaryTableSpec.$ref - schemas.XPSTablesDatasetMetadata.properties.primaryTableSpec.description - schemas.XPSTablesDatasetMetadata.properties.targetColumnCorrelations.additionalProperties.$ref - schemas.XPSTablesDatasetMetadata.properties.targetColumnCorrelations.description - schemas.XPSTablesDatasetMetadata.properties.targetColumnCorrelations.type - schemas.XPSTablesDatasetMetadata.properties.targetColumnId.description - schemas.XPSTablesDatasetMetadata.properties.targetColumnId.format - schemas.XPSTablesDatasetMetadata.properties.targetColumnId.type - schemas.XPSTablesDatasetMetadata.properties.weightColumnId.description - schemas.XPSTablesDatasetMetadata.properties.weightColumnId.format - schemas.XPSTablesDatasetMetadata.properties.weightColumnId.type - schemas.XPSTablesDatasetMetadata.type - schemas.XPSTablesEvaluationMetrics.id - schemas.XPSTablesEvaluationMetrics.properties.classificationMetrics.$ref - schemas.XPSTablesEvaluationMetrics.properties.classificationMetrics.description - schemas.XPSTablesEvaluationMetrics.properties.regressionMetrics.$ref - schemas.XPSTablesEvaluationMetrics.properties.regressionMetrics.description - schemas.XPSTablesEvaluationMetrics.type - schemas.XPSTablesModelColumnInfo.description - schemas.XPSTablesModelColumnInfo.id - schemas.XPSTablesModelColumnInfo.properties.columnId.description - schemas.XPSTablesModelColumnInfo.properties.columnId.format - schemas.XPSTablesModelColumnInfo.properties.columnId.type - schemas.XPSTablesModelColumnInfo.properties.featureImportance.description - schemas.XPSTablesModelColumnInfo.properties.featureImportance.format - schemas.XPSTablesModelColumnInfo.properties.featureImportance.type - schemas.XPSTablesModelColumnInfo.type - schemas.XPSTablesModelStructure.description - schemas.XPSTablesModelStructure.id - schemas.XPSTablesModelStructure.properties.modelParameters.description - schemas.XPSTablesModelStructure.properties.modelParameters.items.$ref - schemas.XPSTablesModelStructure.properties.modelParameters.type - schemas.XPSTablesModelStructure.type - schemas.XPSTablesModelStructureModelParameters.description - schemas.XPSTablesModelStructureModelParameters.id - schemas.XPSTablesModelStructureModelParameters.properties.hyperparameters.items.$ref - schemas.XPSTablesModelStructureModelParameters.properties.hyperparameters.type - schemas.XPSTablesModelStructureModelParameters.type - schemas.XPSTablesModelStructureModelParametersParameter.id - schemas.XPSTablesModelStructureModelParametersParameter.properties.floatValue.description - schemas.XPSTablesModelStructureModelParametersParameter.properties.floatValue.format - schemas.XPSTablesModelStructureModelParametersParameter.properties.floatValue.type - schemas.XPSTablesModelStructureModelParametersParameter.properties.intValue.description - schemas.XPSTablesModelStructureModelParametersParameter.properties.intValue.format - schemas.XPSTablesModelStructureModelParametersParameter.properties.intValue.type - schemas.XPSTablesModelStructureModelParametersParameter.properties.name.description - schemas.XPSTablesModelStructureModelParametersParameter.properties.name.type - schemas.XPSTablesModelStructureModelParametersParameter.properties.stringValue.description - schemas.XPSTablesModelStructureModelParametersParameter.properties.stringValue.type - schemas.XPSTablesModelStructureModelParametersParameter.type - schemas.XPSTablesPreprocessResponse.id - schemas.XPSTablesPreprocessResponse.properties.tablesDatasetMetadata.$ref - schemas.XPSTablesPreprocessResponse.properties.tablesDatasetMetadata.description - schemas.XPSTablesPreprocessResponse.type - schemas.XPSTablesRegressionMetrics.description - schemas.XPSTablesRegressionMetrics.id - schemas.XPSTablesRegressionMetrics.properties.meanAbsoluteError.description - schemas.XPSTablesRegressionMetrics.properties.meanAbsoluteError.format - schemas.XPSTablesRegressionMetrics.properties.meanAbsoluteError.type - schemas.XPSTablesRegressionMetrics.properties.meanAbsolutePercentageError.description - schemas.XPSTablesRegressionMetrics.properties.meanAbsolutePercentageError.format - schemas.XPSTablesRegressionMetrics.properties.meanAbsolutePercentageError.type - schemas.XPSTablesRegressionMetrics.properties.rSquared.description - schemas.XPSTablesRegressionMetrics.properties.rSquared.format - schemas.XPSTablesRegressionMetrics.properties.rSquared.type - schemas.XPSTablesRegressionMetrics.properties.regressionMetricsEntries.description - schemas.XPSTablesRegressionMetrics.properties.regressionMetricsEntries.items.$ref - schemas.XPSTablesRegressionMetrics.properties.regressionMetricsEntries.type - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredError.description - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredError.format - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredError.type - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredLogError.description - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredLogError.format - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredLogError.type - schemas.XPSTablesRegressionMetrics.type - schemas.XPSTablesTrainResponse.id - schemas.XPSTablesTrainResponse.properties.modelStructure.$ref - schemas.XPSTablesTrainResponse.properties.predictionSampleRows.description - schemas.XPSTablesTrainResponse.properties.predictionSampleRows.items.$ref - schemas.XPSTablesTrainResponse.properties.predictionSampleRows.type - schemas.XPSTablesTrainResponse.properties.tablesModelColumnInfo.description - schemas.XPSTablesTrainResponse.properties.tablesModelColumnInfo.items.$ref - schemas.XPSTablesTrainResponse.properties.tablesModelColumnInfo.type - schemas.XPSTablesTrainResponse.properties.trainCostMilliNodeHours.description - schemas.XPSTablesTrainResponse.properties.trainCostMilliNodeHours.format - schemas.XPSTablesTrainResponse.properties.trainCostMilliNodeHours.type - schemas.XPSTablesTrainResponse.type - schemas.XPSTablesTrainingOperationMetadata.id - schemas.XPSTablesTrainingOperationMetadata.properties.createModelStage.description - schemas.XPSTablesTrainingOperationMetadata.properties.createModelStage.enum - schemas.XPSTablesTrainingOperationMetadata.properties.createModelStage.enumDescriptions - schemas.XPSTablesTrainingOperationMetadata.properties.createModelStage.type - schemas.XPSTablesTrainingOperationMetadata.properties.optimizationObjective.description - schemas.XPSTablesTrainingOperationMetadata.properties.optimizationObjective.type - schemas.XPSTablesTrainingOperationMetadata.properties.topTrials.description - schemas.XPSTablesTrainingOperationMetadata.properties.topTrials.items.$ref - schemas.XPSTablesTrainingOperationMetadata.properties.topTrials.type - schemas.XPSTablesTrainingOperationMetadata.properties.trainBudgetMilliNodeHours.description - schemas.XPSTablesTrainingOperationMetadata.properties.trainBudgetMilliNodeHours.format - schemas.XPSTablesTrainingOperationMetadata.properties.trainBudgetMilliNodeHours.type - schemas.XPSTablesTrainingOperationMetadata.properties.trainingObjectivePoints.description - schemas.XPSTablesTrainingOperationMetadata.properties.trainingObjectivePoints.items.$ref - schemas.XPSTablesTrainingOperationMetadata.properties.trainingObjectivePoints.type - schemas.XPSTablesTrainingOperationMetadata.properties.trainingStartTime.description - schemas.XPSTablesTrainingOperationMetadata.properties.trainingStartTime.format - schemas.XPSTablesTrainingOperationMetadata.properties.trainingStartTime.type - schemas.XPSTablesTrainingOperationMetadata.type - schemas.XPSTextComponentModel.description - schemas.XPSTextComponentModel.id - schemas.XPSTextComponentModel.properties.batchPredictionModelGcsUri.description - schemas.XPSTextComponentModel.properties.batchPredictionModelGcsUri.type - schemas.XPSTextComponentModel.properties.onlinePredictionModelGcsUri.description - schemas.XPSTextComponentModel.properties.onlinePredictionModelGcsUri.type - schemas.XPSTextComponentModel.properties.partition.description - schemas.XPSTextComponentModel.properties.partition.enum - schemas.XPSTextComponentModel.properties.partition.enumDescriptions - schemas.XPSTextComponentModel.properties.partition.type - schemas.XPSTextComponentModel.properties.servingArtifact.$ref - schemas.XPSTextComponentModel.properties.servingArtifact.description - schemas.XPSTextComponentModel.properties.servoModelName.description - schemas.XPSTextComponentModel.properties.servoModelName.type - schemas.XPSTextComponentModel.properties.submodelName.description - schemas.XPSTextComponentModel.properties.submodelName.type - schemas.XPSTextComponentModel.properties.submodelType.description - schemas.XPSTextComponentModel.properties.submodelType.enum - schemas.XPSTextComponentModel.properties.submodelType.enumDescriptions - schemas.XPSTextComponentModel.properties.submodelType.type - schemas.XPSTextComponentModel.properties.tfRuntimeVersion.description - schemas.XPSTextComponentModel.properties.tfRuntimeVersion.type - schemas.XPSTextComponentModel.properties.versionNumber.description - schemas.XPSTextComponentModel.properties.versionNumber.format - schemas.XPSTextComponentModel.properties.versionNumber.type - schemas.XPSTextComponentModel.type - schemas.XPSTextExtractionEvaluationMetrics.id - schemas.XPSTextExtractionEvaluationMetrics.properties.bestF1ConfidenceMetrics.$ref - schemas.XPSTextExtractionEvaluationMetrics.properties.bestF1ConfidenceMetrics.deprecated - schemas.XPSTextExtractionEvaluationMetrics.properties.bestF1ConfidenceMetrics.description - schemas.XPSTextExtractionEvaluationMetrics.properties.confidenceMetricsEntries.description - schemas.XPSTextExtractionEvaluationMetrics.properties.confidenceMetricsEntries.items.$ref - schemas.XPSTextExtractionEvaluationMetrics.properties.confidenceMetricsEntries.type - schemas.XPSTextExtractionEvaluationMetrics.properties.confusionMatrix.$ref - schemas.XPSTextExtractionEvaluationMetrics.properties.confusionMatrix.description - schemas.XPSTextExtractionEvaluationMetrics.properties.perLabelConfidenceMetrics.additionalProperties.$ref - schemas.XPSTextExtractionEvaluationMetrics.properties.perLabelConfidenceMetrics.deprecated - schemas.XPSTextExtractionEvaluationMetrics.properties.perLabelConfidenceMetrics.description - schemas.XPSTextExtractionEvaluationMetrics.properties.perLabelConfidenceMetrics.type - schemas.XPSTextExtractionEvaluationMetrics.type - schemas.XPSTextSentimentEvaluationMetrics.description - schemas.XPSTextSentimentEvaluationMetrics.id - schemas.XPSTextSentimentEvaluationMetrics.properties.confusionMatrix.$ref - schemas.XPSTextSentimentEvaluationMetrics.properties.confusionMatrix.description - schemas.XPSTextSentimentEvaluationMetrics.properties.f1Score.description - schemas.XPSTextSentimentEvaluationMetrics.properties.f1Score.format - schemas.XPSTextSentimentEvaluationMetrics.properties.f1Score.type - schemas.XPSTextSentimentEvaluationMetrics.properties.linearKappa.description - schemas.XPSTextSentimentEvaluationMetrics.properties.linearKappa.format - schemas.XPSTextSentimentEvaluationMetrics.properties.linearKappa.type - schemas.XPSTextSentimentEvaluationMetrics.properties.meanAbsoluteError.description - schemas.XPSTextSentimentEvaluationMetrics.properties.meanAbsoluteError.format - schemas.XPSTextSentimentEvaluationMetrics.properties.meanAbsoluteError.type - schemas.XPSTextSentimentEvaluationMetrics.properties.meanSquaredError.description - schemas.XPSTextSentimentEvaluationMetrics.properties.meanSquaredError.format - schemas.XPSTextSentimentEvaluationMetrics.properties.meanSquaredError.type - schemas.XPSTextSentimentEvaluationMetrics.properties.precision.description - schemas.XPSTextSentimentEvaluationMetrics.properties.precision.format - schemas.XPSTextSentimentEvaluationMetrics.properties.precision.type - schemas.XPSTextSentimentEvaluationMetrics.properties.quadraticKappa.description - schemas.XPSTextSentimentEvaluationMetrics.properties.quadraticKappa.format - schemas.XPSTextSentimentEvaluationMetrics.properties.quadraticKappa.type - schemas.XPSTextSentimentEvaluationMetrics.properties.recall.description - schemas.XPSTextSentimentEvaluationMetrics.properties.recall.format - schemas.XPSTextSentimentEvaluationMetrics.properties.recall.type - schemas.XPSTextSentimentEvaluationMetrics.type - schemas.XPSTextToSpeechTrainResponse.description - schemas.XPSTextToSpeechTrainResponse.id - schemas.XPSTextToSpeechTrainResponse.type - schemas.XPSTextTrainResponse.id - schemas.XPSTextTrainResponse.properties.componentModel.description - schemas.XPSTextTrainResponse.properties.componentModel.items.$ref - schemas.XPSTextTrainResponse.properties.componentModel.type - schemas.XPSTextTrainResponse.type - schemas.XPSTfJsFormat.description - schemas.XPSTfJsFormat.id - schemas.XPSTfJsFormat.type - schemas.XPSTfLiteFormat.description - schemas.XPSTfLiteFormat.id - schemas.XPSTfLiteFormat.type - schemas.XPSTfSavedModelFormat.description - schemas.XPSTfSavedModelFormat.id - schemas.XPSTfSavedModelFormat.type - schemas.XPSTimestampStats.description - schemas.XPSTimestampStats.id - schemas.XPSTimestampStats.properties.commonStats.$ref - schemas.XPSTimestampStats.properties.granularStats.additionalProperties.$ref - schemas.XPSTimestampStats.properties.granularStats.description - schemas.XPSTimestampStats.properties.granularStats.type - schemas.XPSTimestampStats.properties.medianTimestampNanos.format - schemas.XPSTimestampStats.properties.medianTimestampNanos.type - schemas.XPSTimestampStats.type - schemas.XPSTimestampStatsGranularStats.description - schemas.XPSTimestampStatsGranularStats.id - schemas.XPSTimestampStatsGranularStats.properties.buckets.additionalProperties.format - schemas.XPSTimestampStatsGranularStats.properties.buckets.additionalProperties.type - schemas.XPSTimestampStatsGranularStats.properties.buckets.description - schemas.XPSTimestampStatsGranularStats.properties.buckets.type - schemas.XPSTimestampStatsGranularStats.type - schemas.XPSTrackMetricsEntry.description - schemas.XPSTrackMetricsEntry.id - schemas.XPSTrackMetricsEntry.properties.confidenceMetricsEntries.description - schemas.XPSTrackMetricsEntry.properties.confidenceMetricsEntries.items.$ref - schemas.XPSTrackMetricsEntry.properties.confidenceMetricsEntries.type - schemas.XPSTrackMetricsEntry.properties.iouThreshold.description - schemas.XPSTrackMetricsEntry.properties.iouThreshold.format - schemas.XPSTrackMetricsEntry.properties.iouThreshold.type - schemas.XPSTrackMetricsEntry.properties.meanBoundingBoxIou.description - schemas.XPSTrackMetricsEntry.properties.meanBoundingBoxIou.format - schemas.XPSTrackMetricsEntry.properties.meanBoundingBoxIou.type - schemas.XPSTrackMetricsEntry.properties.meanMismatchRate.description - schemas.XPSTrackMetricsEntry.properties.meanMismatchRate.format - schemas.XPSTrackMetricsEntry.properties.meanMismatchRate.type - schemas.XPSTrackMetricsEntry.properties.meanTrackingAveragePrecision.description - schemas.XPSTrackMetricsEntry.properties.meanTrackingAveragePrecision.format - schemas.XPSTrackMetricsEntry.properties.meanTrackingAveragePrecision.type - schemas.XPSTrackMetricsEntry.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.id - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.boundingBoxIou.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.boundingBoxIou.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.boundingBoxIou.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.mismatchRate.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.mismatchRate.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.mismatchRate.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingPrecision.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingPrecision.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingPrecision.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingRecall.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingRecall.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingRecall.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.type - schemas.XPSTrainResponse.description - schemas.XPSTrainResponse.id - schemas.XPSTrainResponse.properties.deployedModelSizeBytes.description - schemas.XPSTrainResponse.properties.deployedModelSizeBytes.format - schemas.XPSTrainResponse.properties.deployedModelSizeBytes.type - schemas.XPSTrainResponse.properties.errorAnalysisConfigs.description - schemas.XPSTrainResponse.properties.errorAnalysisConfigs.items.$ref - schemas.XPSTrainResponse.properties.errorAnalysisConfigs.type - schemas.XPSTrainResponse.properties.evaluatedExampleSet.$ref - schemas.XPSTrainResponse.properties.evaluatedExampleSet.description - schemas.XPSTrainResponse.properties.evaluationMetricsSet.$ref - schemas.XPSTrainResponse.properties.evaluationMetricsSet.description - schemas.XPSTrainResponse.properties.explanationConfigs.deprecated - schemas.XPSTrainResponse.properties.explanationConfigs.description - schemas.XPSTrainResponse.properties.explanationConfigs.items.$ref - schemas.XPSTrainResponse.properties.explanationConfigs.type - schemas.XPSTrainResponse.properties.imageClassificationTrainResp.$ref - schemas.XPSTrainResponse.properties.imageObjectDetectionTrainResp.$ref - schemas.XPSTrainResponse.properties.imageSegmentationTrainResp.$ref - schemas.XPSTrainResponse.properties.modelToken.description - schemas.XPSTrainResponse.properties.modelToken.format - schemas.XPSTrainResponse.properties.modelToken.type - schemas.XPSTrainResponse.properties.speechTrainResp.$ref - schemas.XPSTrainResponse.properties.tablesTrainResp.$ref - schemas.XPSTrainResponse.properties.textToSpeechTrainResp.$ref - schemas.XPSTrainResponse.properties.textTrainResp.$ref - schemas.XPSTrainResponse.properties.textTrainResp.description - schemas.XPSTrainResponse.properties.translationTrainResp.$ref - schemas.XPSTrainResponse.properties.videoActionRecognitionTrainResp.$ref - schemas.XPSTrainResponse.properties.videoClassificationTrainResp.$ref - schemas.XPSTrainResponse.properties.videoObjectTrackingTrainResp.$ref - schemas.XPSTrainResponse.type - schemas.XPSTrainingObjectivePoint.id - schemas.XPSTrainingObjectivePoint.properties.createTime.description - schemas.XPSTrainingObjectivePoint.properties.createTime.format - schemas.XPSTrainingObjectivePoint.properties.createTime.type - schemas.XPSTrainingObjectivePoint.properties.value.description - schemas.XPSTrainingObjectivePoint.properties.value.format - schemas.XPSTrainingObjectivePoint.properties.value.type - schemas.XPSTrainingObjectivePoint.type - schemas.XPSTranslationEvaluationMetrics.description - schemas.XPSTranslationEvaluationMetrics.id - schemas.XPSTranslationEvaluationMetrics.properties.baseBleuScore.description - schemas.XPSTranslationEvaluationMetrics.properties.baseBleuScore.format - schemas.XPSTranslationEvaluationMetrics.properties.baseBleuScore.type - schemas.XPSTranslationEvaluationMetrics.properties.bleuScore.description - schemas.XPSTranslationEvaluationMetrics.properties.bleuScore.format - schemas.XPSTranslationEvaluationMetrics.properties.bleuScore.type - schemas.XPSTranslationEvaluationMetrics.type - schemas.XPSTranslationPreprocessResponse.description - schemas.XPSTranslationPreprocessResponse.id - schemas.XPSTranslationPreprocessResponse.properties.parsedExampleCount.description - schemas.XPSTranslationPreprocessResponse.properties.parsedExampleCount.format - schemas.XPSTranslationPreprocessResponse.properties.parsedExampleCount.type - schemas.XPSTranslationPreprocessResponse.properties.validExampleCount.description - schemas.XPSTranslationPreprocessResponse.properties.validExampleCount.format - schemas.XPSTranslationPreprocessResponse.properties.validExampleCount.type - schemas.XPSTranslationPreprocessResponse.type - schemas.XPSTranslationTrainResponse.description - schemas.XPSTranslationTrainResponse.id - schemas.XPSTranslationTrainResponse.properties.modelType.description - schemas.XPSTranslationTrainResponse.properties.modelType.enum - schemas.XPSTranslationTrainResponse.properties.modelType.enumDescriptions - schemas.XPSTranslationTrainResponse.properties.modelType.type - schemas.XPSTranslationTrainResponse.type - schemas.XPSTuningTrial.description - schemas.XPSTuningTrial.id - schemas.XPSTuningTrial.properties.modelStructure.$ref - schemas.XPSTuningTrial.properties.modelStructure.description - schemas.XPSTuningTrial.properties.trainingObjectivePoint.$ref - schemas.XPSTuningTrial.properties.trainingObjectivePoint.description - schemas.XPSTuningTrial.type - schemas.XPSVideoActionMetricsEntry.description - schemas.XPSVideoActionMetricsEntry.id - schemas.XPSVideoActionMetricsEntry.properties.confidenceMetricsEntries.description - schemas.XPSVideoActionMetricsEntry.properties.confidenceMetricsEntries.items.$ref - schemas.XPSVideoActionMetricsEntry.properties.confidenceMetricsEntries.type - schemas.XPSVideoActionMetricsEntry.properties.meanAveragePrecision.description - schemas.XPSVideoActionMetricsEntry.properties.meanAveragePrecision.format - schemas.XPSVideoActionMetricsEntry.properties.meanAveragePrecision.type - schemas.XPSVideoActionMetricsEntry.properties.precisionWindowLength.description - schemas.XPSVideoActionMetricsEntry.properties.precisionWindowLength.format - schemas.XPSVideoActionMetricsEntry.properties.precisionWindowLength.type - schemas.XPSVideoActionMetricsEntry.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.id - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.f1Score.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.f1Score.format - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.f1Score.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.precision.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.precision.format - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.precision.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.recall.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.recall.format - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.recall.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.type - schemas.XPSVideoActionRecognitionEvaluationMetrics.description - schemas.XPSVideoActionRecognitionEvaluationMetrics.id - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.evaluatedActionCount.description - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.evaluatedActionCount.format - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.evaluatedActionCount.type - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.videoActionMetricsEntries.description - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.videoActionMetricsEntries.items.$ref - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.videoActionMetricsEntries.type - schemas.XPSVideoActionRecognitionEvaluationMetrics.type - schemas.XPSVideoActionRecognitionTrainResponse.id - schemas.XPSVideoActionRecognitionTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSVideoActionRecognitionTrainResponse.properties.modelArtifactSpec.description - schemas.XPSVideoActionRecognitionTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSVideoActionRecognitionTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSVideoActionRecognitionTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSVideoActionRecognitionTrainResponse.type - schemas.XPSVideoBatchPredictOperationMetadata.id - schemas.XPSVideoBatchPredictOperationMetadata.properties.outputExamples.description - schemas.XPSVideoBatchPredictOperationMetadata.properties.outputExamples.items.type - schemas.XPSVideoBatchPredictOperationMetadata.properties.outputExamples.type - schemas.XPSVideoBatchPredictOperationMetadata.type - schemas.XPSVideoClassificationTrainResponse.id - schemas.XPSVideoClassificationTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSVideoClassificationTrainResponse.properties.modelArtifactSpec.description - schemas.XPSVideoClassificationTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSVideoClassificationTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSVideoClassificationTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSVideoClassificationTrainResponse.type - schemas.XPSVideoExportModelSpec.description - schemas.XPSVideoExportModelSpec.id - schemas.XPSVideoExportModelSpec.properties.exportModelOutputConfig.description - schemas.XPSVideoExportModelSpec.properties.exportModelOutputConfig.items.$ref - schemas.XPSVideoExportModelSpec.properties.exportModelOutputConfig.type - schemas.XPSVideoExportModelSpec.type - schemas.XPSVideoModelArtifactSpec.id - schemas.XPSVideoModelArtifactSpec.properties.exportArtifact.description - schemas.XPSVideoModelArtifactSpec.properties.exportArtifact.items.$ref - schemas.XPSVideoModelArtifactSpec.properties.exportArtifact.type - schemas.XPSVideoModelArtifactSpec.properties.servingArtifact.$ref - schemas.XPSVideoModelArtifactSpec.properties.servingArtifact.description - schemas.XPSVideoModelArtifactSpec.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.id - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMetricsEntries.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMetricsEntries.items.$ref - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMetricsEntries.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedBoundingboxCount.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedBoundingboxCount.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedBoundingboxCount.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedFrameCount.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedFrameCount.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedFrameCount.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedTrackCount.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedTrackCount.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedTrackCount.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanAveragePrecision.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanAveragePrecision.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanAveragePrecision.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanBoundingBoxIou.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanBoundingBoxIou.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanBoundingBoxIou.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanMismatchRate.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanMismatchRate.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanMismatchRate.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMetricsEntries.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMetricsEntries.items.$ref - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMetricsEntries.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.type - schemas.XPSVideoObjectTrackingTrainResponse.id - schemas.XPSVideoObjectTrackingTrainResponse.properties.exportModelSpec.$ref - schemas.XPSVideoObjectTrackingTrainResponse.properties.exportModelSpec.description - schemas.XPSVideoObjectTrackingTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSVideoObjectTrackingTrainResponse.properties.modelArtifactSpec.description - schemas.XPSVideoObjectTrackingTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSVideoObjectTrackingTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSVideoObjectTrackingTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSVideoObjectTrackingTrainResponse.type - schemas.XPSVideoTrainingOperationMetadata.id - schemas.XPSVideoTrainingOperationMetadata.properties.trainCostMilliNodeHour.description - schemas.XPSVideoTrainingOperationMetadata.properties.trainCostMilliNodeHour.format - schemas.XPSVideoTrainingOperationMetadata.properties.trainCostMilliNodeHour.type - schemas.XPSVideoTrainingOperationMetadata.type - schemas.XPSVisionErrorAnalysisConfig.description - schemas.XPSVisionErrorAnalysisConfig.id - schemas.XPSVisionErrorAnalysisConfig.properties.exampleCount.description - schemas.XPSVisionErrorAnalysisConfig.properties.exampleCount.format - schemas.XPSVisionErrorAnalysisConfig.properties.exampleCount.type - schemas.XPSVisionErrorAnalysisConfig.properties.queryType.description - schemas.XPSVisionErrorAnalysisConfig.properties.queryType.enum - schemas.XPSVisionErrorAnalysisConfig.properties.queryType.enumDescriptions - schemas.XPSVisionErrorAnalysisConfig.properties.queryType.type - schemas.XPSVisionErrorAnalysisConfig.type - schemas.XPSVisionTrainingOperationMetadata.deprecated - schemas.XPSVisionTrainingOperationMetadata.id - schemas.XPSVisionTrainingOperationMetadata.properties.explanationUsage.$ref - schemas.XPSVisionTrainingOperationMetadata.properties.explanationUsage.description - schemas.XPSVisionTrainingOperationMetadata.type - schemas.XPSVisualization.deprecated - schemas.XPSVisualization.description - schemas.XPSVisualization.id - schemas.XPSVisualization.properties.clipPercentLowerbound.description - schemas.XPSVisualization.properties.clipPercentLowerbound.format - schemas.XPSVisualization.properties.clipPercentLowerbound.type - schemas.XPSVisualization.properties.clipPercentUpperbound.description - schemas.XPSVisualization.properties.clipPercentUpperbound.format - schemas.XPSVisualization.properties.clipPercentUpperbound.type - schemas.XPSVisualization.properties.colorMap.description - schemas.XPSVisualization.properties.colorMap.enum - schemas.XPSVisualization.properties.colorMap.enumDescriptions - schemas.XPSVisualization.properties.colorMap.type - schemas.XPSVisualization.properties.overlayType.description - schemas.XPSVisualization.properties.overlayType.enum - schemas.XPSVisualization.properties.overlayType.enumDescriptions - schemas.XPSVisualization.properties.overlayType.type - schemas.XPSVisualization.properties.polarity.description - schemas.XPSVisualization.properties.polarity.enum - schemas.XPSVisualization.properties.polarity.enumDescriptions - schemas.XPSVisualization.properties.polarity.type - schemas.XPSVisualization.properties.type.description - schemas.XPSVisualization.properties.type.enum - schemas.XPSVisualization.properties.type.enumDescriptions - schemas.XPSVisualization.properties.type.type - schemas.XPSVisualization.type - schemas.XPSXpsOperationMetadata.id - schemas.XPSXpsOperationMetadata.properties.exampleCount.description - schemas.XPSXpsOperationMetadata.properties.exampleCount.format - schemas.XPSXpsOperationMetadata.properties.exampleCount.type - schemas.XPSXpsOperationMetadata.properties.reportingMetrics.$ref - schemas.XPSXpsOperationMetadata.properties.reportingMetrics.description - schemas.XPSXpsOperationMetadata.properties.tablesTrainingOperationMetadata.$ref - schemas.XPSXpsOperationMetadata.properties.videoBatchPredictOperationMetadata.$ref - schemas.XPSXpsOperationMetadata.properties.videoTrainingOperationMetadata.$ref - schemas.XPSXpsOperationMetadata.properties.visionTrainingOperationMetadata.$ref - schemas.XPSXpsOperationMetadata.type - schemas.XPSXraiAttribution.deprecated - schemas.XPSXraiAttribution.description - schemas.XPSXraiAttribution.id - schemas.XPSXraiAttribution.properties.stepCount.description - schemas.XPSXraiAttribution.properties.stepCount.format - schemas.XPSXraiAttribution.properties.stepCount.type - schemas.XPSXraiAttribution.type The following keys were changed: - schemas.AnnotateTextRequest.properties.features.$ref - schemas.ClassificationModelOptions.properties.v1Model.$ref - schemas.ClassificationModelOptions.properties.v2Model.$ref #### language:v2 The following keys were deleted: - schemas.Features.description - schemas.Features.id - schemas.Features.properties.classifyText.description - schemas.Features.properties.classifyText.type - schemas.Features.properties.extractDocumentSentiment.description - schemas.Features.properties.extractDocumentSentiment.type - schemas.Features.properties.extractEntities.description - schemas.Features.properties.extractEntities.type - schemas.Features.properties.moderateText.description - schemas.Features.properties.moderateText.type - schemas.Features.type The following keys were added: - schemas.AnnotateTextRequestFeatures.description - schemas.AnnotateTextRequestFeatures.id - schemas.AnnotateTextRequestFeatures.properties.classifyText.description - schemas.AnnotateTextRequestFeatures.properties.classifyText.type - schemas.AnnotateTextRequestFeatures.properties.extractDocumentSentiment.description - schemas.AnnotateTextRequestFeatures.properties.extractDocumentSentiment.type - schemas.AnnotateTextRequestFeatures.properties.extractEntities.description - schemas.AnnotateTextRequestFeatures.properties.extractEntities.type - schemas.AnnotateTextRequestFeatures.properties.moderateText.description - schemas.AnnotateTextRequestFeatures.properties.moderateText.type - schemas.AnnotateTextRequestFeatures.type - schemas.Color.description - schemas.Color.id - schemas.Color.properties.alpha.description - schemas.Color.properties.alpha.format - schemas.Color.properties.alpha.type - schemas.Color.properties.blue.description - schemas.Color.properties.blue.format - schemas.Color.properties.blue.type - schemas.Color.properties.green.description - schemas.Color.properties.green.format - schemas.Color.properties.green.type - schemas.Color.properties.red.description - schemas.Color.properties.red.format - schemas.Color.properties.red.type - schemas.Color.type - schemas.CpuMetric.description - schemas.CpuMetric.id - schemas.CpuMetric.properties.coreNumber.description - schemas.CpuMetric.properties.coreNumber.format - schemas.CpuMetric.properties.coreNumber.type - schemas.CpuMetric.properties.coreSec.description - schemas.CpuMetric.properties.coreSec.format - schemas.CpuMetric.properties.coreSec.type - schemas.CpuMetric.properties.cpuType.description - schemas.CpuMetric.properties.cpuType.enum - schemas.CpuMetric.properties.cpuType.enumDescriptions - schemas.CpuMetric.properties.cpuType.type - schemas.CpuMetric.properties.machineSpec.description - schemas.CpuMetric.properties.machineSpec.enum - schemas.CpuMetric.properties.machineSpec.enumDescriptions - schemas.CpuMetric.properties.machineSpec.type - schemas.CpuMetric.properties.trackingLabels.additionalProperties.type - schemas.CpuMetric.properties.trackingLabels.description - schemas.CpuMetric.properties.trackingLabels.type - schemas.CpuMetric.type - schemas.DiskMetric.id - schemas.DiskMetric.properties.diskType.description - schemas.DiskMetric.properties.diskType.enum - schemas.DiskMetric.properties.diskType.enumDescriptions - schemas.DiskMetric.properties.diskType.type - schemas.DiskMetric.properties.gibSec.description - schemas.DiskMetric.properties.gibSec.format - schemas.DiskMetric.properties.gibSec.type - schemas.DiskMetric.type - schemas.GpuMetric.id - schemas.GpuMetric.properties.gpuSec.description - schemas.GpuMetric.properties.gpuSec.format - schemas.GpuMetric.properties.gpuSec.type - schemas.GpuMetric.properties.gpuType.description - schemas.GpuMetric.properties.gpuType.enum - schemas.GpuMetric.properties.gpuType.enumDescriptions - schemas.GpuMetric.properties.gpuType.type - schemas.GpuMetric.properties.machineSpec.description - schemas.GpuMetric.properties.machineSpec.enum - schemas.GpuMetric.properties.machineSpec.enumDescriptions - schemas.GpuMetric.properties.machineSpec.type - schemas.GpuMetric.properties.trackingLabels.additionalProperties.type - schemas.GpuMetric.properties.trackingLabels.description - schemas.GpuMetric.properties.trackingLabels.type - schemas.GpuMetric.type - schemas.InfraUsage.description - schemas.InfraUsage.id - schemas.InfraUsage.properties.cpuMetrics.description - schemas.InfraUsage.properties.cpuMetrics.items.$ref - schemas.InfraUsage.properties.cpuMetrics.type - schemas.InfraUsage.properties.diskMetrics.description - schemas.InfraUsage.properties.diskMetrics.items.$ref - schemas.InfraUsage.properties.diskMetrics.type - schemas.InfraUsage.properties.gpuMetrics.description - schemas.InfraUsage.properties.gpuMetrics.items.$ref - schemas.InfraUsage.properties.gpuMetrics.type - schemas.InfraUsage.properties.ramMetrics.description - schemas.InfraUsage.properties.ramMetrics.items.$ref - schemas.InfraUsage.properties.ramMetrics.type - schemas.InfraUsage.properties.tpuMetrics.description - schemas.InfraUsage.properties.tpuMetrics.items.$ref - schemas.InfraUsage.properties.tpuMetrics.type - schemas.InfraUsage.type - schemas.RamMetric.id - schemas.RamMetric.properties.gibSec.description - schemas.RamMetric.properties.gibSec.format - schemas.RamMetric.properties.gibSec.type - schemas.RamMetric.properties.machineSpec.description - schemas.RamMetric.properties.machineSpec.enum - schemas.RamMetric.properties.machineSpec.enumDescriptions - schemas.RamMetric.properties.machineSpec.type - schemas.RamMetric.properties.memories.description - schemas.RamMetric.properties.memories.format - schemas.RamMetric.properties.memories.type - schemas.RamMetric.properties.ramType.description - schemas.RamMetric.properties.ramType.enum - schemas.RamMetric.properties.ramType.enumDescriptions - schemas.RamMetric.properties.ramType.type - schemas.RamMetric.properties.trackingLabels.additionalProperties.type - schemas.RamMetric.properties.trackingLabels.description - schemas.RamMetric.properties.trackingLabels.type - schemas.RamMetric.type - schemas.TpuMetric.id - schemas.TpuMetric.properties.tpuSec.description - schemas.TpuMetric.properties.tpuSec.format - schemas.TpuMetric.properties.tpuSec.type - schemas.TpuMetric.properties.tpuType.description - schemas.TpuMetric.properties.tpuType.enum - schemas.TpuMetric.properties.tpuType.enumDescriptions - schemas.TpuMetric.properties.tpuType.type - schemas.TpuMetric.type - schemas.XPSArrayStats.description - schemas.XPSArrayStats.id - schemas.XPSArrayStats.properties.commonStats.$ref - schemas.XPSArrayStats.properties.memberStats.$ref - schemas.XPSArrayStats.properties.memberStats.description - schemas.XPSArrayStats.type - schemas.XPSBatchPredictResponse.id - schemas.XPSBatchPredictResponse.properties.exampleSet.$ref - schemas.XPSBatchPredictResponse.properties.exampleSet.description - schemas.XPSBatchPredictResponse.type - schemas.XPSBoundingBoxMetricsEntry.description - schemas.XPSBoundingBoxMetricsEntry.id - schemas.XPSBoundingBoxMetricsEntry.properties.confidenceMetricsEntries.description - schemas.XPSBoundingBoxMetricsEntry.properties.confidenceMetricsEntries.items.$ref - schemas.XPSBoundingBoxMetricsEntry.properties.confidenceMetricsEntries.type - schemas.XPSBoundingBoxMetricsEntry.properties.iouThreshold.description - schemas.XPSBoundingBoxMetricsEntry.properties.iouThreshold.format - schemas.XPSBoundingBoxMetricsEntry.properties.iouThreshold.type - schemas.XPSBoundingBoxMetricsEntry.properties.meanAveragePrecision.description - schemas.XPSBoundingBoxMetricsEntry.properties.meanAveragePrecision.format - schemas.XPSBoundingBoxMetricsEntry.properties.meanAveragePrecision.type - schemas.XPSBoundingBoxMetricsEntry.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.id - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.f1Score.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.f1Score.format - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.f1Score.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.precision.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.precision.format - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.precision.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.recall.description - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.recall.format - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.properties.recall.type - schemas.XPSBoundingBoxMetricsEntryConfidenceMetricsEntry.type - schemas.XPSCategoryStats.description - schemas.XPSCategoryStats.id - schemas.XPSCategoryStats.properties.commonStats.$ref - schemas.XPSCategoryStats.properties.topCategoryStats.description - schemas.XPSCategoryStats.properties.topCategoryStats.items.$ref - schemas.XPSCategoryStats.properties.topCategoryStats.type - schemas.XPSCategoryStats.type - schemas.XPSCategoryStatsSingleCategoryStats.description - schemas.XPSCategoryStatsSingleCategoryStats.id - schemas.XPSCategoryStatsSingleCategoryStats.properties.count.description - schemas.XPSCategoryStatsSingleCategoryStats.properties.count.format - schemas.XPSCategoryStatsSingleCategoryStats.properties.count.type - schemas.XPSCategoryStatsSingleCategoryStats.properties.value.description - schemas.XPSCategoryStatsSingleCategoryStats.properties.value.type - schemas.XPSCategoryStatsSingleCategoryStats.type - schemas.XPSClassificationEvaluationMetrics.description - schemas.XPSClassificationEvaluationMetrics.id - schemas.XPSClassificationEvaluationMetrics.properties.auPrc.description - schemas.XPSClassificationEvaluationMetrics.properties.auPrc.format - schemas.XPSClassificationEvaluationMetrics.properties.auPrc.type - schemas.XPSClassificationEvaluationMetrics.properties.auRoc.description - schemas.XPSClassificationEvaluationMetrics.properties.auRoc.format - schemas.XPSClassificationEvaluationMetrics.properties.auRoc.type - schemas.XPSClassificationEvaluationMetrics.properties.baseAuPrc.description - schemas.XPSClassificationEvaluationMetrics.properties.baseAuPrc.format - schemas.XPSClassificationEvaluationMetrics.properties.baseAuPrc.type - schemas.XPSClassificationEvaluationMetrics.properties.confidenceMetricsEntries.description - schemas.XPSClassificationEvaluationMetrics.properties.confidenceMetricsEntries.items.$ref - schemas.XPSClassificationEvaluationMetrics.properties.confidenceMetricsEntries.type - schemas.XPSClassificationEvaluationMetrics.properties.confusionMatrix.$ref - schemas.XPSClassificationEvaluationMetrics.properties.confusionMatrix.description - schemas.XPSClassificationEvaluationMetrics.properties.evaluatedExamplesCount.description - schemas.XPSClassificationEvaluationMetrics.properties.evaluatedExamplesCount.format - schemas.XPSClassificationEvaluationMetrics.properties.evaluatedExamplesCount.type - schemas.XPSClassificationEvaluationMetrics.properties.logLoss.description - schemas.XPSClassificationEvaluationMetrics.properties.logLoss.format - schemas.XPSClassificationEvaluationMetrics.properties.logLoss.type - schemas.XPSClassificationEvaluationMetrics.type - schemas.XPSColorMap.description - schemas.XPSColorMap.id - schemas.XPSColorMap.properties.annotationSpecIdToken.description - schemas.XPSColorMap.properties.annotationSpecIdToken.type - schemas.XPSColorMap.properties.color.$ref - schemas.XPSColorMap.properties.color.deprecated - schemas.XPSColorMap.properties.color.description - schemas.XPSColorMap.properties.displayName.description - schemas.XPSColorMap.properties.displayName.type - schemas.XPSColorMap.properties.intColor.$ref - schemas.XPSColorMap.type - schemas.XPSColorMapIntColor.description - schemas.XPSColorMapIntColor.id - schemas.XPSColorMapIntColor.properties.blue.description - schemas.XPSColorMapIntColor.properties.blue.format - schemas.XPSColorMapIntColor.properties.blue.type - schemas.XPSColorMapIntColor.properties.green.description - schemas.XPSColorMapIntColor.properties.green.format - schemas.XPSColorMapIntColor.properties.green.type - schemas.XPSColorMapIntColor.properties.red.description - schemas.XPSColorMapIntColor.properties.red.format - schemas.XPSColorMapIntColor.properties.red.type - schemas.XPSColorMapIntColor.type - schemas.XPSColumnSpec.id - schemas.XPSColumnSpec.properties.columnId.description - schemas.XPSColumnSpec.properties.columnId.format - schemas.XPSColumnSpec.properties.columnId.type - schemas.XPSColumnSpec.properties.dataStats.$ref - schemas.XPSColumnSpec.properties.dataStats.description - schemas.XPSColumnSpec.properties.dataType.$ref - schemas.XPSColumnSpec.properties.dataType.description - schemas.XPSColumnSpec.properties.displayName.description - schemas.XPSColumnSpec.properties.displayName.type - schemas.XPSColumnSpec.properties.forecastingMetadata.$ref - schemas.XPSColumnSpec.properties.topCorrelatedColumns.description - schemas.XPSColumnSpec.properties.topCorrelatedColumns.items.$ref - schemas.XPSColumnSpec.properties.topCorrelatedColumns.type - schemas.XPSColumnSpec.type - schemas.XPSColumnSpecCorrelatedColumn.description - schemas.XPSColumnSpecCorrelatedColumn.id - schemas.XPSColumnSpecCorrelatedColumn.properties.columnId.format - schemas.XPSColumnSpecCorrelatedColumn.properties.columnId.type - schemas.XPSColumnSpecCorrelatedColumn.properties.correlationStats.$ref - schemas.XPSColumnSpecCorrelatedColumn.type - schemas.XPSColumnSpecForecastingMetadata.description - schemas.XPSColumnSpecForecastingMetadata.id - schemas.XPSColumnSpecForecastingMetadata.properties.columnType.description - schemas.XPSColumnSpecForecastingMetadata.properties.columnType.enum - schemas.XPSColumnSpecForecastingMetadata.properties.columnType.enumDescriptions - schemas.XPSColumnSpecForecastingMetadata.properties.columnType.type - schemas.XPSColumnSpecForecastingMetadata.type - schemas.XPSCommonStats.description - schemas.XPSCommonStats.id - schemas.XPSCommonStats.properties.distinctValueCount.format - schemas.XPSCommonStats.properties.distinctValueCount.type - schemas.XPSCommonStats.properties.nullValueCount.format - schemas.XPSCommonStats.properties.nullValueCount.type - schemas.XPSCommonStats.properties.validValueCount.format - schemas.XPSCommonStats.properties.validValueCount.type - schemas.XPSCommonStats.type - schemas.XPSConfidenceMetricsEntry.description - schemas.XPSConfidenceMetricsEntry.id - schemas.XPSConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSConfidenceMetricsEntry.properties.f1Score.description - schemas.XPSConfidenceMetricsEntry.properties.f1Score.format - schemas.XPSConfidenceMetricsEntry.properties.f1Score.type - schemas.XPSConfidenceMetricsEntry.properties.f1ScoreAt1.description - schemas.XPSConfidenceMetricsEntry.properties.f1ScoreAt1.format - schemas.XPSConfidenceMetricsEntry.properties.f1ScoreAt1.type - schemas.XPSConfidenceMetricsEntry.properties.falseNegativeCount.description - schemas.XPSConfidenceMetricsEntry.properties.falseNegativeCount.format - schemas.XPSConfidenceMetricsEntry.properties.falseNegativeCount.type - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveCount.description - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveCount.format - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveCount.type - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRate.description - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRate.format - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRate.type - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRateAt1.description - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRateAt1.format - schemas.XPSConfidenceMetricsEntry.properties.falsePositiveRateAt1.type - schemas.XPSConfidenceMetricsEntry.properties.positionThreshold.description - schemas.XPSConfidenceMetricsEntry.properties.positionThreshold.format - schemas.XPSConfidenceMetricsEntry.properties.positionThreshold.type - schemas.XPSConfidenceMetricsEntry.properties.precision.description - schemas.XPSConfidenceMetricsEntry.properties.precision.format - schemas.XPSConfidenceMetricsEntry.properties.precision.type - schemas.XPSConfidenceMetricsEntry.properties.precisionAt1.description - schemas.XPSConfidenceMetricsEntry.properties.precisionAt1.format - schemas.XPSConfidenceMetricsEntry.properties.precisionAt1.type - schemas.XPSConfidenceMetricsEntry.properties.recall.description - schemas.XPSConfidenceMetricsEntry.properties.recall.format - schemas.XPSConfidenceMetricsEntry.properties.recall.type - schemas.XPSConfidenceMetricsEntry.properties.recallAt1.description - schemas.XPSConfidenceMetricsEntry.properties.recallAt1.format - schemas.XPSConfidenceMetricsEntry.properties.recallAt1.type - schemas.XPSConfidenceMetricsEntry.properties.trueNegativeCount.description - schemas.XPSConfidenceMetricsEntry.properties.trueNegativeCount.format - schemas.XPSConfidenceMetricsEntry.properties.trueNegativeCount.type - schemas.XPSConfidenceMetricsEntry.properties.truePositiveCount.description - schemas.XPSConfidenceMetricsEntry.properties.truePositiveCount.format - schemas.XPSConfidenceMetricsEntry.properties.truePositiveCount.type - schemas.XPSConfidenceMetricsEntry.type - schemas.XPSConfusionMatrix.description - schemas.XPSConfusionMatrix.id - schemas.XPSConfusionMatrix.properties.annotationSpecIdToken.description - schemas.XPSConfusionMatrix.properties.annotationSpecIdToken.items.type - schemas.XPSConfusionMatrix.properties.annotationSpecIdToken.type - schemas.XPSConfusionMatrix.properties.category.description - schemas.XPSConfusionMatrix.properties.category.items.format - schemas.XPSConfusionMatrix.properties.category.items.type - schemas.XPSConfusionMatrix.properties.category.type - schemas.XPSConfusionMatrix.properties.row.description - schemas.XPSConfusionMatrix.properties.row.items.$ref - schemas.XPSConfusionMatrix.properties.row.type - schemas.XPSConfusionMatrix.properties.sentimentLabel.description - schemas.XPSConfusionMatrix.properties.sentimentLabel.items.format - schemas.XPSConfusionMatrix.properties.sentimentLabel.items.type - schemas.XPSConfusionMatrix.properties.sentimentLabel.type - schemas.XPSConfusionMatrix.type - schemas.XPSConfusionMatrixRow.description - schemas.XPSConfusionMatrixRow.id - schemas.XPSConfusionMatrixRow.properties.count.description - schemas.XPSConfusionMatrixRow.properties.count.items.format - schemas.XPSConfusionMatrixRow.properties.count.items.type - schemas.XPSConfusionMatrixRow.properties.count.type - schemas.XPSConfusionMatrixRow.properties.exampleCount.description - schemas.XPSConfusionMatrixRow.properties.exampleCount.items.format - schemas.XPSConfusionMatrixRow.properties.exampleCount.items.type - schemas.XPSConfusionMatrixRow.properties.exampleCount.type - schemas.XPSConfusionMatrixRow.type - schemas.XPSCoreMlFormat.description - schemas.XPSCoreMlFormat.id - schemas.XPSCoreMlFormat.type - schemas.XPSCorrelationStats.description - schemas.XPSCorrelationStats.id - schemas.XPSCorrelationStats.properties.cramersV.description - schemas.XPSCorrelationStats.properties.cramersV.format - schemas.XPSCorrelationStats.properties.cramersV.type - schemas.XPSCorrelationStats.type - schemas.XPSDataErrors.description - schemas.XPSDataErrors.id - schemas.XPSDataErrors.properties.count.description - schemas.XPSDataErrors.properties.count.format - schemas.XPSDataErrors.properties.count.type - schemas.XPSDataErrors.properties.errorType.description - schemas.XPSDataErrors.properties.errorType.enum - schemas.XPSDataErrors.properties.errorType.enumDescriptions - schemas.XPSDataErrors.properties.errorType.type - schemas.XPSDataErrors.type - schemas.XPSDataStats.description - schemas.XPSDataStats.id - schemas.XPSDataStats.properties.arrayStats.$ref - schemas.XPSDataStats.properties.arrayStats.description - schemas.XPSDataStats.properties.categoryStats.$ref - schemas.XPSDataStats.properties.categoryStats.description - schemas.XPSDataStats.properties.distinctValueCount.description - schemas.XPSDataStats.properties.distinctValueCount.format - schemas.XPSDataStats.properties.distinctValueCount.type - schemas.XPSDataStats.properties.float64Stats.$ref - schemas.XPSDataStats.properties.float64Stats.description - schemas.XPSDataStats.properties.nullValueCount.description - schemas.XPSDataStats.properties.nullValueCount.format - schemas.XPSDataStats.properties.nullValueCount.type - schemas.XPSDataStats.properties.stringStats.$ref - schemas.XPSDataStats.properties.stringStats.description - schemas.XPSDataStats.properties.structStats.$ref - schemas.XPSDataStats.properties.structStats.description - schemas.XPSDataStats.properties.timestampStats.$ref - schemas.XPSDataStats.properties.timestampStats.description - schemas.XPSDataStats.properties.validValueCount.description - schemas.XPSDataStats.properties.validValueCount.format - schemas.XPSDataStats.properties.validValueCount.type - schemas.XPSDataStats.type - schemas.XPSDataType.description - schemas.XPSDataType.id - schemas.XPSDataType.properties.compatibleDataTypes.description - schemas.XPSDataType.properties.compatibleDataTypes.items.$ref - schemas.XPSDataType.properties.compatibleDataTypes.type - schemas.XPSDataType.properties.listElementType.$ref - schemas.XPSDataType.properties.listElementType.description - schemas.XPSDataType.properties.nullable.description - schemas.XPSDataType.properties.nullable.type - schemas.XPSDataType.properties.structType.$ref - schemas.XPSDataType.properties.structType.description - schemas.XPSDataType.properties.timeFormat.description - schemas.XPSDataType.properties.timeFormat.type - schemas.XPSDataType.properties.typeCode.description - schemas.XPSDataType.properties.typeCode.enum - schemas.XPSDataType.properties.typeCode.enumDescriptions - schemas.XPSDataType.properties.typeCode.type - schemas.XPSDataType.type - schemas.XPSDockerFormat.description - schemas.XPSDockerFormat.id - schemas.XPSDockerFormat.properties.cpuArchitecture.description - schemas.XPSDockerFormat.properties.cpuArchitecture.enum - schemas.XPSDockerFormat.properties.cpuArchitecture.enumDescriptions - schemas.XPSDockerFormat.properties.cpuArchitecture.type - schemas.XPSDockerFormat.properties.gpuArchitecture.description - schemas.XPSDockerFormat.properties.gpuArchitecture.enum - schemas.XPSDockerFormat.properties.gpuArchitecture.enumDescriptions - schemas.XPSDockerFormat.properties.gpuArchitecture.type - schemas.XPSDockerFormat.type - schemas.XPSEdgeTpuTfLiteFormat.description - schemas.XPSEdgeTpuTfLiteFormat.id - schemas.XPSEdgeTpuTfLiteFormat.type - schemas.XPSEvaluationMetrics.description - schemas.XPSEvaluationMetrics.id - schemas.XPSEvaluationMetrics.properties.annotationSpecIdToken.description - schemas.XPSEvaluationMetrics.properties.annotationSpecIdToken.type - schemas.XPSEvaluationMetrics.properties.category.description - schemas.XPSEvaluationMetrics.properties.category.format - schemas.XPSEvaluationMetrics.properties.category.type - schemas.XPSEvaluationMetrics.properties.evaluatedExampleCount.description - schemas.XPSEvaluationMetrics.properties.evaluatedExampleCount.format - schemas.XPSEvaluationMetrics.properties.evaluatedExampleCount.type - schemas.XPSEvaluationMetrics.properties.imageClassificationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.imageObjectDetectionEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.imageSegmentationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.label.description - schemas.XPSEvaluationMetrics.properties.label.type - schemas.XPSEvaluationMetrics.properties.regressionEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.tablesClassificationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.tablesEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.textClassificationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.textExtractionEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.textSentimentEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.translationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.videoActionRecognitionEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.videoClassificationEvalMetrics.$ref - schemas.XPSEvaluationMetrics.properties.videoObjectTrackingEvalMetrics.$ref - schemas.XPSEvaluationMetrics.type - schemas.XPSEvaluationMetricsSet.description - schemas.XPSEvaluationMetricsSet.id - schemas.XPSEvaluationMetricsSet.properties.evaluationMetrics.description - schemas.XPSEvaluationMetricsSet.properties.evaluationMetrics.items.$ref - schemas.XPSEvaluationMetricsSet.properties.evaluationMetrics.type - schemas.XPSEvaluationMetricsSet.properties.fileSpec.$ref - schemas.XPSEvaluationMetricsSet.properties.fileSpec.description - schemas.XPSEvaluationMetricsSet.properties.numEvaluationMetrics.description - schemas.XPSEvaluationMetricsSet.properties.numEvaluationMetrics.format - schemas.XPSEvaluationMetricsSet.properties.numEvaluationMetrics.type - schemas.XPSEvaluationMetricsSet.type - schemas.XPSExampleSet.description - schemas.XPSExampleSet.id - schemas.XPSExampleSet.properties.fileSpec.$ref - schemas.XPSExampleSet.properties.fileSpec.description - schemas.XPSExampleSet.properties.fingerprint.description - schemas.XPSExampleSet.properties.fingerprint.format - schemas.XPSExampleSet.properties.fingerprint.type - schemas.XPSExampleSet.properties.numExamples.description - schemas.XPSExampleSet.properties.numExamples.format - schemas.XPSExampleSet.properties.numExamples.type - schemas.XPSExampleSet.properties.numInputSources.description - schemas.XPSExampleSet.properties.numInputSources.format - schemas.XPSExampleSet.properties.numInputSources.type - schemas.XPSExampleSet.type - schemas.XPSExportModelOutputConfig.id - schemas.XPSExportModelOutputConfig.properties.coreMlFormat.$ref - schemas.XPSExportModelOutputConfig.properties.dockerFormat.$ref - schemas.XPSExportModelOutputConfig.properties.edgeTpuTfLiteFormat.$ref - schemas.XPSExportModelOutputConfig.properties.exportFirebaseAuxiliaryInfo.description - schemas.XPSExportModelOutputConfig.properties.exportFirebaseAuxiliaryInfo.type - schemas.XPSExportModelOutputConfig.properties.outputGcrUri.description - schemas.XPSExportModelOutputConfig.properties.outputGcrUri.type - schemas.XPSExportModelOutputConfig.properties.outputGcsUri.description - schemas.XPSExportModelOutputConfig.properties.outputGcsUri.type - schemas.XPSExportModelOutputConfig.properties.tfJsFormat.$ref - schemas.XPSExportModelOutputConfig.properties.tfLiteFormat.$ref - schemas.XPSExportModelOutputConfig.properties.tfSavedModelFormat.$ref - schemas.XPSExportModelOutputConfig.type - schemas.XPSFileSpec.description - schemas.XPSFileSpec.id - schemas.XPSFileSpec.properties.directoryPath.deprecated - schemas.XPSFileSpec.properties.directoryPath.description - schemas.XPSFileSpec.properties.directoryPath.type - schemas.XPSFileSpec.properties.fileFormat.enum - schemas.XPSFileSpec.properties.fileFormat.enumDeprecated - schemas.XPSFileSpec.properties.fileFormat.enumDescriptions - schemas.XPSFileSpec.properties.fileFormat.type - schemas.XPSFileSpec.properties.fileSpec.description - schemas.XPSFileSpec.properties.fileSpec.type - schemas.XPSFileSpec.properties.singleFilePath.deprecated - schemas.XPSFileSpec.properties.singleFilePath.description - schemas.XPSFileSpec.properties.singleFilePath.type - schemas.XPSFileSpec.type - schemas.XPSFloat64Stats.description - schemas.XPSFloat64Stats.id - schemas.XPSFloat64Stats.properties.commonStats.$ref - schemas.XPSFloat64Stats.properties.histogramBuckets.description - schemas.XPSFloat64Stats.properties.histogramBuckets.items.$ref - schemas.XPSFloat64Stats.properties.histogramBuckets.type - schemas.XPSFloat64Stats.properties.mean.description - schemas.XPSFloat64Stats.properties.mean.format - schemas.XPSFloat64Stats.properties.mean.type - schemas.XPSFloat64Stats.properties.quantiles.description - schemas.XPSFloat64Stats.properties.quantiles.items.format - schemas.XPSFloat64Stats.properties.quantiles.items.type - schemas.XPSFloat64Stats.properties.quantiles.type - schemas.XPSFloat64Stats.properties.standardDeviation.description - schemas.XPSFloat64Stats.properties.standardDeviation.format - schemas.XPSFloat64Stats.properties.standardDeviation.type - schemas.XPSFloat64Stats.type - schemas.XPSFloat64StatsHistogramBucket.description - schemas.XPSFloat64StatsHistogramBucket.id - schemas.XPSFloat64StatsHistogramBucket.properties.count.description - schemas.XPSFloat64StatsHistogramBucket.properties.count.format - schemas.XPSFloat64StatsHistogramBucket.properties.count.type - schemas.XPSFloat64StatsHistogramBucket.properties.max.description - schemas.XPSFloat64StatsHistogramBucket.properties.max.format - schemas.XPSFloat64StatsHistogramBucket.properties.max.type - schemas.XPSFloat64StatsHistogramBucket.properties.min.description - schemas.XPSFloat64StatsHistogramBucket.properties.min.format - schemas.XPSFloat64StatsHistogramBucket.properties.min.type - schemas.XPSFloat64StatsHistogramBucket.type - schemas.XPSImageClassificationTrainResponse.id - schemas.XPSImageClassificationTrainResponse.properties.classCount.description - schemas.XPSImageClassificationTrainResponse.properties.classCount.format - schemas.XPSImageClassificationTrainResponse.properties.classCount.type - schemas.XPSImageClassificationTrainResponse.properties.exportModelSpec.$ref - schemas.XPSImageClassificationTrainResponse.properties.exportModelSpec.description - schemas.XPSImageClassificationTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSImageClassificationTrainResponse.properties.modelArtifactSpec.description - schemas.XPSImageClassificationTrainResponse.properties.modelServingSpec.$ref - schemas.XPSImageClassificationTrainResponse.properties.stopReason.description - schemas.XPSImageClassificationTrainResponse.properties.stopReason.enum - schemas.XPSImageClassificationTrainResponse.properties.stopReason.enumDescriptions - schemas.XPSImageClassificationTrainResponse.properties.stopReason.type - schemas.XPSImageClassificationTrainResponse.properties.trainCostInNodeTime.description - schemas.XPSImageClassificationTrainResponse.properties.trainCostInNodeTime.format - schemas.XPSImageClassificationTrainResponse.properties.trainCostInNodeTime.type - schemas.XPSImageClassificationTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSImageClassificationTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSImageClassificationTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSImageClassificationTrainResponse.type - schemas.XPSImageExportModelSpec.description - schemas.XPSImageExportModelSpec.id - schemas.XPSImageExportModelSpec.properties.exportModelOutputConfig.description - schemas.XPSImageExportModelSpec.properties.exportModelOutputConfig.items.$ref - schemas.XPSImageExportModelSpec.properties.exportModelOutputConfig.type - schemas.XPSImageExportModelSpec.type - schemas.XPSImageModelArtifactSpec.description - schemas.XPSImageModelArtifactSpec.id - schemas.XPSImageModelArtifactSpec.properties.checkpointArtifact.$ref - schemas.XPSImageModelArtifactSpec.properties.checkpointArtifact.description - schemas.XPSImageModelArtifactSpec.properties.exportArtifact.description - schemas.XPSImageModelArtifactSpec.properties.exportArtifact.items.$ref - schemas.XPSImageModelArtifactSpec.properties.exportArtifact.type - schemas.XPSImageModelArtifactSpec.properties.labelGcsUri.description - schemas.XPSImageModelArtifactSpec.properties.labelGcsUri.type - schemas.XPSImageModelArtifactSpec.properties.servingArtifact.$ref - schemas.XPSImageModelArtifactSpec.properties.servingArtifact.description - schemas.XPSImageModelArtifactSpec.properties.tfJsBinaryGcsPrefix.description - schemas.XPSImageModelArtifactSpec.properties.tfJsBinaryGcsPrefix.type - schemas.XPSImageModelArtifactSpec.properties.tfLiteMetadataGcsUri.description - schemas.XPSImageModelArtifactSpec.properties.tfLiteMetadataGcsUri.type - schemas.XPSImageModelArtifactSpec.type - schemas.XPSImageModelServingSpec.description - schemas.XPSImageModelServingSpec.id - schemas.XPSImageModelServingSpec.properties.modelThroughputEstimation.description - schemas.XPSImageModelServingSpec.properties.modelThroughputEstimation.items.$ref - schemas.XPSImageModelServingSpec.properties.modelThroughputEstimation.type - schemas.XPSImageModelServingSpec.properties.nodeQps.description - schemas.XPSImageModelServingSpec.properties.nodeQps.format - schemas.XPSImageModelServingSpec.properties.nodeQps.type - schemas.XPSImageModelServingSpec.properties.tfRuntimeVersion.description - schemas.XPSImageModelServingSpec.properties.tfRuntimeVersion.type - schemas.XPSImageModelServingSpec.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.id - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.computeEngineAcceleratorType.enum - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.computeEngineAcceleratorType.enumDescriptions - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.computeEngineAcceleratorType.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.latencyInMilliseconds.description - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.latencyInMilliseconds.format - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.latencyInMilliseconds.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.nodeQps.description - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.nodeQps.format - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.nodeQps.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.servomaticPartitionType.enum - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.servomaticPartitionType.enumDescriptions - schemas.XPSImageModelServingSpecModelThroughputEstimation.properties.servomaticPartitionType.type - schemas.XPSImageModelServingSpecModelThroughputEstimation.type - schemas.XPSImageObjectDetectionEvaluationMetrics.description - schemas.XPSImageObjectDetectionEvaluationMetrics.id - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.description - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.format - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.type - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMetricsEntries.description - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMetricsEntries.items.$ref - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.boundingBoxMetricsEntries.type - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.evaluatedBoundingBoxCount.description - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.evaluatedBoundingBoxCount.format - schemas.XPSImageObjectDetectionEvaluationMetrics.properties.evaluatedBoundingBoxCount.type - schemas.XPSImageObjectDetectionEvaluationMetrics.type - schemas.XPSImageObjectDetectionModelSpec.id - schemas.XPSImageObjectDetectionModelSpec.properties.classCount.description - schemas.XPSImageObjectDetectionModelSpec.properties.classCount.format - schemas.XPSImageObjectDetectionModelSpec.properties.classCount.type - schemas.XPSImageObjectDetectionModelSpec.properties.exportModelSpec.$ref - schemas.XPSImageObjectDetectionModelSpec.properties.maxBoundingBoxCount.description - schemas.XPSImageObjectDetectionModelSpec.properties.maxBoundingBoxCount.format - schemas.XPSImageObjectDetectionModelSpec.properties.maxBoundingBoxCount.type - schemas.XPSImageObjectDetectionModelSpec.properties.modelArtifactSpec.$ref - schemas.XPSImageObjectDetectionModelSpec.properties.modelArtifactSpec.description - schemas.XPSImageObjectDetectionModelSpec.properties.modelServingSpec.$ref - schemas.XPSImageObjectDetectionModelSpec.properties.stopReason.description - schemas.XPSImageObjectDetectionModelSpec.properties.stopReason.enum - schemas.XPSImageObjectDetectionModelSpec.properties.stopReason.enumDescriptions - schemas.XPSImageObjectDetectionModelSpec.properties.stopReason.type - schemas.XPSImageObjectDetectionModelSpec.properties.trainCostNodeSeconds.description - schemas.XPSImageObjectDetectionModelSpec.properties.trainCostNodeSeconds.format - schemas.XPSImageObjectDetectionModelSpec.properties.trainCostNodeSeconds.type - schemas.XPSImageObjectDetectionModelSpec.type - schemas.XPSImageSegmentationEvaluationMetrics.description - schemas.XPSImageSegmentationEvaluationMetrics.id - schemas.XPSImageSegmentationEvaluationMetrics.properties.confidenceMetricsEntries.description - schemas.XPSImageSegmentationEvaluationMetrics.properties.confidenceMetricsEntries.items.$ref - schemas.XPSImageSegmentationEvaluationMetrics.properties.confidenceMetricsEntries.type - schemas.XPSImageSegmentationEvaluationMetrics.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.id - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confusionMatrix.$ref - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.confusionMatrix.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.diceScoreCoefficient.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.diceScoreCoefficient.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.diceScoreCoefficient.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.iouScore.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.iouScore.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.iouScore.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.precision.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.precision.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.precision.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.recall.description - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.recall.format - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.properties.recall.type - schemas.XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry.type - schemas.XPSImageSegmentationTrainResponse.id - schemas.XPSImageSegmentationTrainResponse.properties.colorMaps.description - schemas.XPSImageSegmentationTrainResponse.properties.colorMaps.items.$ref - schemas.XPSImageSegmentationTrainResponse.properties.colorMaps.type - schemas.XPSImageSegmentationTrainResponse.properties.exportModelSpec.$ref - schemas.XPSImageSegmentationTrainResponse.properties.exportModelSpec.description - schemas.XPSImageSegmentationTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSImageSegmentationTrainResponse.properties.modelArtifactSpec.description - schemas.XPSImageSegmentationTrainResponse.properties.modelServingSpec.$ref - schemas.XPSImageSegmentationTrainResponse.properties.stopReason.description - schemas.XPSImageSegmentationTrainResponse.properties.stopReason.enum - schemas.XPSImageSegmentationTrainResponse.properties.stopReason.enumDescriptions - schemas.XPSImageSegmentationTrainResponse.properties.stopReason.type - schemas.XPSImageSegmentationTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSImageSegmentationTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSImageSegmentationTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSImageSegmentationTrainResponse.type - schemas.XPSIntegratedGradientsAttribution.deprecated - schemas.XPSIntegratedGradientsAttribution.description - schemas.XPSIntegratedGradientsAttribution.id - schemas.XPSIntegratedGradientsAttribution.properties.stepCount.description - schemas.XPSIntegratedGradientsAttribution.properties.stepCount.format - schemas.XPSIntegratedGradientsAttribution.properties.stepCount.type - schemas.XPSIntegratedGradientsAttribution.type - schemas.XPSMetricEntry.id - schemas.XPSMetricEntry.properties.argentumMetricId.description - schemas.XPSMetricEntry.properties.argentumMetricId.type - schemas.XPSMetricEntry.properties.doubleValue.description - schemas.XPSMetricEntry.properties.doubleValue.format - schemas.XPSMetricEntry.properties.doubleValue.type - schemas.XPSMetricEntry.properties.int64Value.description - schemas.XPSMetricEntry.properties.int64Value.format - schemas.XPSMetricEntry.properties.int64Value.type - schemas.XPSMetricEntry.properties.metricName.description - schemas.XPSMetricEntry.properties.metricName.type - schemas.XPSMetricEntry.properties.systemLabels.description - schemas.XPSMetricEntry.properties.systemLabels.items.$ref - schemas.XPSMetricEntry.properties.systemLabels.type - schemas.XPSMetricEntry.type - schemas.XPSMetricEntryLabel.id - schemas.XPSMetricEntryLabel.properties.labelName.description - schemas.XPSMetricEntryLabel.properties.labelName.type - schemas.XPSMetricEntryLabel.properties.labelValue.description - schemas.XPSMetricEntryLabel.properties.labelValue.type - schemas.XPSMetricEntryLabel.type - schemas.XPSModelArtifactItem.description - schemas.XPSModelArtifactItem.id - schemas.XPSModelArtifactItem.properties.artifactFormat.description - schemas.XPSModelArtifactItem.properties.artifactFormat.enum - schemas.XPSModelArtifactItem.properties.artifactFormat.enumDescriptions - schemas.XPSModelArtifactItem.properties.artifactFormat.type - schemas.XPSModelArtifactItem.properties.gcsUri.description - schemas.XPSModelArtifactItem.properties.gcsUri.type - schemas.XPSModelArtifactItem.type - schemas.XPSPreprocessResponse.description - schemas.XPSPreprocessResponse.id - schemas.XPSPreprocessResponse.properties.outputExampleSet.$ref - schemas.XPSPreprocessResponse.properties.outputExampleSet.description - schemas.XPSPreprocessResponse.properties.speechPreprocessResp.$ref - schemas.XPSPreprocessResponse.properties.tablesPreprocessResponse.$ref - schemas.XPSPreprocessResponse.properties.translationPreprocessResp.$ref - schemas.XPSPreprocessResponse.type - schemas.XPSRegressionEvaluationMetrics.description - schemas.XPSRegressionEvaluationMetrics.id - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsoluteError.description - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsoluteError.format - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsoluteError.type - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsolutePercentageError.description - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsolutePercentageError.format - schemas.XPSRegressionEvaluationMetrics.properties.meanAbsolutePercentageError.type - schemas.XPSRegressionEvaluationMetrics.properties.rSquared.description - schemas.XPSRegressionEvaluationMetrics.properties.rSquared.format - schemas.XPSRegressionEvaluationMetrics.properties.rSquared.type - schemas.XPSRegressionEvaluationMetrics.properties.regressionMetricsEntries.description - schemas.XPSRegressionEvaluationMetrics.properties.regressionMetricsEntries.items.$ref - schemas.XPSRegressionEvaluationMetrics.properties.regressionMetricsEntries.type - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredError.description - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredError.format - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredError.type - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredLogError.description - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredLogError.format - schemas.XPSRegressionEvaluationMetrics.properties.rootMeanSquaredLogError.type - schemas.XPSRegressionEvaluationMetrics.type - schemas.XPSRegressionMetricsEntry.description - schemas.XPSRegressionMetricsEntry.id - schemas.XPSRegressionMetricsEntry.properties.predictedValue.description - schemas.XPSRegressionMetricsEntry.properties.predictedValue.format - schemas.XPSRegressionMetricsEntry.properties.predictedValue.type - schemas.XPSRegressionMetricsEntry.properties.trueValue.description - schemas.XPSRegressionMetricsEntry.properties.trueValue.format - schemas.XPSRegressionMetricsEntry.properties.trueValue.type - schemas.XPSRegressionMetricsEntry.type - schemas.XPSReportingMetrics.id - schemas.XPSReportingMetrics.properties.effectiveTrainingDuration.deprecated - schemas.XPSReportingMetrics.properties.effectiveTrainingDuration.description - schemas.XPSReportingMetrics.properties.effectiveTrainingDuration.format - schemas.XPSReportingMetrics.properties.effectiveTrainingDuration.type - schemas.XPSReportingMetrics.properties.metricEntries.description - schemas.XPSReportingMetrics.properties.metricEntries.items.$ref - schemas.XPSReportingMetrics.properties.metricEntries.type - schemas.XPSReportingMetrics.type - schemas.XPSResponseExplanationMetadata.deprecated - schemas.XPSResponseExplanationMetadata.id - schemas.XPSResponseExplanationMetadata.properties.inputs.additionalProperties.$ref - schemas.XPSResponseExplanationMetadata.properties.inputs.description - schemas.XPSResponseExplanationMetadata.properties.inputs.type - schemas.XPSResponseExplanationMetadata.properties.outputs.additionalProperties.$ref - schemas.XPSResponseExplanationMetadata.properties.outputs.description - schemas.XPSResponseExplanationMetadata.properties.outputs.type - schemas.XPSResponseExplanationMetadata.type - schemas.XPSResponseExplanationMetadataInputMetadata.description - schemas.XPSResponseExplanationMetadataInputMetadata.id - schemas.XPSResponseExplanationMetadataInputMetadata.properties.inputTensorName.description - schemas.XPSResponseExplanationMetadataInputMetadata.properties.inputTensorName.type - schemas.XPSResponseExplanationMetadataInputMetadata.properties.modality.description - schemas.XPSResponseExplanationMetadataInputMetadata.properties.modality.enum - schemas.XPSResponseExplanationMetadataInputMetadata.properties.modality.enumDescriptions - schemas.XPSResponseExplanationMetadataInputMetadata.properties.modality.type - schemas.XPSResponseExplanationMetadataInputMetadata.properties.visualizationConfig.$ref - schemas.XPSResponseExplanationMetadataInputMetadata.properties.visualizationConfig.description - schemas.XPSResponseExplanationMetadataInputMetadata.type - schemas.XPSResponseExplanationMetadataOutputMetadata.description - schemas.XPSResponseExplanationMetadataOutputMetadata.id - schemas.XPSResponseExplanationMetadataOutputMetadata.properties.outputTensorName.description - schemas.XPSResponseExplanationMetadataOutputMetadata.properties.outputTensorName.type - schemas.XPSResponseExplanationMetadataOutputMetadata.type - schemas.XPSResponseExplanationParameters.deprecated - schemas.XPSResponseExplanationParameters.id - schemas.XPSResponseExplanationParameters.properties.integratedGradientsAttribution.$ref - schemas.XPSResponseExplanationParameters.properties.integratedGradientsAttribution.description - schemas.XPSResponseExplanationParameters.properties.xraiAttribution.$ref - schemas.XPSResponseExplanationParameters.properties.xraiAttribution.description - schemas.XPSResponseExplanationParameters.type - schemas.XPSResponseExplanationSpec.deprecated - schemas.XPSResponseExplanationSpec.description - schemas.XPSResponseExplanationSpec.id - schemas.XPSResponseExplanationSpec.properties.explanationType.description - schemas.XPSResponseExplanationSpec.properties.explanationType.type - schemas.XPSResponseExplanationSpec.properties.metadata.$ref - schemas.XPSResponseExplanationSpec.properties.metadata.description - schemas.XPSResponseExplanationSpec.properties.parameters.$ref - schemas.XPSResponseExplanationSpec.properties.parameters.description - schemas.XPSResponseExplanationSpec.type - schemas.XPSRow.id - schemas.XPSRow.properties.columnIds.description - schemas.XPSRow.properties.columnIds.items.format - schemas.XPSRow.properties.columnIds.items.type - schemas.XPSRow.properties.columnIds.type - schemas.XPSRow.properties.values.description - schemas.XPSRow.properties.values.items.type - schemas.XPSRow.properties.values.type - schemas.XPSRow.type - schemas.XPSSpeechEvaluationMetrics.id - schemas.XPSSpeechEvaluationMetrics.properties.subModelEvaluationMetrics.description - schemas.XPSSpeechEvaluationMetrics.properties.subModelEvaluationMetrics.items.$ref - schemas.XPSSpeechEvaluationMetrics.properties.subModelEvaluationMetrics.type - schemas.XPSSpeechEvaluationMetrics.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.id - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.biasingModelType.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.biasingModelType.enum - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.biasingModelType.enumDescriptions - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.biasingModelType.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.isEnhancedModel.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.isEnhancedModel.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numDeletions.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numDeletions.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numInsertions.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numInsertions.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numSubstitutions.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numSubstitutions.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numUtterances.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numUtterances.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numUtterances.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numWords.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numWords.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.numWords.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.sentenceAccuracy.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.sentenceAccuracy.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.sentenceAccuracy.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.wer.description - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.wer.format - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.properties.wer.type - schemas.XPSSpeechEvaluationMetricsSubModelEvaluationMetric.type - schemas.XPSSpeechModelSpec.id - schemas.XPSSpeechModelSpec.properties.datasetId.description - schemas.XPSSpeechModelSpec.properties.datasetId.format - schemas.XPSSpeechModelSpec.properties.datasetId.type - schemas.XPSSpeechModelSpec.properties.language.type - schemas.XPSSpeechModelSpec.properties.subModelSpecs.description - schemas.XPSSpeechModelSpec.properties.subModelSpecs.items.$ref - schemas.XPSSpeechModelSpec.properties.subModelSpecs.type - schemas.XPSSpeechModelSpec.type - schemas.XPSSpeechModelSpecSubModelSpec.id - schemas.XPSSpeechModelSpecSubModelSpec.properties.biasingModelType.description - schemas.XPSSpeechModelSpecSubModelSpec.properties.biasingModelType.enum - schemas.XPSSpeechModelSpecSubModelSpec.properties.biasingModelType.enumDescriptions - schemas.XPSSpeechModelSpecSubModelSpec.properties.biasingModelType.type - schemas.XPSSpeechModelSpecSubModelSpec.properties.clientId.description - schemas.XPSSpeechModelSpecSubModelSpec.properties.clientId.type - schemas.XPSSpeechModelSpecSubModelSpec.properties.contextId.description - schemas.XPSSpeechModelSpecSubModelSpec.properties.contextId.type - schemas.XPSSpeechModelSpecSubModelSpec.properties.isEnhancedModel.description - schemas.XPSSpeechModelSpecSubModelSpec.properties.isEnhancedModel.type - schemas.XPSSpeechModelSpecSubModelSpec.type - schemas.XPSSpeechPreprocessResponse.id - schemas.XPSSpeechPreprocessResponse.properties.cnsTestDataPath.description - schemas.XPSSpeechPreprocessResponse.properties.cnsTestDataPath.type - schemas.XPSSpeechPreprocessResponse.properties.cnsTrainDataPath.description - schemas.XPSSpeechPreprocessResponse.properties.cnsTrainDataPath.type - schemas.XPSSpeechPreprocessResponse.properties.prebuiltModelEvaluationMetrics.$ref - schemas.XPSSpeechPreprocessResponse.properties.prebuiltModelEvaluationMetrics.description - schemas.XPSSpeechPreprocessResponse.properties.speechPreprocessStats.$ref - schemas.XPSSpeechPreprocessResponse.properties.speechPreprocessStats.description - schemas.XPSSpeechPreprocessResponse.type - schemas.XPSSpeechPreprocessStats.id - schemas.XPSSpeechPreprocessStats.properties.dataErrors.description - schemas.XPSSpeechPreprocessStats.properties.dataErrors.items.$ref - schemas.XPSSpeechPreprocessStats.properties.dataErrors.type - schemas.XPSSpeechPreprocessStats.properties.numHumanLabeledExamples.description - schemas.XPSSpeechPreprocessStats.properties.numHumanLabeledExamples.format - schemas.XPSSpeechPreprocessStats.properties.numHumanLabeledExamples.type - schemas.XPSSpeechPreprocessStats.properties.numLogsExamples.description - schemas.XPSSpeechPreprocessStats.properties.numLogsExamples.format - schemas.XPSSpeechPreprocessStats.properties.numLogsExamples.type - schemas.XPSSpeechPreprocessStats.properties.numMachineTranscribedExamples.description - schemas.XPSSpeechPreprocessStats.properties.numMachineTranscribedExamples.format - schemas.XPSSpeechPreprocessStats.properties.numMachineTranscribedExamples.type - schemas.XPSSpeechPreprocessStats.properties.testExamplesCount.description - schemas.XPSSpeechPreprocessStats.properties.testExamplesCount.format - schemas.XPSSpeechPreprocessStats.properties.testExamplesCount.type - schemas.XPSSpeechPreprocessStats.properties.testSentencesCount.description - schemas.XPSSpeechPreprocessStats.properties.testSentencesCount.format - schemas.XPSSpeechPreprocessStats.properties.testSentencesCount.type - schemas.XPSSpeechPreprocessStats.properties.testWordsCount.description - schemas.XPSSpeechPreprocessStats.properties.testWordsCount.format - schemas.XPSSpeechPreprocessStats.properties.testWordsCount.type - schemas.XPSSpeechPreprocessStats.properties.trainExamplesCount.description - schemas.XPSSpeechPreprocessStats.properties.trainExamplesCount.format - schemas.XPSSpeechPreprocessStats.properties.trainExamplesCount.type - schemas.XPSSpeechPreprocessStats.properties.trainSentencesCount.description - schemas.XPSSpeechPreprocessStats.properties.trainSentencesCount.format - schemas.XPSSpeechPreprocessStats.properties.trainSentencesCount.type - schemas.XPSSpeechPreprocessStats.properties.trainWordsCount.description - schemas.XPSSpeechPreprocessStats.properties.trainWordsCount.format - schemas.XPSSpeechPreprocessStats.properties.trainWordsCount.type - schemas.XPSSpeechPreprocessStats.type - schemas.XPSStringStats.description - schemas.XPSStringStats.id - schemas.XPSStringStats.properties.commonStats.$ref - schemas.XPSStringStats.properties.topUnigramStats.description - schemas.XPSStringStats.properties.topUnigramStats.items.$ref - schemas.XPSStringStats.properties.topUnigramStats.type - schemas.XPSStringStats.type - schemas.XPSStringStatsUnigramStats.description - schemas.XPSStringStatsUnigramStats.id - schemas.XPSStringStatsUnigramStats.properties.count.description - schemas.XPSStringStatsUnigramStats.properties.count.format - schemas.XPSStringStatsUnigramStats.properties.count.type - schemas.XPSStringStatsUnigramStats.properties.value.description - schemas.XPSStringStatsUnigramStats.properties.value.type - schemas.XPSStringStatsUnigramStats.type - schemas.XPSStructStats.description - schemas.XPSStructStats.id - schemas.XPSStructStats.properties.commonStats.$ref - schemas.XPSStructStats.properties.fieldStats.additionalProperties.$ref - schemas.XPSStructStats.properties.fieldStats.description - schemas.XPSStructStats.properties.fieldStats.type - schemas.XPSStructStats.type - schemas.XPSStructType.description - schemas.XPSStructType.id - schemas.XPSStructType.properties.fields.additionalProperties.$ref - schemas.XPSStructType.properties.fields.description - schemas.XPSStructType.properties.fields.type - schemas.XPSStructType.type - schemas.XPSTableSpec.id - schemas.XPSTableSpec.properties.columnSpecs.additionalProperties.$ref - schemas.XPSTableSpec.properties.columnSpecs.description - schemas.XPSTableSpec.properties.columnSpecs.type - schemas.XPSTableSpec.properties.importedDataSizeInBytes.description - schemas.XPSTableSpec.properties.importedDataSizeInBytes.format - schemas.XPSTableSpec.properties.importedDataSizeInBytes.type - schemas.XPSTableSpec.properties.rowCount.description - schemas.XPSTableSpec.properties.rowCount.format - schemas.XPSTableSpec.properties.rowCount.type - schemas.XPSTableSpec.properties.timeColumnId.description - schemas.XPSTableSpec.properties.timeColumnId.format - schemas.XPSTableSpec.properties.timeColumnId.type - schemas.XPSTableSpec.properties.validRowCount.description - schemas.XPSTableSpec.properties.validRowCount.format - schemas.XPSTableSpec.properties.validRowCount.type - schemas.XPSTableSpec.type - schemas.XPSTablesClassificationMetrics.description - schemas.XPSTablesClassificationMetrics.id - schemas.XPSTablesClassificationMetrics.properties.curveMetrics.description - schemas.XPSTablesClassificationMetrics.properties.curveMetrics.items.$ref - schemas.XPSTablesClassificationMetrics.properties.curveMetrics.type - schemas.XPSTablesClassificationMetrics.type - schemas.XPSTablesClassificationMetricsCurveMetrics.description - schemas.XPSTablesClassificationMetricsCurveMetrics.id - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucPr.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucPr.format - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucPr.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucRoc.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucRoc.format - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.aucRoc.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.confidenceMetricsEntries.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.confidenceMetricsEntries.items.$ref - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.confidenceMetricsEntries.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.logLoss.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.logLoss.format - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.logLoss.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.positionThreshold.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.positionThreshold.format - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.positionThreshold.type - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.value.description - schemas.XPSTablesClassificationMetricsCurveMetrics.properties.value.type - schemas.XPSTablesClassificationMetricsCurveMetrics.type - schemas.XPSTablesConfidenceMetricsEntry.description - schemas.XPSTablesConfidenceMetricsEntry.id - schemas.XPSTablesConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSTablesConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSTablesConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSTablesConfidenceMetricsEntry.properties.f1Score.description - schemas.XPSTablesConfidenceMetricsEntry.properties.f1Score.format - schemas.XPSTablesConfidenceMetricsEntry.properties.f1Score.type - schemas.XPSTablesConfidenceMetricsEntry.properties.falseNegativeCount.description - schemas.XPSTablesConfidenceMetricsEntry.properties.falseNegativeCount.format - schemas.XPSTablesConfidenceMetricsEntry.properties.falseNegativeCount.type - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveCount.description - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveCount.format - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveCount.type - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveRate.description - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveRate.format - schemas.XPSTablesConfidenceMetricsEntry.properties.falsePositiveRate.type - schemas.XPSTablesConfidenceMetricsEntry.properties.precision.description - schemas.XPSTablesConfidenceMetricsEntry.properties.precision.format - schemas.XPSTablesConfidenceMetricsEntry.properties.precision.type - schemas.XPSTablesConfidenceMetricsEntry.properties.recall.description - schemas.XPSTablesConfidenceMetricsEntry.properties.recall.format - schemas.XPSTablesConfidenceMetricsEntry.properties.recall.type - schemas.XPSTablesConfidenceMetricsEntry.properties.trueNegativeCount.description - schemas.XPSTablesConfidenceMetricsEntry.properties.trueNegativeCount.format - schemas.XPSTablesConfidenceMetricsEntry.properties.trueNegativeCount.type - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveCount.description - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveCount.format - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveCount.type - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveRate.description - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveRate.format - schemas.XPSTablesConfidenceMetricsEntry.properties.truePositiveRate.type - schemas.XPSTablesConfidenceMetricsEntry.type - schemas.XPSTablesDatasetMetadata.description - schemas.XPSTablesDatasetMetadata.id - schemas.XPSTablesDatasetMetadata.properties.mlUseColumnId.description - schemas.XPSTablesDatasetMetadata.properties.mlUseColumnId.format - schemas.XPSTablesDatasetMetadata.properties.mlUseColumnId.type - schemas.XPSTablesDatasetMetadata.properties.primaryTableSpec.$ref - schemas.XPSTablesDatasetMetadata.properties.primaryTableSpec.description - schemas.XPSTablesDatasetMetadata.properties.targetColumnCorrelations.additionalProperties.$ref - schemas.XPSTablesDatasetMetadata.properties.targetColumnCorrelations.description - schemas.XPSTablesDatasetMetadata.properties.targetColumnCorrelations.type - schemas.XPSTablesDatasetMetadata.properties.targetColumnId.description - schemas.XPSTablesDatasetMetadata.properties.targetColumnId.format - schemas.XPSTablesDatasetMetadata.properties.targetColumnId.type - schemas.XPSTablesDatasetMetadata.properties.weightColumnId.description - schemas.XPSTablesDatasetMetadata.properties.weightColumnId.format - schemas.XPSTablesDatasetMetadata.properties.weightColumnId.type - schemas.XPSTablesDatasetMetadata.type - schemas.XPSTablesEvaluationMetrics.id - schemas.XPSTablesEvaluationMetrics.properties.classificationMetrics.$ref - schemas.XPSTablesEvaluationMetrics.properties.classificationMetrics.description - schemas.XPSTablesEvaluationMetrics.properties.regressionMetrics.$ref - schemas.XPSTablesEvaluationMetrics.properties.regressionMetrics.description - schemas.XPSTablesEvaluationMetrics.type - schemas.XPSTablesModelColumnInfo.description - schemas.XPSTablesModelColumnInfo.id - schemas.XPSTablesModelColumnInfo.properties.columnId.description - schemas.XPSTablesModelColumnInfo.properties.columnId.format - schemas.XPSTablesModelColumnInfo.properties.columnId.type - schemas.XPSTablesModelColumnInfo.properties.featureImportance.description - schemas.XPSTablesModelColumnInfo.properties.featureImportance.format - schemas.XPSTablesModelColumnInfo.properties.featureImportance.type - schemas.XPSTablesModelColumnInfo.type - schemas.XPSTablesModelStructure.description - schemas.XPSTablesModelStructure.id - schemas.XPSTablesModelStructure.properties.modelParameters.description - schemas.XPSTablesModelStructure.properties.modelParameters.items.$ref - schemas.XPSTablesModelStructure.properties.modelParameters.type - schemas.XPSTablesModelStructure.type - schemas.XPSTablesModelStructureModelParameters.description - schemas.XPSTablesModelStructureModelParameters.id - schemas.XPSTablesModelStructureModelParameters.properties.hyperparameters.items.$ref - schemas.XPSTablesModelStructureModelParameters.properties.hyperparameters.type - schemas.XPSTablesModelStructureModelParameters.type - schemas.XPSTablesModelStructureModelParametersParameter.id - schemas.XPSTablesModelStructureModelParametersParameter.properties.floatValue.description - schemas.XPSTablesModelStructureModelParametersParameter.properties.floatValue.format - schemas.XPSTablesModelStructureModelParametersParameter.properties.floatValue.type - schemas.XPSTablesModelStructureModelParametersParameter.properties.intValue.description - schemas.XPSTablesModelStructureModelParametersParameter.properties.intValue.format - schemas.XPSTablesModelStructureModelParametersParameter.properties.intValue.type - schemas.XPSTablesModelStructureModelParametersParameter.properties.name.description - schemas.XPSTablesModelStructureModelParametersParameter.properties.name.type - schemas.XPSTablesModelStructureModelParametersParameter.properties.stringValue.description - schemas.XPSTablesModelStructureModelParametersParameter.properties.stringValue.type - schemas.XPSTablesModelStructureModelParametersParameter.type - schemas.XPSTablesPreprocessResponse.id - schemas.XPSTablesPreprocessResponse.properties.tablesDatasetMetadata.$ref - schemas.XPSTablesPreprocessResponse.properties.tablesDatasetMetadata.description - schemas.XPSTablesPreprocessResponse.type - schemas.XPSTablesRegressionMetrics.description - schemas.XPSTablesRegressionMetrics.id - schemas.XPSTablesRegressionMetrics.properties.meanAbsoluteError.description - schemas.XPSTablesRegressionMetrics.properties.meanAbsoluteError.format - schemas.XPSTablesRegressionMetrics.properties.meanAbsoluteError.type - schemas.XPSTablesRegressionMetrics.properties.meanAbsolutePercentageError.description - schemas.XPSTablesRegressionMetrics.properties.meanAbsolutePercentageError.format - schemas.XPSTablesRegressionMetrics.properties.meanAbsolutePercentageError.type - schemas.XPSTablesRegressionMetrics.properties.rSquared.description - schemas.XPSTablesRegressionMetrics.properties.rSquared.format - schemas.XPSTablesRegressionMetrics.properties.rSquared.type - schemas.XPSTablesRegressionMetrics.properties.regressionMetricsEntries.description - schemas.XPSTablesRegressionMetrics.properties.regressionMetricsEntries.items.$ref - schemas.XPSTablesRegressionMetrics.properties.regressionMetricsEntries.type - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredError.description - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredError.format - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredError.type - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredLogError.description - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredLogError.format - schemas.XPSTablesRegressionMetrics.properties.rootMeanSquaredLogError.type - schemas.XPSTablesRegressionMetrics.type - schemas.XPSTablesTrainResponse.id - schemas.XPSTablesTrainResponse.properties.modelStructure.$ref - schemas.XPSTablesTrainResponse.properties.predictionSampleRows.description - schemas.XPSTablesTrainResponse.properties.predictionSampleRows.items.$ref - schemas.XPSTablesTrainResponse.properties.predictionSampleRows.type - schemas.XPSTablesTrainResponse.properties.tablesModelColumnInfo.description - schemas.XPSTablesTrainResponse.properties.tablesModelColumnInfo.items.$ref - schemas.XPSTablesTrainResponse.properties.tablesModelColumnInfo.type - schemas.XPSTablesTrainResponse.properties.trainCostMilliNodeHours.description - schemas.XPSTablesTrainResponse.properties.trainCostMilliNodeHours.format - schemas.XPSTablesTrainResponse.properties.trainCostMilliNodeHours.type - schemas.XPSTablesTrainResponse.type - schemas.XPSTablesTrainingOperationMetadata.id - schemas.XPSTablesTrainingOperationMetadata.properties.createModelStage.description - schemas.XPSTablesTrainingOperationMetadata.properties.createModelStage.enum - schemas.XPSTablesTrainingOperationMetadata.properties.createModelStage.enumDescriptions - schemas.XPSTablesTrainingOperationMetadata.properties.createModelStage.type - schemas.XPSTablesTrainingOperationMetadata.properties.optimizationObjective.description - schemas.XPSTablesTrainingOperationMetadata.properties.optimizationObjective.type - schemas.XPSTablesTrainingOperationMetadata.properties.topTrials.description - schemas.XPSTablesTrainingOperationMetadata.properties.topTrials.items.$ref - schemas.XPSTablesTrainingOperationMetadata.properties.topTrials.type - schemas.XPSTablesTrainingOperationMetadata.properties.trainBudgetMilliNodeHours.description - schemas.XPSTablesTrainingOperationMetadata.properties.trainBudgetMilliNodeHours.format - schemas.XPSTablesTrainingOperationMetadata.properties.trainBudgetMilliNodeHours.type - schemas.XPSTablesTrainingOperationMetadata.properties.trainingObjectivePoints.description - schemas.XPSTablesTrainingOperationMetadata.properties.trainingObjectivePoints.items.$ref - schemas.XPSTablesTrainingOperationMetadata.properties.trainingObjectivePoints.type - schemas.XPSTablesTrainingOperationMetadata.properties.trainingStartTime.description - schemas.XPSTablesTrainingOperationMetadata.properties.trainingStartTime.format - schemas.XPSTablesTrainingOperationMetadata.properties.trainingStartTime.type - schemas.XPSTablesTrainingOperationMetadata.type - schemas.XPSTextComponentModel.description - schemas.XPSTextComponentModel.id - schemas.XPSTextComponentModel.properties.batchPredictionModelGcsUri.description - schemas.XPSTextComponentModel.properties.batchPredictionModelGcsUri.type - schemas.XPSTextComponentModel.properties.onlinePredictionModelGcsUri.description - schemas.XPSTextComponentModel.properties.onlinePredictionModelGcsUri.type - schemas.XPSTextComponentModel.properties.partition.description - schemas.XPSTextComponentModel.properties.partition.enum - schemas.XPSTextComponentModel.properties.partition.enumDescriptions - schemas.XPSTextComponentModel.properties.partition.type - schemas.XPSTextComponentModel.properties.servingArtifact.$ref - schemas.XPSTextComponentModel.properties.servingArtifact.description - schemas.XPSTextComponentModel.properties.servoModelName.description - schemas.XPSTextComponentModel.properties.servoModelName.type - schemas.XPSTextComponentModel.properties.submodelName.description - schemas.XPSTextComponentModel.properties.submodelName.type - schemas.XPSTextComponentModel.properties.submodelType.description - schemas.XPSTextComponentModel.properties.submodelType.enum - schemas.XPSTextComponentModel.properties.submodelType.enumDescriptions - schemas.XPSTextComponentModel.properties.submodelType.type - schemas.XPSTextComponentModel.properties.tfRuntimeVersion.description - schemas.XPSTextComponentModel.properties.tfRuntimeVersion.type - schemas.XPSTextComponentModel.properties.versionNumber.description - schemas.XPSTextComponentModel.properties.versionNumber.format - schemas.XPSTextComponentModel.properties.versionNumber.type - schemas.XPSTextComponentModel.type - schemas.XPSTextExtractionEvaluationMetrics.id - schemas.XPSTextExtractionEvaluationMetrics.properties.bestF1ConfidenceMetrics.$ref - schemas.XPSTextExtractionEvaluationMetrics.properties.bestF1ConfidenceMetrics.deprecated - schemas.XPSTextExtractionEvaluationMetrics.properties.bestF1ConfidenceMetrics.description - schemas.XPSTextExtractionEvaluationMetrics.properties.confidenceMetricsEntries.description - schemas.XPSTextExtractionEvaluationMetrics.properties.confidenceMetricsEntries.items.$ref - schemas.XPSTextExtractionEvaluationMetrics.properties.confidenceMetricsEntries.type - schemas.XPSTextExtractionEvaluationMetrics.properties.confusionMatrix.$ref - schemas.XPSTextExtractionEvaluationMetrics.properties.confusionMatrix.description - schemas.XPSTextExtractionEvaluationMetrics.properties.perLabelConfidenceMetrics.additionalProperties.$ref - schemas.XPSTextExtractionEvaluationMetrics.properties.perLabelConfidenceMetrics.deprecated - schemas.XPSTextExtractionEvaluationMetrics.properties.perLabelConfidenceMetrics.description - schemas.XPSTextExtractionEvaluationMetrics.properties.perLabelConfidenceMetrics.type - schemas.XPSTextExtractionEvaluationMetrics.type - schemas.XPSTextSentimentEvaluationMetrics.description - schemas.XPSTextSentimentEvaluationMetrics.id - schemas.XPSTextSentimentEvaluationMetrics.properties.confusionMatrix.$ref - schemas.XPSTextSentimentEvaluationMetrics.properties.confusionMatrix.description - schemas.XPSTextSentimentEvaluationMetrics.properties.f1Score.description - schemas.XPSTextSentimentEvaluationMetrics.properties.f1Score.format - schemas.XPSTextSentimentEvaluationMetrics.properties.f1Score.type - schemas.XPSTextSentimentEvaluationMetrics.properties.linearKappa.description - schemas.XPSTextSentimentEvaluationMetrics.properties.linearKappa.format - schemas.XPSTextSentimentEvaluationMetrics.properties.linearKappa.type - schemas.XPSTextSentimentEvaluationMetrics.properties.meanAbsoluteError.description - schemas.XPSTextSentimentEvaluationMetrics.properties.meanAbsoluteError.format - schemas.XPSTextSentimentEvaluationMetrics.properties.meanAbsoluteError.type - schemas.XPSTextSentimentEvaluationMetrics.properties.meanSquaredError.description - schemas.XPSTextSentimentEvaluationMetrics.properties.meanSquaredError.format - schemas.XPSTextSentimentEvaluationMetrics.properties.meanSquaredError.type - schemas.XPSTextSentimentEvaluationMetrics.properties.precision.description - schemas.XPSTextSentimentEvaluationMetrics.properties.precision.format - schemas.XPSTextSentimentEvaluationMetrics.properties.precision.type - schemas.XPSTextSentimentEvaluationMetrics.properties.quadraticKappa.description - schemas.XPSTextSentimentEvaluationMetrics.properties.quadraticKappa.format - schemas.XPSTextSentimentEvaluationMetrics.properties.quadraticKappa.type - schemas.XPSTextSentimentEvaluationMetrics.properties.recall.description - schemas.XPSTextSentimentEvaluationMetrics.properties.recall.format - schemas.XPSTextSentimentEvaluationMetrics.properties.recall.type - schemas.XPSTextSentimentEvaluationMetrics.type - schemas.XPSTextToSpeechTrainResponse.description - schemas.XPSTextToSpeechTrainResponse.id - schemas.XPSTextToSpeechTrainResponse.type - schemas.XPSTextTrainResponse.id - schemas.XPSTextTrainResponse.properties.componentModel.description - schemas.XPSTextTrainResponse.properties.componentModel.items.$ref - schemas.XPSTextTrainResponse.properties.componentModel.type - schemas.XPSTextTrainResponse.type - schemas.XPSTfJsFormat.description - schemas.XPSTfJsFormat.id - schemas.XPSTfJsFormat.type - schemas.XPSTfLiteFormat.description - schemas.XPSTfLiteFormat.id - schemas.XPSTfLiteFormat.type - schemas.XPSTfSavedModelFormat.description - schemas.XPSTfSavedModelFormat.id - schemas.XPSTfSavedModelFormat.type - schemas.XPSTimestampStats.description - schemas.XPSTimestampStats.id - schemas.XPSTimestampStats.properties.commonStats.$ref - schemas.XPSTimestampStats.properties.granularStats.additionalProperties.$ref - schemas.XPSTimestampStats.properties.granularStats.description - schemas.XPSTimestampStats.properties.granularStats.type - schemas.XPSTimestampStats.properties.medianTimestampNanos.format - schemas.XPSTimestampStats.properties.medianTimestampNanos.type - schemas.XPSTimestampStats.type - schemas.XPSTimestampStatsGranularStats.description - schemas.XPSTimestampStatsGranularStats.id - schemas.XPSTimestampStatsGranularStats.properties.buckets.additionalProperties.format - schemas.XPSTimestampStatsGranularStats.properties.buckets.additionalProperties.type - schemas.XPSTimestampStatsGranularStats.properties.buckets.description - schemas.XPSTimestampStatsGranularStats.properties.buckets.type - schemas.XPSTimestampStatsGranularStats.type - schemas.XPSTrackMetricsEntry.description - schemas.XPSTrackMetricsEntry.id - schemas.XPSTrackMetricsEntry.properties.confidenceMetricsEntries.description - schemas.XPSTrackMetricsEntry.properties.confidenceMetricsEntries.items.$ref - schemas.XPSTrackMetricsEntry.properties.confidenceMetricsEntries.type - schemas.XPSTrackMetricsEntry.properties.iouThreshold.description - schemas.XPSTrackMetricsEntry.properties.iouThreshold.format - schemas.XPSTrackMetricsEntry.properties.iouThreshold.type - schemas.XPSTrackMetricsEntry.properties.meanBoundingBoxIou.description - schemas.XPSTrackMetricsEntry.properties.meanBoundingBoxIou.format - schemas.XPSTrackMetricsEntry.properties.meanBoundingBoxIou.type - schemas.XPSTrackMetricsEntry.properties.meanMismatchRate.description - schemas.XPSTrackMetricsEntry.properties.meanMismatchRate.format - schemas.XPSTrackMetricsEntry.properties.meanMismatchRate.type - schemas.XPSTrackMetricsEntry.properties.meanTrackingAveragePrecision.description - schemas.XPSTrackMetricsEntry.properties.meanTrackingAveragePrecision.format - schemas.XPSTrackMetricsEntry.properties.meanTrackingAveragePrecision.type - schemas.XPSTrackMetricsEntry.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.id - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.boundingBoxIou.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.boundingBoxIou.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.boundingBoxIou.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.mismatchRate.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.mismatchRate.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.mismatchRate.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingPrecision.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingPrecision.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingPrecision.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingRecall.description - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingRecall.format - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.properties.trackingRecall.type - schemas.XPSTrackMetricsEntryConfidenceMetricsEntry.type - schemas.XPSTrainResponse.description - schemas.XPSTrainResponse.id - schemas.XPSTrainResponse.properties.deployedModelSizeBytes.description - schemas.XPSTrainResponse.properties.deployedModelSizeBytes.format - schemas.XPSTrainResponse.properties.deployedModelSizeBytes.type - schemas.XPSTrainResponse.properties.errorAnalysisConfigs.description - schemas.XPSTrainResponse.properties.errorAnalysisConfigs.items.$ref - schemas.XPSTrainResponse.properties.errorAnalysisConfigs.type - schemas.XPSTrainResponse.properties.evaluatedExampleSet.$ref - schemas.XPSTrainResponse.properties.evaluatedExampleSet.description - schemas.XPSTrainResponse.properties.evaluationMetricsSet.$ref - schemas.XPSTrainResponse.properties.evaluationMetricsSet.description - schemas.XPSTrainResponse.properties.explanationConfigs.deprecated - schemas.XPSTrainResponse.properties.explanationConfigs.description - schemas.XPSTrainResponse.properties.explanationConfigs.items.$ref - schemas.XPSTrainResponse.properties.explanationConfigs.type - schemas.XPSTrainResponse.properties.imageClassificationTrainResp.$ref - schemas.XPSTrainResponse.properties.imageObjectDetectionTrainResp.$ref - schemas.XPSTrainResponse.properties.imageSegmentationTrainResp.$ref - schemas.XPSTrainResponse.properties.modelToken.description - schemas.XPSTrainResponse.properties.modelToken.format - schemas.XPSTrainResponse.properties.modelToken.type - schemas.XPSTrainResponse.properties.speechTrainResp.$ref - schemas.XPSTrainResponse.properties.tablesTrainResp.$ref - schemas.XPSTrainResponse.properties.textToSpeechTrainResp.$ref - schemas.XPSTrainResponse.properties.textTrainResp.$ref - schemas.XPSTrainResponse.properties.textTrainResp.description - schemas.XPSTrainResponse.properties.translationTrainResp.$ref - schemas.XPSTrainResponse.properties.videoActionRecognitionTrainResp.$ref - schemas.XPSTrainResponse.properties.videoClassificationTrainResp.$ref - schemas.XPSTrainResponse.properties.videoObjectTrackingTrainResp.$ref - schemas.XPSTrainResponse.type - schemas.XPSTrainingObjectivePoint.id - schemas.XPSTrainingObjectivePoint.properties.createTime.description - schemas.XPSTrainingObjectivePoint.properties.createTime.format - schemas.XPSTrainingObjectivePoint.properties.createTime.type - schemas.XPSTrainingObjectivePoint.properties.value.description - schemas.XPSTrainingObjectivePoint.properties.value.format - schemas.XPSTrainingObjectivePoint.properties.value.type - schemas.XPSTrainingObjectivePoint.type - schemas.XPSTranslationEvaluationMetrics.description - schemas.XPSTranslationEvaluationMetrics.id - schemas.XPSTranslationEvaluationMetrics.properties.baseBleuScore.description - schemas.XPSTranslationEvaluationMetrics.properties.baseBleuScore.format - schemas.XPSTranslationEvaluationMetrics.properties.baseBleuScore.type - schemas.XPSTranslationEvaluationMetrics.properties.bleuScore.description - schemas.XPSTranslationEvaluationMetrics.properties.bleuScore.format - schemas.XPSTranslationEvaluationMetrics.properties.bleuScore.type - schemas.XPSTranslationEvaluationMetrics.type - schemas.XPSTranslationPreprocessResponse.description - schemas.XPSTranslationPreprocessResponse.id - schemas.XPSTranslationPreprocessResponse.properties.parsedExampleCount.description - schemas.XPSTranslationPreprocessResponse.properties.parsedExampleCount.format - schemas.XPSTranslationPreprocessResponse.properties.parsedExampleCount.type - schemas.XPSTranslationPreprocessResponse.properties.validExampleCount.description - schemas.XPSTranslationPreprocessResponse.properties.validExampleCount.format - schemas.XPSTranslationPreprocessResponse.properties.validExampleCount.type - schemas.XPSTranslationPreprocessResponse.type - schemas.XPSTranslationTrainResponse.description - schemas.XPSTranslationTrainResponse.id - schemas.XPSTranslationTrainResponse.properties.modelType.description - schemas.XPSTranslationTrainResponse.properties.modelType.enum - schemas.XPSTranslationTrainResponse.properties.modelType.enumDescriptions - schemas.XPSTranslationTrainResponse.properties.modelType.type - schemas.XPSTranslationTrainResponse.type - schemas.XPSTuningTrial.description - schemas.XPSTuningTrial.id - schemas.XPSTuningTrial.properties.modelStructure.$ref - schemas.XPSTuningTrial.properties.modelStructure.description - schemas.XPSTuningTrial.properties.trainingObjectivePoint.$ref - schemas.XPSTuningTrial.properties.trainingObjectivePoint.description - schemas.XPSTuningTrial.type - schemas.XPSVideoActionMetricsEntry.description - schemas.XPSVideoActionMetricsEntry.id - schemas.XPSVideoActionMetricsEntry.properties.confidenceMetricsEntries.description - schemas.XPSVideoActionMetricsEntry.properties.confidenceMetricsEntries.items.$ref - schemas.XPSVideoActionMetricsEntry.properties.confidenceMetricsEntries.type - schemas.XPSVideoActionMetricsEntry.properties.meanAveragePrecision.description - schemas.XPSVideoActionMetricsEntry.properties.meanAveragePrecision.format - schemas.XPSVideoActionMetricsEntry.properties.meanAveragePrecision.type - schemas.XPSVideoActionMetricsEntry.properties.precisionWindowLength.description - schemas.XPSVideoActionMetricsEntry.properties.precisionWindowLength.format - schemas.XPSVideoActionMetricsEntry.properties.precisionWindowLength.type - schemas.XPSVideoActionMetricsEntry.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.id - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.format - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.confidenceThreshold.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.f1Score.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.f1Score.format - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.f1Score.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.precision.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.precision.format - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.precision.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.recall.description - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.recall.format - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.properties.recall.type - schemas.XPSVideoActionMetricsEntryConfidenceMetricsEntry.type - schemas.XPSVideoActionRecognitionEvaluationMetrics.description - schemas.XPSVideoActionRecognitionEvaluationMetrics.id - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.evaluatedActionCount.description - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.evaluatedActionCount.format - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.evaluatedActionCount.type - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.videoActionMetricsEntries.description - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.videoActionMetricsEntries.items.$ref - schemas.XPSVideoActionRecognitionEvaluationMetrics.properties.videoActionMetricsEntries.type - schemas.XPSVideoActionRecognitionEvaluationMetrics.type - schemas.XPSVideoActionRecognitionTrainResponse.id - schemas.XPSVideoActionRecognitionTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSVideoActionRecognitionTrainResponse.properties.modelArtifactSpec.description - schemas.XPSVideoActionRecognitionTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSVideoActionRecognitionTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSVideoActionRecognitionTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSVideoActionRecognitionTrainResponse.type - schemas.XPSVideoBatchPredictOperationMetadata.id - schemas.XPSVideoBatchPredictOperationMetadata.properties.outputExamples.description - schemas.XPSVideoBatchPredictOperationMetadata.properties.outputExamples.items.type - schemas.XPSVideoBatchPredictOperationMetadata.properties.outputExamples.type - schemas.XPSVideoBatchPredictOperationMetadata.type - schemas.XPSVideoClassificationTrainResponse.id - schemas.XPSVideoClassificationTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSVideoClassificationTrainResponse.properties.modelArtifactSpec.description - schemas.XPSVideoClassificationTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSVideoClassificationTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSVideoClassificationTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSVideoClassificationTrainResponse.type - schemas.XPSVideoExportModelSpec.description - schemas.XPSVideoExportModelSpec.id - schemas.XPSVideoExportModelSpec.properties.exportModelOutputConfig.description - schemas.XPSVideoExportModelSpec.properties.exportModelOutputConfig.items.$ref - schemas.XPSVideoExportModelSpec.properties.exportModelOutputConfig.type - schemas.XPSVideoExportModelSpec.type - schemas.XPSVideoModelArtifactSpec.id - schemas.XPSVideoModelArtifactSpec.properties.exportArtifact.description - schemas.XPSVideoModelArtifactSpec.properties.exportArtifact.items.$ref - schemas.XPSVideoModelArtifactSpec.properties.exportArtifact.type - schemas.XPSVideoModelArtifactSpec.properties.servingArtifact.$ref - schemas.XPSVideoModelArtifactSpec.properties.servingArtifact.description - schemas.XPSVideoModelArtifactSpec.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.id - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMeanAveragePrecision.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMetricsEntries.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMetricsEntries.items.$ref - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.boundingBoxMetricsEntries.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedBoundingboxCount.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedBoundingboxCount.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedBoundingboxCount.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedFrameCount.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedFrameCount.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedFrameCount.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedTrackCount.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedTrackCount.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.evaluatedTrackCount.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanAveragePrecision.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanAveragePrecision.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanAveragePrecision.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanBoundingBoxIou.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanBoundingBoxIou.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanBoundingBoxIou.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanMismatchRate.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanMismatchRate.format - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMeanMismatchRate.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMetricsEntries.description - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMetricsEntries.items.$ref - schemas.XPSVideoObjectTrackingEvaluationMetrics.properties.trackMetricsEntries.type - schemas.XPSVideoObjectTrackingEvaluationMetrics.type - schemas.XPSVideoObjectTrackingTrainResponse.id - schemas.XPSVideoObjectTrackingTrainResponse.properties.exportModelSpec.$ref - schemas.XPSVideoObjectTrackingTrainResponse.properties.exportModelSpec.description - schemas.XPSVideoObjectTrackingTrainResponse.properties.modelArtifactSpec.$ref - schemas.XPSVideoObjectTrackingTrainResponse.properties.modelArtifactSpec.description - schemas.XPSVideoObjectTrackingTrainResponse.properties.trainCostNodeSeconds.description - schemas.XPSVideoObjectTrackingTrainResponse.properties.trainCostNodeSeconds.format - schemas.XPSVideoObjectTrackingTrainResponse.properties.trainCostNodeSeconds.type - schemas.XPSVideoObjectTrackingTrainResponse.type - schemas.XPSVideoTrainingOperationMetadata.id - schemas.XPSVideoTrainingOperationMetadata.properties.trainCostMilliNodeHour.description - schemas.XPSVideoTrainingOperationMetadata.properties.trainCostMilliNodeHour.format - schemas.XPSVideoTrainingOperationMetadata.properties.trainCostMilliNodeHour.type - schemas.XPSVideoTrainingOperationMetadata.type - schemas.XPSVisionErrorAnalysisConfig.description - schemas.XPSVisionErrorAnalysisConfig.id - schemas.XPSVisionErrorAnalysisConfig.properties.exampleCount.description - schemas.XPSVisionErrorAnalysisConfig.properties.exampleCount.format - schemas.XPSVisionErrorAnalysisConfig.properties.exampleCount.type - schemas.XPSVisionErrorAnalysisConfig.properties.queryType.description - schemas.XPSVisionErrorAnalysisConfig.properties.queryType.enum - schemas.XPSVisionErrorAnalysisConfig.properties.queryType.enumDescriptions - schemas.XPSVisionErrorAnalysisConfig.properties.queryType.type - schemas.XPSVisionErrorAnalysisConfig.type - schemas.XPSVisionTrainingOperationMetadata.deprecated - schemas.XPSVisionTrainingOperationMetadata.id - schemas.XPSVisionTrainingOperationMetadata.properties.explanationUsage.$ref - schemas.XPSVisionTrainingOperationMetadata.properties.explanationUsage.description - schemas.XPSVisionTrainingOperationMetadata.type - schemas.XPSVisualization.deprecated - schemas.XPSVisualization.description - schemas.XPSVisualization.id - schemas.XPSVisualization.properties.clipPercentLowerbound.description - schemas.XPSVisualization.properties.clipPercentLowerbound.format - schemas.XPSVisualization.properties.clipPercentLowerbound.type - schemas.XPSVisualization.properties.clipPercentUpperbound.description - schemas.XPSVisualization.properties.clipPercentUpperbound.format - schemas.XPSVisualization.properties.clipPercentUpperbound.type - schemas.XPSVisualization.properties.colorMap.description - schemas.XPSVisualization.properties.colorMap.enum - schemas.XPSVisualization.properties.colorMap.enumDescriptions - schemas.XPSVisualization.properties.colorMap.type - schemas.XPSVisualization.properties.overlayType.description - schemas.XPSVisualization.properties.overlayType.enum - schemas.XPSVisualization.properties.overlayType.enumDescriptions - schemas.XPSVisualization.properties.overlayType.type - schemas.XPSVisualization.properties.polarity.description - schemas.XPSVisualization.properties.polarity.enum - schemas.XPSVisualization.properties.polarity.enumDescriptions - schemas.XPSVisualization.properties.polarity.type - schemas.XPSVisualization.properties.type.description - schemas.XPSVisualization.properties.type.enum - schemas.XPSVisualization.properties.type.enumDescriptions - schemas.XPSVisualization.properties.type.type - schemas.XPSVisualization.type - schemas.XPSXpsOperationMetadata.id - schemas.XPSXpsOperationMetadata.properties.exampleCount.description - schemas.XPSXpsOperationMetadata.properties.exampleCount.format - schemas.XPSXpsOperationMetadata.properties.exampleCount.type - schemas.XPSXpsOperationMetadata.properties.reportingMetrics.$ref - schemas.XPSXpsOperationMetadata.properties.reportingMetrics.description - schemas.XPSXpsOperationMetadata.properties.tablesTrainingOperationMetadata.$ref - schemas.XPSXpsOperationMetadata.properties.videoBatchPredictOperationMetadata.$ref - schemas.XPSXpsOperationMetadata.properties.videoTrainingOperationMetadata.$ref - schemas.XPSXpsOperationMetadata.properties.visionTrainingOperationMetadata.$ref - schemas.XPSXpsOperationMetadata.type - schemas.XPSXraiAttribution.deprecated - schemas.XPSXraiAttribution.description - schemas.XPSXraiAttribution.id - schemas.XPSXraiAttribution.properties.stepCount.description - schemas.XPSXraiAttribution.properties.stepCount.format - schemas.XPSXraiAttribution.properties.stepCount.type - schemas.XPSXraiAttribution.type The following keys were changed: - schemas.AnnotateTextRequest.properties.features.$ref --- discovery/language-v1.json | 4405 +++++++++++++++++++++++++++++++++++- discovery/language-v2.json | 4349 ++++++++++++++++++++++++++++++++++- src/apis/language/v1.ts | 2076 ++++++++++++++++- src/apis/language/v2.ts | 2044 ++++++++++++++++- 4 files changed, 12774 insertions(+), 100 deletions(-) diff --git a/discovery/language-v1.json b/discovery/language-v1.json index ac9a27753e8..297e0944618 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -246,7 +246,7 @@ } } }, - "revision": "20231216", + "revision": "20240310", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -465,12 +465,47 @@ "type": "string" }, "features": { - "$ref": "Features", + "$ref": "AnnotateTextRequestFeatures", "description": "Required. The enabled features." } }, "type": "object" }, + "AnnotateTextRequestFeatures": { + "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.", + "id": "AnnotateTextRequestFeatures", + "properties": { + "classificationModelOptions": { + "$ref": "ClassificationModelOptions", + "description": "Optional. The model options to use for classification. Defaults to v1 options if not specified. Only used if `classify_text` is set to true." + }, + "classifyText": { + "description": "Classify the full document into categories.", + "type": "boolean" + }, + "extractDocumentSentiment": { + "description": "Extract document-level sentiment.", + "type": "boolean" + }, + "extractEntities": { + "description": "Extract entities.", + "type": "boolean" + }, + "extractEntitySentiment": { + "description": "Extract entities and their associated sentiment.", + "type": "boolean" + }, + "extractSyntax": { + "description": "Extract syntax information.", + "type": "boolean" + }, + "moderateText": { + "description": "Moderate the document for harmful and sensitive categories.", + "type": "boolean" + } + }, + "type": "object" + }, "AnnotateTextResponse": { "description": "The text annotations response message.", "id": "AnnotateTextResponse", @@ -542,16 +577,43 @@ "id": "ClassificationModelOptions", "properties": { "v1Model": { - "$ref": "V1Model", + "$ref": "ClassificationModelOptionsV1Model", "description": "Setting this field will use the V1 model and V1 content categories version. The V1 model is a legacy model; support for this will be discontinued in the future." }, "v2Model": { - "$ref": "V2Model", + "$ref": "ClassificationModelOptionsV2Model", "description": "Setting this field will use the V2 model with the appropriate content categories version. The V2 model is a better performing model." } }, "type": "object" }, + "ClassificationModelOptionsV1Model": { + "description": "Options for the V1 model.", + "id": "ClassificationModelOptionsV1Model", + "properties": {}, + "type": "object" + }, + "ClassificationModelOptionsV2Model": { + "description": "Options for the V2 model.", + "id": "ClassificationModelOptionsV2Model", + "properties": { + "contentCategoriesVersion": { + "description": "The content categories used for classification.", + "enum": [ + "CONTENT_CATEGORIES_VERSION_UNSPECIFIED", + "V1", + "V2" + ], + "enumDescriptions": [ + "If `ContentCategoriesVersion` is not specified, this option will default to `V1`.", + "Legacy content categories of our initial launch in 2017.", + "Updated content categories in 2022." + ], + "type": "string" + } + }, + "type": "object" + }, "ClassifyTextRequest": { "description": "The document classification request message.", "id": "ClassifyTextRequest", @@ -581,6 +643,419 @@ }, "type": "object" }, + "Color": { + "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", + "id": "Color", + "properties": { + "alpha": { + "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", + "format": "float", + "type": "number" + }, + "blue": { + "description": "The amount of blue in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "green": { + "description": "The amount of green in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "red": { + "description": "The amount of red in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CpuMetric": { + "description": "Metric for billing reports.", + "id": "CpuMetric", + "properties": { + "coreNumber": { + "description": "Required. Number of CPU cores.", + "format": "int64", + "type": "string" + }, + "coreSec": { + "description": "Required. Total seconds of core usage, e.g. 4.", + "format": "int64", + "type": "string" + }, + "cpuType": { + "description": "Required. Type of cpu, e.g. N2.", + "enum": [ + "UNKNOWN_CPU_TYPE", + "A2", + "A3", + "C2", + "C2D", + "CUSTOM", + "E2", + "G2", + "C3", + "M2", + "M1", + "N1", + "N2_CUSTOM", + "N2", + "N2D" + ], + "enumDescriptions": [ + "", + "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", + "COMPUTE_OPTIMIZED", + "", + "", + "", + "GPU-based machine, skip quota reporting.", + "", + "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", + "MEMORY_OPTIMIZED", + "", + "", + "", + "" + ], + "type": "string" + }, + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, "DependencyEdge": { "description": "Represents dependency parse tree information for a token. (For more information on dependency labels, see http://www.aclweb.org/anthology/P13-2017", "id": "DependencyEdge", @@ -767,6 +1242,37 @@ }, "type": "object" }, + "DiskMetric": { + "id": "DiskMetric", + "properties": { + "diskType": { + "description": "Required. Type of Disk, e.g. REGIONAL_SSD.", + "enum": [ + "UNKNOWN_DISK_TYPE", + "REGIONAL_SSD", + "REGIONAL_STORAGE", + "PD_SSD", + "PD_STANDARD", + "STORAGE_SNAPSHOT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "gibSec": { + "description": "Required. Seconds of physical disk usage, e.g. 3600.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Document": { "description": "Represents the input to API methods.", "id": "Document", @@ -897,37 +1403,414 @@ }, "type": "object" }, - "Features": { - "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.", - "id": "Features", + "GpuMetric": { + "id": "GpuMetric", "properties": { - "classificationModelOptions": { - "$ref": "ClassificationModelOptions", - "description": "Optional. The model options to use for classification. Defaults to v1 options if not specified. Only used if `classify_text` is set to true." + "gpuSec": { + "description": "Required. Seconds of GPU usage, e.g. 3600.", + "format": "int64", + "type": "string" }, - "classifyText": { - "description": "Classify the full document into categories.", - "type": "boolean" + "gpuType": { + "description": "Required. Type of GPU, e.g. NVIDIA_TESLA_V100.", + "enum": [ + "UNKNOWN_GPU_TYPE", + "NVIDIA_TESLA_A100", + "NVIDIA_A100_80GB", + "NVIDIA_TESLA_K80", + "NVIDIA_L4", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_V100", + "NVIDIA_H100_80GB" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" }, - "extractDocumentSentiment": { - "description": "Extract document-level sentiment.", - "type": "boolean" + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" }, - "extractEntities": { - "description": "Extract entities.", - "type": "boolean" + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, + "InfraUsage": { + "description": "Infra Usage of billing metrics. Next ID: 6", + "id": "InfraUsage", + "properties": { + "cpuMetrics": { + "description": "Aggregated core metrics since requested start_time.", + "items": { + "$ref": "CpuMetric" + }, + "type": "array" }, - "extractEntitySentiment": { - "description": "Extract entities and their associated sentiment.", - "type": "boolean" + "diskMetrics": { + "description": "Aggregated persistent disk metrics since requested start_time.", + "items": { + "$ref": "DiskMetric" + }, + "type": "array" }, - "extractSyntax": { - "description": "Extract syntax information.", - "type": "boolean" + "gpuMetrics": { + "description": "Aggregated gpu metrics since requested start_time.", + "items": { + "$ref": "GpuMetric" + }, + "type": "array" }, - "moderateText": { - "description": "Moderate the document for harmful and sensitive categories.", - "type": "boolean" + "ramMetrics": { + "description": "Aggregated ram metrics since requested start_time.", + "items": { + "$ref": "RamMetric" + }, + "type": "array" + }, + "tpuMetrics": { + "description": "Aggregated tpu metrics since requested start_time.", + "items": { + "$ref": "TpuMetric" + }, + "type": "array" } }, "type": "object" @@ -1224,6 +2107,391 @@ }, "type": "object" }, + "RamMetric": { + "id": "RamMetric", + "properties": { + "gibSec": { + "description": "Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type to match billing metrics definition.", + "format": "int64", + "type": "string" + }, + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "memories": { + "description": "Required. VM memory in gb.", + "format": "double", + "type": "number" + }, + "ramType": { + "description": "Required. Type of ram.", + "enum": [ + "UNKNOWN_RAM_TYPE", + "A2", + "A3", + "C2", + "C2D", + "CUSTOM", + "E2", + "G2", + "C3", + "M2", + "M1", + "N1", + "N2_CUSTOM", + "N2", + "N2D" + ], + "enumDescriptions": [ + "", + "", + "", + "COMPUTE_OPTIMIZED", + "", + "", + "", + "", + "", + "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", + "MEMORY_OPTIMIZED", + "", + "", + "", + "" + ], + "type": "string" + }, + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, "Sentence": { "description": "Represents a sentence in the input document.", "id": "Sentence", @@ -1322,32 +2590,3079 @@ }, "type": "object" }, - "V1Model": { - "description": "Options for the V1 model.", - "id": "V1Model", - "properties": {}, - "type": "object" - }, - "V2Model": { - "description": "Options for the V2 model.", - "id": "V2Model", + "TpuMetric": { + "id": "TpuMetric", "properties": { - "contentCategoriesVersion": { - "description": "The content categories used for classification.", + "tpuSec": { + "description": "Required. Seconds of TPU usage, e.g. 3600.", + "format": "int64", + "type": "string" + }, + "tpuType": { + "description": "Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD.", "enum": [ - "CONTENT_CATEGORIES_VERSION_UNSPECIFIED", - "V1", - "V2" + "UNKNOWN_TPU_TYPE", + "TPU_V2_POD", + "TPU_V2", + "TPU_V3_POD", + "TPU_V3", + "TPU_V5_LITEPOD" ], "enumDescriptions": [ - "If `ContentCategoriesVersion` is not specified, this option will default to `V1`.", - "Legacy content categories of our initial launch in 2017.", - "Updated content categories in 2022." + "", + "", + "", + "", + "", + "" ], "type": "string" } }, "type": "object" + }, + "XPSArrayStats": { + "description": "The data statistics of a series of ARRAY values.", + "id": "XPSArrayStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "memberStats": { + "$ref": "XPSDataStats", + "description": "Stats of all the values of all arrays, as if they were a single long series of data. The type depends on the element type of the array." + } + }, + "type": "object" + }, + "XPSBatchPredictResponse": { + "id": "XPSBatchPredictResponse", + "properties": { + "exampleSet": { + "$ref": "XPSExampleSet", + "description": "Examples for batch prediction result. Under full API implementation, results are stored in shared RecordIO of AnnotatedExample protobufs, the annotations field of which is populated by XPS backend." + } + }, + "type": "object" + }, + "XPSBoundingBoxMetricsEntry": { + "description": "Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.", + "id": "XPSBoundingBoxMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "iouThreshold": { + "description": "The intersection-over-union threshold value used to compute this metrics entry.", + "format": "float", + "type": "number" + }, + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSCategoryStats": { + "description": "The data statistics of a series of CATEGORY values.", + "id": "XPSCategoryStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "topCategoryStats": { + "description": "The statistics of the top 20 CATEGORY values, ordered by CategoryStats.SingleCategoryStats.count.", + "items": { + "$ref": "XPSCategoryStatsSingleCategoryStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSCategoryStatsSingleCategoryStats": { + "description": "The statistics of a single CATEGORY value.", + "id": "XPSCategoryStatsSingleCategoryStats", + "properties": { + "count": { + "description": "The number of occurrences of this value in the series.", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The CATEGORY value.", + "type": "string" + } + }, + "type": "object" + }, + "XPSClassificationEvaluationMetrics": { + "description": "Model evaluation metrics for classification problems. It can be used for image and video classification. Next tag: 9.", + "id": "XPSClassificationEvaluationMetrics", + "properties": { + "auPrc": { + "description": "The Area under precision recall curve metric.", + "format": "float", + "type": "number" + }, + "auRoc": { + "description": "The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation.", + "format": "float", + "type": "number" + }, + "baseAuPrc": { + "description": "The Area under precision recall curve metric based on priors.", + "format": "float", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from it.", + "items": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "type": "array" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the evaluation. Only set for MULTICLASS classification problems where number of annotation specs is no more than 10. Only set for model level evaluation, not for evaluation per label." + }, + "evaluatedExamplesCount": { + "description": "The number of examples used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "logLoss": { + "description": "The Log Loss metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSColorMap": { + "description": "Map from color to display name. Will only be used by Image Segmentation for uCAIP.", + "id": "XPSColorMap", + "properties": { + "annotationSpecIdToken": { + "description": "Should be used during training.", + "type": "string" + }, + "color": { + "$ref": "Color", + "deprecated": true, + "description": "This type is deprecated in favor of the IntColor below. This is because google.type.Color represent color has a float which semantically does not reflect discrete classes/categories concept. Moreover, to handle it well we need to have some tolerance when converting to a discretized color. As such, the recommendation is to have API surface still use google.type.Color while internally IntColor is used." + }, + "displayName": { + "description": "Should be used during preprocessing.", + "type": "string" + }, + "intColor": { + "$ref": "XPSColorMapIntColor" + } + }, + "type": "object" + }, + "XPSColorMapIntColor": { + "description": "RGB color and each channel is represented by an integer.", + "id": "XPSColorMapIntColor", + "properties": { + "blue": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + }, + "green": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + }, + "red": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSColumnSpec": { + "id": "XPSColumnSpec", + "properties": { + "columnId": { + "description": "The unique id of the column. When Preprocess, the Tables BE will popuate the order id of the column, which reflects the order of the column inside the table, i.e. 0 means the first column in the table, N-1 means the last column. AutoML BE will persist this order id in Spanner and set the order id here when calling RefreshTablesStats and Train. Note: it's different than the column_spec_id that is generated in AutoML BE.", + "format": "int32", + "type": "integer" + }, + "dataStats": { + "$ref": "XPSDataStats", + "description": "The data stats of the column. It's outputed in RefreshTablesStats and a required input for Train." + }, + "dataType": { + "$ref": "XPSDataType", + "description": "The data type of the column. It's outputed in Preprocess rpc and a required input for RefreshTablesStats and Train." + }, + "displayName": { + "description": "The display name of the column. It's outputed in Preprocess and a required input for RefreshTablesStats and Train.", + "type": "string" + }, + "forecastingMetadata": { + "$ref": "XPSColumnSpecForecastingMetadata" + }, + "topCorrelatedColumns": { + "description": "It's outputed in RefreshTablesStats, and a required input in Train.", + "items": { + "$ref": "XPSColumnSpecCorrelatedColumn" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSColumnSpecCorrelatedColumn": { + "description": "Identifies a table's column, and its correlation with the column this ColumnSpec describes.", + "id": "XPSColumnSpecCorrelatedColumn", + "properties": { + "columnId": { + "format": "int32", + "type": "integer" + }, + "correlationStats": { + "$ref": "XPSCorrelationStats" + } + }, + "type": "object" + }, + "XPSColumnSpecForecastingMetadata": { + "description": "=========================================================================== # The fields below are used exclusively for Forecasting.", + "id": "XPSColumnSpecForecastingMetadata", + "properties": { + "columnType": { + "description": "The type of the column for FORECASTING model training purposes.", + "enum": [ + "COLUMN_TYPE_UNSPECIFIED", + "KEY", + "KEY_METADATA", + "TIME_SERIES_AVAILABLE_PAST_ONLY", + "TIME_SERIES_AVAILABLE_PAST_AND_FUTURE" + ], + "enumDescriptions": [ + "An un-set value of this enum.", + "Key columns are used to identify timeseries.", + "This column contains information describing static properties of the entities identified by the key column(s) (e.g. city's ZIP code).", + "This column contains information for the given entity, at any time poinrt, they are only available in the time series before.", + "This column contains information for the given entity is known both for the past and the sufficiently far future." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSCommonStats": { + "description": "Common statistics for a column with a specified data type.", + "id": "XPSCommonStats", + "properties": { + "distinctValueCount": { + "format": "int64", + "type": "string" + }, + "nullValueCount": { + "format": "int64", + "type": "string" + }, + "validValueCount": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSConfidenceMetricsEntry": { + "description": "ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. Next tag: 16.", + "id": "XPSConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Metrics are computed with an assumption that the model never return predictions with score lower than this value.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "f1ScoreAt1": { + "description": "The harmonic mean of recall_at1 and precision_at1.", + "format": "float", + "type": "number" + }, + "falseNegativeCount": { + "description": "The number of ground truth labels that are not matched by a model created label.", + "format": "int64", + "type": "string" + }, + "falsePositiveCount": { + "description": "The number of model created labels that do not match a ground truth label.", + "format": "int64", + "type": "string" + }, + "falsePositiveRate": { + "description": "False Positive Rate for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "falsePositiveRateAt1": { + "description": "The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "positionThreshold": { + "description": "Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold.", + "format": "int32", + "type": "integer" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "precisionAt1": { + "description": "The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall (true positive rate) for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recallAt1": { + "description": "The recall (true positive rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "trueNegativeCount": { + "description": "The number of labels that were not created by the model, but if they would, they would not match a ground truth label.", + "format": "int64", + "type": "string" + }, + "truePositiveCount": { + "description": "The number of model created labels that match a ground truth label.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSConfusionMatrix": { + "description": "Confusion matrix of the model running the classification.", + "id": "XPSConfusionMatrix", + "properties": { + "annotationSpecIdToken": { + "description": "For the following three repeated fields, only one is intended to be set. annotation_spec_id_token is preferable to be set. ID tokens of the annotation specs used in the confusion matrix.", + "items": { + "type": "string" + }, + "type": "array" + }, + "category": { + "description": "Category (mainly for segmentation). Set only for image segmentation models. Note: uCAIP Image Segmentation should use annotation_spec_id_token.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "row": { + "description": "Rows in the confusion matrix. The number of rows is equal to the size of `annotation_spec_id_token`. `row[i].value[j]` is the number of examples that have ground truth of the `annotation_spec_id_token[i]` and are predicted as `annotation_spec_id_token[j]` by the model being evaluated.", + "items": { + "$ref": "XPSConfusionMatrixRow" + }, + "type": "array" + }, + "sentimentLabel": { + "description": "Sentiment labels used in the confusion matrix. Set only for text sentiment models. For AutoML Text Revamp, use `annotation_spec_id_token` instead and leave this field empty.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSConfusionMatrixRow": { + "description": "A row in the confusion matrix.", + "id": "XPSConfusionMatrixRow", + "properties": { + "count": { + "description": "Same as above except intended to represent other counts (for e.g. for segmentation this is pixel count). NOTE(params): Only example_count or count is set (oneoff does not support repeated fields unless they are embedded inside another message).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "exampleCount": { + "description": "Value of the specific cell in the confusion matrix. The number of values each row has (i.e. the length of the row) is equal to the length of the annotation_spec_id_token field.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSCoreMlFormat": { + "description": "A model format used for iOS mobile devices.", + "id": "XPSCoreMlFormat", + "properties": {}, + "type": "object" + }, + "XPSCorrelationStats": { + "description": "A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same.", + "id": "XPSCorrelationStats", + "properties": { + "cramersV": { + "description": "The correlation value using the Cramer's V measure.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSDataErrors": { + "description": "Different types of errors and the stats associatesd with each error.", + "id": "XPSDataErrors", + "properties": { + "count": { + "description": "Number of records having errors associated with the enum.", + "format": "int32", + "type": "integer" + }, + "errorType": { + "description": "Type of the error.", + "enum": [ + "ERROR_TYPE_UNSPECIFIED", + "UNSUPPORTED_AUDIO_FORMAT", + "FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT", + "FILE_TOO_LARGE", + "MISSING_TRANSCRIPTION" + ], + "enumDescriptions": [ + "Not specified.", + "Audio format not in the formats by cloud-speech AutoML. Currently only wav and flac file formats are supported.", + "File format differnt from what is specified in the file name extension.", + "File too large. Maximum allowed size is 50 MB.", + "Transcript is missing." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSDataStats": { + "description": "The data statistics of a series of values that share the same DataType.", + "id": "XPSDataStats", + "properties": { + "arrayStats": { + "$ref": "XPSArrayStats", + "description": "The statistics for ARRAY DataType." + }, + "categoryStats": { + "$ref": "XPSCategoryStats", + "description": "The statistics for CATEGORY DataType." + }, + "distinctValueCount": { + "description": "The number of distinct values.", + "format": "int64", + "type": "string" + }, + "float64Stats": { + "$ref": "XPSFloat64Stats", + "description": "The statistics for FLOAT64 DataType." + }, + "nullValueCount": { + "description": "The number of values that are null.", + "format": "int64", + "type": "string" + }, + "stringStats": { + "$ref": "XPSStringStats", + "description": "The statistics for STRING DataType." + }, + "structStats": { + "$ref": "XPSStructStats", + "description": "The statistics for STRUCT DataType." + }, + "timestampStats": { + "$ref": "XPSTimestampStats", + "description": "The statistics for TIMESTAMP DataType." + }, + "validValueCount": { + "description": "The number of values that are valid.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSDataType": { + "description": "Indicated the type of data that can be stored in a structured data entity (e.g. a table).", + "id": "XPSDataType", + "properties": { + "compatibleDataTypes": { + "description": "The highly compatible data types to this data type.", + "items": { + "$ref": "XPSDataType" + }, + "type": "array" + }, + "listElementType": { + "$ref": "XPSDataType", + "description": "If type_code == ARRAY, then `list_element_type` is the type of the elements." + }, + "nullable": { + "description": "If true, this DataType can also be `null`.", + "type": "boolean" + }, + "structType": { + "$ref": "XPSStructType", + "description": "If type_code == STRUCT, then `struct_type` provides type information for the struct's fields." + }, + "timeFormat": { + "description": "If type_code == TIMESTAMP then `time_format` provides the format in which that time field is expressed. The time_format must be written in `strftime` syntax. If time_format is not set, then the default format as described on the field is used.", + "type": "string" + }, + "typeCode": { + "description": "Required. The TypeCode for this type.", + "enum": [ + "TYPE_CODE_UNSPECIFIED", + "FLOAT64", + "TIMESTAMP", + "STRING", + "ARRAY", + "STRUCT", + "CATEGORY" + ], + "enumDescriptions": [ + "Not specified. Should not be used.", + "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or `\"-Infinity\"`.", + "Must be between 0AD and 9999AD. Encoded as `string` according to time_format, or, if that format is not set, then in RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z).", + "Encoded as `string`.", + "Encoded as `list`, where the list elements are represented according to list_element_type.", + "Encoded as `struct`, where field values are represented according to struct_type.", + "Values of this type are not further understood by AutoML, e.g. AutoML is unable to tell the order of values (as it could with FLOAT64), or is unable to say if one value contains another (as it could with STRING). Encoded as `string` (bytes should be base64-encoded, as described in RFC 4648, section 4)." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSDockerFormat": { + "description": "A model format used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system.", + "id": "XPSDockerFormat", + "properties": { + "cpuArchitecture": { + "description": "Optional. Additional cpu information describing the requirements for the to be exported model files.", + "enum": [ + "CPU_ARCHITECTURE_UNSPECIFIED", + "CPU_ARCHITECTURE_X86_64" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "gpuArchitecture": { + "description": "Optional. Additional gpu information describing the requirements for the to be exported model files.", + "enum": [ + "GPU_ARCHITECTURE_UNSPECIFIED", + "GPU_ARCHITECTURE_NVIDIA" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSEdgeTpuTfLiteFormat": { + "description": "A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.", + "id": "XPSEdgeTpuTfLiteFormat", + "properties": {}, + "type": "object" + }, + "XPSEvaluationMetrics": { + "description": "Contains xPS-specific model evaluation metrics either for a single annotation spec (label), or for the model overall. Next tag: 18.", + "id": "XPSEvaluationMetrics", + "properties": { + "annotationSpecIdToken": { + "description": "The annotation_spec for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The value comes from the input annotations in AnnotatedExample. For MVP product or for text sentiment models where annotation_spec_id_token is not available, set label instead.", + "type": "string" + }, + "category": { + "description": "The integer category label for which this evaluation metric instance had been created. Valid categories are 0 or higher. Overall model evaluation should set this to negative values (rather than implicit zero). Only used for Image Segmentation (prefer to set annotation_spec_id_token instead). Note: uCAIP Image Segmentation should use annotation_spec_id_token.", + "format": "int32", + "type": "integer" + }, + "evaluatedExampleCount": { + "description": "The number of examples used to create this evaluation metrics instance.", + "format": "int32", + "type": "integer" + }, + "imageClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "imageObjectDetectionEvalMetrics": { + "$ref": "XPSImageObjectDetectionEvaluationMetrics" + }, + "imageSegmentationEvalMetrics": { + "$ref": "XPSImageSegmentationEvaluationMetrics" + }, + "label": { + "description": "The label for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The label maps to AnnotationSpec.display_name in Public API protos. Only used by MVP implementation and text sentiment FULL implementation.", + "type": "string" + }, + "regressionEvalMetrics": { + "$ref": "XPSRegressionEvaluationMetrics" + }, + "tablesClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "tablesEvalMetrics": { + "$ref": "XPSTablesEvaluationMetrics" + }, + "textClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "textExtractionEvalMetrics": { + "$ref": "XPSTextExtractionEvaluationMetrics" + }, + "textSentimentEvalMetrics": { + "$ref": "XPSTextSentimentEvaluationMetrics" + }, + "translationEvalMetrics": { + "$ref": "XPSTranslationEvaluationMetrics" + }, + "videoActionRecognitionEvalMetrics": { + "$ref": "XPSVideoActionRecognitionEvaluationMetrics" + }, + "videoClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "videoObjectTrackingEvalMetrics": { + "$ref": "XPSVideoObjectTrackingEvaluationMetrics" + } + }, + "type": "object" + }, + "XPSEvaluationMetricsSet": { + "description": "Specifies location of model evaluation metrics.", + "id": "XPSEvaluationMetricsSet", + "properties": { + "evaluationMetrics": { + "description": "Inline EvaluationMetrics - should be relatively small. For passing large quantities of exhaustive metrics, use file_spec.", + "items": { + "$ref": "XPSEvaluationMetrics" + }, + "type": "array" + }, + "fileSpec": { + "$ref": "XPSFileSpec", + "description": "File spec containing evaluation metrics of a model, must point to RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics messages." + }, + "numEvaluationMetrics": { + "description": "Number of the evaluation metrics (usually one per label plus overall).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSExampleSet": { + "description": "Set of examples or input sources.", + "id": "XPSExampleSet", + "properties": { + "fileSpec": { + "$ref": "XPSFileSpec", + "description": "File spec of the examples or input sources." + }, + "fingerprint": { + "description": "Fingerprint of the example set.", + "format": "int64", + "type": "string" + }, + "numExamples": { + "description": "Number of examples.", + "format": "int64", + "type": "string" + }, + "numInputSources": { + "description": "Number of input sources.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSExportModelOutputConfig": { + "id": "XPSExportModelOutputConfig", + "properties": { + "coreMlFormat": { + "$ref": "XPSCoreMlFormat" + }, + "dockerFormat": { + "$ref": "XPSDockerFormat" + }, + "edgeTpuTfLiteFormat": { + "$ref": "XPSEdgeTpuTfLiteFormat" + }, + "exportFirebaseAuxiliaryInfo": { + "description": "For any model and format: If true, will additionally export FirebaseExportedModelInfo in a firebase.txt file.", + "type": "boolean" + }, + "outputGcrUri": { + "description": "The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", + "type": "string" + }, + "outputGcsUri": { + "description": "The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory", + "type": "string" + }, + "tfJsFormat": { + "$ref": "XPSTfJsFormat" + }, + "tfLiteFormat": { + "$ref": "XPSTfLiteFormat" + }, + "tfSavedModelFormat": { + "$ref": "XPSTfSavedModelFormat" + } + }, + "type": "object" + }, + "XPSFileSpec": { + "description": "Spec of input and output files, on external file systems (CNS, GCS, etc).", + "id": "XPSFileSpec", + "properties": { + "directoryPath": { + "deprecated": true, + "description": "Deprecated. Use file_spec.", + "type": "string" + }, + "fileFormat": { + "enum": [ + "FILE_FORMAT_UNKNOWN", + "FILE_FORMAT_SSTABLE", + "FILE_FORMAT_TRANSLATION_RKV", + "FILE_FORMAT_RECORDIO", + "FILE_FORMAT_RAW_CSV", + "FILE_FORMAT_RAW_CAPACITOR" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "", + "", + "Internal format for parallel text data used by Google Translate. go/rkvtools", + "", + "Only the lexicographically first file described by the file_spec contains the header line.", + "" + ], + "type": "string" + }, + "fileSpec": { + "description": "Single file path, or file pattern of format \"/path/to/file@shard_count\". E.g. /cns/cell-d/somewhere/file@2 is expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and /cns/cell-d/somewhere/file-00001-of-00002.", + "type": "string" + }, + "singleFilePath": { + "deprecated": true, + "description": "Deprecated. Use file_spec.", + "type": "string" + } + }, + "type": "object" + }, + "XPSFloat64Stats": { + "description": "The data statistics of a series of FLOAT64 values.", + "id": "XPSFloat64Stats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "histogramBuckets": { + "description": "Histogram buckets of the data series. Sorted by the min value of the bucket, ascendingly, and the number of the buckets is dynamically generated. The buckets are non-overlapping and completely cover whole FLOAT64 range with min of first bucket being `\"-Infinity\"`, and max of the last one being `\"Infinity\"`.", + "items": { + "$ref": "XPSFloat64StatsHistogramBucket" + }, + "type": "array" + }, + "mean": { + "description": "The mean of the series.", + "format": "double", + "type": "number" + }, + "quantiles": { + "description": "Ordered from 0 to k k-quantile values of the data series of n values. The value at index i is, approximately, the i*n/k-th smallest value in the series; for i = 0 and i = k these are, respectively, the min and max values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "standardDeviation": { + "description": "The standard deviation of the series.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSFloat64StatsHistogramBucket": { + "description": "A bucket of a histogram.", + "id": "XPSFloat64StatsHistogramBucket", + "properties": { + "count": { + "description": "The number of data values that are in the bucket, i.e. are between min and max values.", + "format": "int64", + "type": "string" + }, + "max": { + "description": "The maximum value of the bucket, exclusive unless max = `\"Infinity\"`, in which case it's inclusive.", + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum value of the bucket, inclusive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSImageClassificationTrainResponse": { + "id": "XPSImageClassificationTrainResponse", + "properties": { + "classCount": { + "description": "Total number of classes.", + "format": "int64", + "type": "string" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec", + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Populated for AutoMl requests." + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostInNodeTime": { + "description": "The actual cost to create this model. - For edge type model, the cost is expressed in node hour. - For cloud type model,the cost is expressed in compute hour. - Populated for models created before GA. To be deprecated after GA.", + "format": "google-duration", + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual training cost, expressed in node seconds. Populated for models trained in node time.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageExportModelSpec": { + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.", + "id": "XPSImageExportModelSpec", + "properties": { + "exportModelOutputConfig": { + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "items": { + "$ref": "XPSExportModelOutputConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSImageModelArtifactSpec": { + "description": "Stores the locations and related metadata of the model artifacts. Populated for uCAIP requests only.", + "id": "XPSImageModelArtifactSpec", + "properties": { + "checkpointArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The Tensorflow checkpoint files. e.g. Used for resumable training." + }, + "exportArtifact": { + "description": "The model binary files in different formats for model export.", + "items": { + "$ref": "XPSModelArtifactItem" + }, + "type": "array" + }, + "labelGcsUri": { + "description": "GCS uri of decoded labels file for model export 'dict.txt'.", + "type": "string" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API." + }, + "tfJsBinaryGcsPrefix": { + "description": "GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated.", + "type": "string" + }, + "tfLiteMetadataGcsUri": { + "description": "GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'.", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageModelServingSpec": { + "description": "Serving specification for image models.", + "id": "XPSImageModelServingSpec", + "properties": { + "modelThroughputEstimation": { + "description": "Populate under uCAIP request scope.", + "items": { + "$ref": "XPSImageModelServingSpecModelThroughputEstimation" + }, + "type": "array" + }, + "nodeQps": { + "description": "An estimated value of how much traffic a node can serve. Populated for AutoMl request only.", + "format": "double", + "type": "number" + }, + "tfRuntimeVersion": { + "description": "## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageModelServingSpecModelThroughputEstimation": { + "id": "XPSImageModelServingSpecModelThroughputEstimation", + "properties": { + "computeEngineAcceleratorType": { + "enum": [ + "UNSPECIFIED", + "NVIDIA_TESLA_K80", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_V100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_A100", + "NVIDIA_A100_80GB", + "NVIDIA_L4", + "NVIDIA_H100_80GB", + "TPU_V2", + "TPU_V3", + "TPU_V4_POD", + "TPU_V5_LITEPOD" + ], + "enumDescriptions": [ + "", + "Nvidia Tesla K80 GPU.", + "Nvidia Tesla P100 GPU.", + "Nvidia Tesla V100 GPU.", + "Nvidia Tesla P4 GPU.", + "Nvidia Tesla T4 GPU.", + "Nvidia Tesla A100 GPU.", + "Nvidia A100 80GB GPU.", + "Nvidia L4 GPU.", + "Nvidia H100 80Gb GPU.", + "TPU v2 (JellyFish).", + "TPU v3 (DragonFish).", + "TPU_v4 (PufferFish).", + "TPU v5 Lite Pods." + ], + "type": "string" + }, + "latencyInMilliseconds": { + "description": "Estimated latency.", + "format": "double", + "type": "number" + }, + "nodeQps": { + "description": "The approximate qps a deployed node can serve.", + "format": "double", + "type": "number" + }, + "servomaticPartitionType": { + "enum": [ + "PARTITION_TYPE_UNSPECIFIED", + "PARTITION_ZERO", + "PARTITION_REDUCED_HOMING", + "PARTITION_JELLYFISH", + "PARTITION_CPU", + "PARTITION_CUSTOM_STORAGE_CPU" + ], + "enumDescriptions": [ + "", + "The default partition.", + "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", + "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "The partition used by regionalized servomatic cloud regions.", + "The partition used for loading models from custom storage." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSImageObjectDetectionEvaluationMetrics": { + "description": "Model evaluation metrics for image object detection problems. Evaluates prediction quality of labeled bounding boxes.", + "id": "XPSImageObjectDetectionEvaluationMetrics", + "properties": { + "boundingBoxMeanAveragePrecision": { + "description": "The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries.", + "format": "float", + "type": "number" + }, + "boundingBoxMetricsEntries": { + "description": "The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntry" + }, + "type": "array" + }, + "evaluatedBoundingBoxCount": { + "description": "The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSImageObjectDetectionModelSpec": { + "id": "XPSImageObjectDetectionModelSpec", + "properties": { + "classCount": { + "description": "Total number of classes.", + "format": "int64", + "type": "string" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec" + }, + "maxBoundingBoxCount": { + "description": "Max number of bounding box.", + "format": "int64", + "type": "string" + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageSegmentationEvaluationMetrics": { + "description": "Model evaluation metrics for image segmentation problems. Next tag: 4.", + "id": "XPSImageSegmentationEvaluationMetrics", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from it.", + "items": { + "$ref": "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the per confidence_threshold evaluation. Pixel counts are set here. Only set for model level evaluation, not for evaluation per label." + }, + "diceScoreCoefficient": { + "description": "DSC or the F1 score: The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "iouScore": { + "description": "IOU score.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSImageSegmentationTrainResponse": { + "id": "XPSImageSegmentationTrainResponse", + "properties": { + "colorMaps": { + "description": "Color map of the model.", + "items": { + "$ref": "XPSColorMap" + }, + "type": "array" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec", + "description": "NOTE: These fields are not used/needed in EAP but will be set later." + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope. Model artifact spec stores and model gcs pathes and related metadata" + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSIntegratedGradientsAttribution": { + "deprecated": true, + "description": "An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365", + "id": "XPSIntegratedGradientsAttribution", + "properties": { + "stepCount": { + "description": "The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSMetricEntry": { + "id": "XPSMetricEntry", + "properties": { + "argentumMetricId": { + "description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", + "type": "string" + }, + "doubleValue": { + "description": "A double value.", + "format": "double", + "type": "number" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "systemLabels": { + "description": "Billing system labels for this (metric, value) pair.", + "items": { + "$ref": "XPSMetricEntryLabel" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSMetricEntryLabel": { + "id": "XPSMetricEntryLabel", + "properties": { + "labelName": { + "description": "The name of the label.", + "type": "string" + }, + "labelValue": { + "description": "The value of the label.", + "type": "string" + } + }, + "type": "object" + }, + "XPSModelArtifactItem": { + "description": "A single model artifact item.", + "id": "XPSModelArtifactItem", + "properties": { + "artifactFormat": { + "description": "The model artifact format.", + "enum": [ + "ARTIFACT_FORMAT_UNSPECIFIED", + "TF_CHECKPOINT", + "TF_SAVED_MODEL", + "TF_LITE", + "EDGE_TPU_TF_LITE", + "TF_JS", + "CORE_ML" + ], + "enumDescriptions": [ + "Should not be used.", + "The Tensorflow checkpoints. See https://www.tensorflow.org/guide/checkpoint.", + "The Tensorflow SavedModel binary.", + "Model artifact in generic TensorFlow Lite (.tflite) format. See https://www.tensorflow.org/lite.", + "Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.", + "A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.", + "Used for iOS mobile devices in (.mlmodel) format. See https://developer.apple.com/documentation/coreml" + ], + "type": "string" + }, + "gcsUri": { + "description": "The Google Cloud Storage (GCS) uri that stores the model binary files.", + "type": "string" + } + }, + "type": "object" + }, + "XPSPreprocessResponse": { + "description": "Next ID: 8", + "id": "XPSPreprocessResponse", + "properties": { + "outputExampleSet": { + "$ref": "XPSExampleSet", + "description": "Preprocessed examples, that are to be imported into AutoML storage. This should point to RecordIO file(s) of PreprocessedExample messages. The PreprocessedExample.mvp_training_data-s returned here are later verbatim passed to Train() call in TrainExample.mvp_training_data." + }, + "speechPreprocessResp": { + "$ref": "XPSSpeechPreprocessResponse" + }, + "tablesPreprocessResponse": { + "$ref": "XPSTablesPreprocessResponse" + }, + "translationPreprocessResp": { + "$ref": "XPSTranslationPreprocessResponse" + } + }, + "type": "object" + }, + "XPSRegressionEvaluationMetrics": { + "description": "Model evaluation metrics for regression problems. It can be used for Tables.", + "id": "XPSRegressionEvaluationMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean Absolute Error (MAE).", + "format": "float", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error. Only set if all ground truth values are positive.", + "format": "float", + "type": "number" + }, + "rSquared": { + "description": "R squared.", + "format": "float", + "type": "number" + }, + "regressionMetricsEntries": { + "description": "A list of actual versus predicted points for the model being evaluated.", + "items": { + "$ref": "XPSRegressionMetricsEntry" + }, + "type": "array" + }, + "rootMeanSquaredError": { + "description": "Root Mean Squared Error (RMSE).", + "format": "float", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSRegressionMetricsEntry": { + "description": "A pair of actual & observed values for the model being evaluated.", + "id": "XPSRegressionMetricsEntry", + "properties": { + "predictedValue": { + "description": "The observed value for a row in the dataset.", + "format": "float", + "type": "number" + }, + "trueValue": { + "description": "The actual target value for a row in the dataset.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSReportingMetrics": { + "id": "XPSReportingMetrics", + "properties": { + "effectiveTrainingDuration": { + "deprecated": true, + "description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", + "format": "google-duration", + "type": "string" + }, + "metricEntries": { + "description": "One entry per metric name. The values must be aggregated per metric name.", + "items": { + "$ref": "XPSMetricEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadata": { + "deprecated": true, + "id": "XPSResponseExplanationMetadata", + "properties": { + "inputs": { + "additionalProperties": { + "$ref": "XPSResponseExplanationMetadataInputMetadata" + }, + "description": "Metadata of the input.", + "type": "object" + }, + "outputs": { + "additionalProperties": { + "$ref": "XPSResponseExplanationMetadataOutputMetadata" + }, + "description": "Metadata of the output.", + "type": "object" + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadataInputMetadata": { + "description": "Metadata of the input of a feature.", + "id": "XPSResponseExplanationMetadataInputMetadata", + "properties": { + "inputTensorName": { + "description": "Name of the input tensor for this model. Only needed in train response.", + "type": "string" + }, + "modality": { + "description": "Modality of the feature. Valid values are: numeric, image. Defaults to numeric.", + "enum": [ + "MODALITY_UNSPECIFIED", + "NUMERIC", + "IMAGE", + "CATEGORICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "visualizationConfig": { + "$ref": "XPSVisualization", + "description": "Visualization configurations for image explanation." + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadataOutputMetadata": { + "description": "Metadata of the prediction output to be explained.", + "id": "XPSResponseExplanationMetadataOutputMetadata", + "properties": { + "outputTensorName": { + "description": "Name of the output tensor. Only needed in train response.", + "type": "string" + } + }, + "type": "object" + }, + "XPSResponseExplanationParameters": { + "deprecated": true, + "id": "XPSResponseExplanationParameters", + "properties": { + "integratedGradientsAttribution": { + "$ref": "XPSIntegratedGradientsAttribution", + "description": "An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365" + }, + "xraiAttribution": { + "$ref": "XPSXraiAttribution", + "description": "An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead." + } + }, + "type": "object" + }, + "XPSResponseExplanationSpec": { + "deprecated": true, + "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context.", + "id": "XPSResponseExplanationSpec", + "properties": { + "explanationType": { + "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", + "type": "string" + }, + "metadata": { + "$ref": "XPSResponseExplanationMetadata", + "description": "Metadata describing the Model's input and output for explanation." + }, + "parameters": { + "$ref": "XPSResponseExplanationParameters", + "description": "Parameters that configure explaining of the Model's predictions." + } + }, + "type": "object" + }, + "XPSRow": { + "id": "XPSRow", + "properties": { + "columnIds": { + "description": "The ids of the columns. Note: The below `values` field must match order of this field, if this field is set.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "values": { + "description": "The values of the row cells, given in the same order as the column_ids. If column_ids is not set, then in the same order as the input_feature_column_ids in TablesModelMetadata.", + "items": { + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechEvaluationMetrics": { + "id": "XPSSpeechEvaluationMetrics", + "properties": { + "subModelEvaluationMetrics": { + "description": "Evaluation metrics for all submodels contained in this model.", + "items": { + "$ref": "XPSSpeechEvaluationMetricsSubModelEvaluationMetric" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechEvaluationMetricsSubModelEvaluationMetric": { + "id": "XPSSpeechEvaluationMetricsSubModelEvaluationMetric", + "properties": { + "biasingModelType": { + "description": "Type of the biasing model.", + "enum": [ + "BIASING_MODEL_TYPE_UNSPECIFIED", + "COMMAND_AND_SEARCH", + "PHONE_CALL", + "VIDEO", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "Build biasing model on top of COMMAND_AND_SEARCH model", + "Build biasing model on top of PHONE_CALL model", + "Build biasing model on top of VIDEO model", + "Build biasing model on top of DEFAULT model" + ], + "type": "string" + }, + "isEnhancedModel": { + "description": "If true then it means we have an enhanced version of the biasing models.", + "type": "boolean" + }, + "numDeletions": { + "format": "int32", + "type": "integer" + }, + "numInsertions": { + "format": "int32", + "type": "integer" + }, + "numSubstitutions": { + "format": "int32", + "type": "integer" + }, + "numUtterances": { + "description": "Number of utterances used in the wer computation.", + "format": "int32", + "type": "integer" + }, + "numWords": { + "description": "Number of words over which the word error rate was computed.", + "format": "int32", + "type": "integer" + }, + "sentenceAccuracy": { + "description": "Below fields are used for debugging purposes", + "format": "double", + "type": "number" + }, + "wer": { + "description": "Word error rate (standard error metric used for speech recognition).", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSSpeechModelSpec": { + "id": "XPSSpeechModelSpec", + "properties": { + "datasetId": { + "description": "Required for speech xps backend. Speech xps has to use dataset_id and model_id as the primary key in db so that speech API can query the db directly.", + "format": "int64", + "type": "string" + }, + "language": { + "type": "string" + }, + "subModelSpecs": { + "description": "Model specs for all submodels contained in this model.", + "items": { + "$ref": "XPSSpeechModelSpecSubModelSpec" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechModelSpecSubModelSpec": { + "id": "XPSSpeechModelSpecSubModelSpec", + "properties": { + "biasingModelType": { + "description": "Type of the biasing model.", + "enum": [ + "BIASING_MODEL_TYPE_UNSPECIFIED", + "COMMAND_AND_SEARCH", + "PHONE_CALL", + "VIDEO", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "Build biasing model on top of COMMAND_AND_SEARCH model", + "Build biasing model on top of PHONE_CALL model", + "Build biasing model on top of VIDEO model", + "Build biasing model on top of DEFAULT model" + ], + "type": "string" + }, + "clientId": { + "description": "In S3, Recognition ClientContextId.client_id", + "type": "string" + }, + "contextId": { + "description": "In S3, Recognition ClientContextId.context_id", + "type": "string" + }, + "isEnhancedModel": { + "description": "If true then it means we have an enhanced version of the biasing models.", + "type": "boolean" + } + }, + "type": "object" + }, + "XPSSpeechPreprocessResponse": { + "id": "XPSSpeechPreprocessResponse", + "properties": { + "cnsTestDataPath": { + "description": "Location od shards of sstables (test data) of DataUtterance protos.", + "type": "string" + }, + "cnsTrainDataPath": { + "description": "Location of shards of sstables (training data) of DataUtterance protos.", + "type": "string" + }, + "prebuiltModelEvaluationMetrics": { + "$ref": "XPSSpeechEvaluationMetrics", + "description": "The metrics for prebuilt speech models. They are included here because there is no prebuilt speech models stored in the AutoML." + }, + "speechPreprocessStats": { + "$ref": "XPSSpeechPreprocessStats", + "description": "Stats associated with the data." + } + }, + "type": "object" + }, + "XPSSpeechPreprocessStats": { + "id": "XPSSpeechPreprocessStats", + "properties": { + "dataErrors": { + "description": "Different types of data errors and the counts associated with them.", + "items": { + "$ref": "XPSDataErrors" + }, + "type": "array" + }, + "numHumanLabeledExamples": { + "description": "The number of rows marked HUMAN_LABELLED", + "format": "int32", + "type": "integer" + }, + "numLogsExamples": { + "description": "The number of samples found in the previously recorded logs data.", + "format": "int32", + "type": "integer" + }, + "numMachineTranscribedExamples": { + "description": "The number of rows marked as MACHINE_TRANSCRIBED", + "format": "int32", + "type": "integer" + }, + "testExamplesCount": { + "description": "The number of examples labelled as TEST by Speech xps server.", + "format": "int32", + "type": "integer" + }, + "testSentencesCount": { + "description": "The number of sentences in the test data set.", + "format": "int32", + "type": "integer" + }, + "testWordsCount": { + "description": "The number of words in the test data set.", + "format": "int32", + "type": "integer" + }, + "trainExamplesCount": { + "description": "The number of examples labeled as TRAIN by Speech xps server.", + "format": "int32", + "type": "integer" + }, + "trainSentencesCount": { + "description": "The number of sentences in the training data set.", + "format": "int32", + "type": "integer" + }, + "trainWordsCount": { + "description": "The number of words in the training data set.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSStringStats": { + "description": "The data statistics of a series of STRING values.", + "id": "XPSStringStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "topUnigramStats": { + "description": "The statistics of the top 20 unigrams, ordered by StringStats.UnigramStats.count.", + "items": { + "$ref": "XPSStringStatsUnigramStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSStringStatsUnigramStats": { + "description": "The statistics of a unigram.", + "id": "XPSStringStatsUnigramStats", + "properties": { + "count": { + "description": "The number of occurrences of this unigram in the series.", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The unigram.", + "type": "string" + } + }, + "type": "object" + }, + "XPSStructStats": { + "description": "The data statistics of a series of STRUCT values.", + "id": "XPSStructStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "fieldStats": { + "additionalProperties": { + "$ref": "XPSDataStats" + }, + "description": "Map from a field name of the struct to data stats aggregated over series of all data in that field across all the structs.", + "type": "object" + } + }, + "type": "object" + }, + "XPSStructType": { + "description": "`StructType` defines the DataType-s of a STRUCT type.", + "id": "XPSStructType", + "properties": { + "fields": { + "additionalProperties": { + "$ref": "XPSDataType" + }, + "description": "Unordered map of struct field names to their data types.", + "type": "object" + } + }, + "type": "object" + }, + "XPSTableSpec": { + "id": "XPSTableSpec", + "properties": { + "columnSpecs": { + "additionalProperties": { + "$ref": "XPSColumnSpec" + }, + "description": "Mapping from column id to column spec.", + "type": "object" + }, + "importedDataSizeInBytes": { + "description": "The total size of imported data of the table.", + "format": "int64", + "type": "string" + }, + "rowCount": { + "description": "The number of rows in the table.", + "format": "int64", + "type": "string" + }, + "timeColumnId": { + "description": "The id of the time column.", + "format": "int32", + "type": "integer" + }, + "validRowCount": { + "description": "The number of valid rows.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesClassificationMetrics": { + "description": "Metrics for Tables classification problems.", + "id": "XPSTablesClassificationMetrics", + "properties": { + "curveMetrics": { + "description": "Metrics building a curve.", + "items": { + "$ref": "XPSTablesClassificationMetricsCurveMetrics" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesClassificationMetricsCurveMetrics": { + "description": "Metrics curve data point for a single value.", + "id": "XPSTablesClassificationMetricsCurveMetrics", + "properties": { + "aucPr": { + "description": "The area under the precision-recall curve.", + "format": "double", + "type": "number" + }, + "aucRoc": { + "description": "The area under receiver operating characteristic curve.", + "format": "double", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve and ROC curve can be derived from them.", + "items": { + "$ref": "XPSTablesConfidenceMetricsEntry" + }, + "type": "array" + }, + "logLoss": { + "description": "The Log loss metric.", + "format": "double", + "type": "number" + }, + "positionThreshold": { + "description": "The position threshold value used to compute the metrics.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The CATEGORY row value (for ARRAY unnested) the curve metrics are for.", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSTablesConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "double", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision. (2 * precision * recall) / (precision + recall)", + "format": "double", + "type": "number" + }, + "falseNegativeCount": { + "description": "False negative count.", + "format": "int64", + "type": "string" + }, + "falsePositiveCount": { + "description": "False positive count.", + "format": "int64", + "type": "string" + }, + "falsePositiveRate": { + "description": "FPR = #false positives / (#false positives + #true negatives)", + "format": "double", + "type": "number" + }, + "precision": { + "description": "Precision = #true positives / (#true positives + #false positives).", + "format": "double", + "type": "number" + }, + "recall": { + "description": "Recall = #true positives / (#true positives + #false negatives).", + "format": "double", + "type": "number" + }, + "trueNegativeCount": { + "description": "True negative count.", + "format": "int64", + "type": "string" + }, + "truePositiveCount": { + "description": "True positive count.", + "format": "int64", + "type": "string" + }, + "truePositiveRate": { + "description": "TPR = #true positives / (#true positives + #false negatvies)", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesDatasetMetadata": { + "description": "Metadata for a dataset used for AutoML Tables. Next ID: 6", + "id": "XPSTablesDatasetMetadata", + "properties": { + "mlUseColumnId": { + "description": "Id the column to split the table.", + "format": "int32", + "type": "integer" + }, + "primaryTableSpec": { + "$ref": "XPSTableSpec", + "description": "Primary table." + }, + "targetColumnCorrelations": { + "additionalProperties": { + "$ref": "XPSCorrelationStats" + }, + "description": "(the column id : its CorrelationStats with target column).", + "type": "object" + }, + "targetColumnId": { + "description": "Id of the primary table column that should be used as the training label.", + "format": "int32", + "type": "integer" + }, + "weightColumnId": { + "description": "Id of the primary table column that should be used as the weight column.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSTablesEvaluationMetrics": { + "id": "XPSTablesEvaluationMetrics", + "properties": { + "classificationMetrics": { + "$ref": "XPSTablesClassificationMetrics", + "description": "Classification metrics." + }, + "regressionMetrics": { + "$ref": "XPSTablesRegressionMetrics", + "description": "Regression metrics." + } + }, + "type": "object" + }, + "XPSTablesModelColumnInfo": { + "description": "An information specific to given column and Tables Model, in context of the Model and the predictions created by it.", + "id": "XPSTablesModelColumnInfo", + "properties": { + "columnId": { + "description": "The ID of the column.", + "format": "int32", + "type": "integer" + }, + "featureImportance": { + "description": "When given as part of a Model: Measurement of how much model predictions correctness on the TEST data depend on values in this column. A value between 0 and 1, higher means higher influence. These values are normalized - for all input feature columns of a given model they add to 1. When given back by Predict or Batch Predict: Measurement of how impactful for the prediction returned for the given row the value in this column was. Specifically, the feature importance specifies the marginal contribution that the feature made to the prediction score compared to the baseline score. These values are computed using the Sampled Shapley method.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesModelStructure": { + "description": "A description of Tables model structure.", + "id": "XPSTablesModelStructure", + "properties": { + "modelParameters": { + "description": "A list of models.", + "items": { + "$ref": "XPSTablesModelStructureModelParameters" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesModelStructureModelParameters": { + "description": "Model hyper-parameters for a model.", + "id": "XPSTablesModelStructureModelParameters", + "properties": { + "hyperparameters": { + "items": { + "$ref": "XPSTablesModelStructureModelParametersParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesModelStructureModelParametersParameter": { + "id": "XPSTablesModelStructureModelParametersParameter", + "properties": { + "floatValue": { + "description": "Float type parameter value.", + "format": "double", + "type": "number" + }, + "intValue": { + "description": "Integer type parameter value.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Parameter name.", + "type": "string" + }, + "stringValue": { + "description": "String type parameter value.", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesPreprocessResponse": { + "id": "XPSTablesPreprocessResponse", + "properties": { + "tablesDatasetMetadata": { + "$ref": "XPSTablesDatasetMetadata", + "description": "The table/column id, column_name and the DataTypes of the columns will be populated." + } + }, + "type": "object" + }, + "XPSTablesRegressionMetrics": { + "description": "Metrics for Tables regression problems.", + "id": "XPSTablesRegressionMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean absolute error.", + "format": "double", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error, only set if all of the target column's values are positive.", + "format": "double", + "type": "number" + }, + "rSquared": { + "description": "R squared.", + "format": "double", + "type": "number" + }, + "regressionMetricsEntries": { + "description": "A list of actual versus predicted points for the model being evaluated.", + "items": { + "$ref": "XPSRegressionMetricsEntry" + }, + "type": "array" + }, + "rootMeanSquaredError": { + "description": "Root mean squared error.", + "format": "double", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesTrainResponse": { + "id": "XPSTablesTrainResponse", + "properties": { + "modelStructure": { + "$ref": "XPSTablesModelStructure" + }, + "predictionSampleRows": { + "description": "Sample rows from the dataset this model was trained.", + "items": { + "$ref": "XPSRow" + }, + "type": "array" + }, + "tablesModelColumnInfo": { + "description": "Output only. Auxiliary information for each of the input_feature_column_specs, with respect to this particular model.", + "items": { + "$ref": "XPSTablesModelColumnInfo" + }, + "type": "array" + }, + "trainCostMilliNodeHours": { + "description": "The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesTrainingOperationMetadata": { + "id": "XPSTablesTrainingOperationMetadata", + "properties": { + "createModelStage": { + "description": "Current stage of creating model.", + "enum": [ + "CREATE_MODEL_STAGE_UNSPECIFIED", + "DATA_PREPROCESSING", + "TRAINING", + "EVALUATING", + "MODEL_POST_PROCESSING" + ], + "enumDescriptions": [ + "Unspecified stage.", + "Prepare the model training pipeline and run data processing.", + "Training model.", + "Run evaluation.", + "Finalizing model training pipeline." + ], + "type": "string" + }, + "optimizationObjective": { + "description": "The optimization objective for model.", + "type": "string" + }, + "topTrials": { + "description": "This field is for training. When the operation is terminated successfully, AutoML Backend post this field to operation metadata in spanner. If the metadata has no trials returned, the training operation is supposed to be a failure.", + "items": { + "$ref": "XPSTuningTrial" + }, + "type": "array" + }, + "trainBudgetMilliNodeHours": { + "description": "Creating model budget.", + "format": "int64", + "type": "string" + }, + "trainingObjectivePoints": { + "description": "This field records the training objective value with respect to time, giving insight into how the model architecture search is performing as training time elapses.", + "items": { + "$ref": "XPSTrainingObjectivePoint" + }, + "type": "array" + }, + "trainingStartTime": { + "description": "Timestamp when training process starts.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "XPSTextComponentModel": { + "description": "Component model. Next ID: 10", + "id": "XPSTextComponentModel", + "properties": { + "batchPredictionModelGcsUri": { + "description": "The Cloud Storage resource path to hold batch prediction model.", + "type": "string" + }, + "onlinePredictionModelGcsUri": { + "description": "The Cloud Storage resource path to hold online prediction model.", + "type": "string" + }, + "partition": { + "description": "The partition where the model is deployed. Populated by uCAIP BE as part of online PredictRequest.", + "enum": [ + "PARTITION_TYPE_UNSPECIFIED", + "PARTITION_ZERO", + "PARTITION_REDUCED_HOMING", + "PARTITION_JELLYFISH", + "PARTITION_CPU", + "PARTITION_CUSTOM_STORAGE_CPU" + ], + "enumDescriptions": [ + "", + "The default partition.", + "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", + "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "The partition used by regionalized servomatic cloud regions.", + "The partition used for loading models from custom storage." + ], + "type": "string" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud Ai Platform API." + }, + "servoModelName": { + "description": "The name of servo model. Populated by uCAIP BE as part of online PredictRequest.", + "type": "string" + }, + "submodelName": { + "description": "The name of the trained NL submodel.", + "type": "string" + }, + "submodelType": { + "description": "The type of trained NL submodel", + "enum": [ + "TEXT_MODEL_TYPE_UNSPECIFIED", + "TEXT_MODEL_TYPE_DEFAULT", + "TEXT_MODEL_TYPE_META_ARCHITECT", + "TEXT_MODEL_TYPE_ATC", + "TEXT_MODEL_TYPE_CLARA2", + "TEXT_MODEL_TYPE_CHATBASE", + "TEXT_MODEL_TYPE_SAFT_SPAN_LABELING", + "TEXT_MODEL_TYPE_TEXT_EXTRACTION", + "TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION", + "TEXT_MODEL_TYPE_COMPOSITE", + "TEXT_MODEL_TYPE_ALL_MODELS", + "TEXT_MODEL_TYPE_BERT", + "TEXT_MODEL_TYPE_ENC_PALM" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "Model type for entity extraction.", + "Model type for relationship extraction.", + "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model. Please refer to go/cnl-composite-models for more information.", + "Model type used to train default, MA, and ATC models in a single batch worker pipeline.", + "BERT pipeline needs a specific model type, since it uses a different TFX configuration compared with DEFAULT (despite sharing most of the code).", + "Model type for EncPaLM." + ], + "type": "string" + }, + "tfRuntimeVersion": { + "description": "## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list", + "type": "string" + }, + "versionNumber": { + "description": "The servomatic model version number. Populated by uCAIP BE as part of online PredictRequest.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTextExtractionEvaluationMetrics": { + "id": "XPSTextExtractionEvaluationMetrics", + "properties": { + "bestF1ConfidenceMetrics": { + "$ref": "XPSConfidenceMetricsEntry", + "deprecated": true, + "description": "Values are at the highest F1 score on the precision-recall curve. Only confidence_threshold, recall, precision, and f1_score will be set." + }, + "confidenceMetricsEntries": { + "description": "If the enclosing EvaluationMetrics.label is empty, confidence_metrics_entries is an evaluation of the entire model across all labels. If the enclosing EvaluationMetrics.label is set, confidence_metrics_entries applies to that label.", + "items": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "type": "array" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the model, at the default confidence threshold (0.0). Only set for whole-model evaluation, not for evaluation per label." + }, + "perLabelConfidenceMetrics": { + "additionalProperties": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "deprecated": true, + "description": "Only recall, precision, and f1_score will be set.", + "type": "object" + } + }, + "type": "object" + }, + "XPSTextSentimentEvaluationMetrics": { + "description": "Model evaluation metrics for text sentiment problems.", + "id": "XPSTextSentimentEvaluationMetrics", + "properties": { + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Output only. Confusion matrix of the evaluation. Only set for the overall model evaluation, not for evaluation of a single annotation spec." + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "linearKappa": { + "description": "Output only. Linear weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "meanAbsoluteError": { + "description": "Output only. Mean absolute error. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "meanSquaredError": { + "description": "Output only. Mean squared error. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision.", + "format": "float", + "type": "number" + }, + "quadraticKappa": { + "description": "Output only. Quadratic weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTextToSpeechTrainResponse": { + "description": "TextToSpeech train response", + "id": "XPSTextToSpeechTrainResponse", + "properties": {}, + "type": "object" + }, + "XPSTextTrainResponse": { + "id": "XPSTextTrainResponse", + "properties": { + "componentModel": { + "description": "Component submodels.", + "items": { + "$ref": "XPSTextComponentModel" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTfJsFormat": { + "description": "A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.", + "id": "XPSTfJsFormat", + "properties": {}, + "type": "object" + }, + "XPSTfLiteFormat": { + "description": "LINT.IfChange A model format used for mobile and IoT devices. See https://www.tensorflow.org/lite.", + "id": "XPSTfLiteFormat", + "properties": {}, + "type": "object" + }, + "XPSTfSavedModelFormat": { + "description": "A tensorflow model format in SavedModel format.", + "id": "XPSTfSavedModelFormat", + "properties": {}, + "type": "object" + }, + "XPSTimestampStats": { + "description": "The data statistics of a series of TIMESTAMP values.", + "id": "XPSTimestampStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "granularStats": { + "additionalProperties": { + "$ref": "XPSTimestampStatsGranularStats" + }, + "description": "The string key is the pre-defined granularity. Currently supported: hour_of_day, day_of_week, month_of_year. Granularities finer that the granularity of timestamp data are not populated (e.g. if timestamps are at day granularity, then hour_of_day is not populated).", + "type": "object" + }, + "medianTimestampNanos": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTimestampStatsGranularStats": { + "description": "Stats split by a defined in context granularity.", + "id": "XPSTimestampStatsGranularStats", + "properties": { + "buckets": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "A map from granularity key to example count for that key. E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means May).", + "type": "object" + } + }, + "type": "object" + }, + "XPSTrackMetricsEntry": { + "description": "Track matching model metrics for a single track match threshold and multiple label match confidence thresholds. Next tag: 6.", + "id": "XPSTrackMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Output only. Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them.", + "items": { + "$ref": "XPSTrackMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "iouThreshold": { + "description": "Output only. The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry.", + "format": "float", + "type": "number" + }, + "meanBoundingBoxIou": { + "description": "Output only. The mean bounding box iou over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "meanMismatchRate": { + "description": "Output only. The mean mismatch rate over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "meanTrackingAveragePrecision": { + "description": "Output only. The mean average precision over all confidence thresholds.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTrackMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold. Next tag: 6.", + "id": "XPSTrackMetricsEntryConfidenceMetricsEntry", + "properties": { + "boundingBoxIou": { + "description": "Output only. Bounding box intersection-over-union precision. Measures how well the bounding boxes overlap between each other (e.g. complete overlap or just barely above iou_threshold).", + "format": "float", + "type": "number" + }, + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "mismatchRate": { + "description": "Output only. Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity.", + "format": "float", + "type": "number" + }, + "trackingPrecision": { + "description": "Output only. Tracking precision.", + "format": "float", + "type": "number" + }, + "trackingRecall": { + "description": "Output only. Tracking recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTrainResponse": { + "description": "Next ID: 18", + "id": "XPSTrainResponse", + "properties": { + "deployedModelSizeBytes": { + "description": "Estimated model size in bytes once deployed.", + "format": "int64", + "type": "string" + }, + "errorAnalysisConfigs": { + "description": "Optional vision model error analysis configuration. The field is set when model error analysis is enabled in the training request. The results of error analysis will be binded together with evaluation results (in the format of AnnotatedExample).", + "items": { + "$ref": "XPSVisionErrorAnalysisConfig" + }, + "type": "array" + }, + "evaluatedExampleSet": { + "$ref": "XPSExampleSet", + "description": "Examples used to evaluate the model (usually the test set), with the predicted annotations. The file_spec should point to recordio file(s) of AnnotatedExample. For each returned example, the example_id_token and annotations predicted by the model must be set. The example payload can and is recommended to be omitted." + }, + "evaluationMetricsSet": { + "$ref": "XPSEvaluationMetricsSet", + "description": "The trained model evaluation metrics. This can be optionally returned." + }, + "explanationConfigs": { + "deprecated": true, + "description": "VisionExplanationConfig for XAI on test set. Optional for when XAI is enable in training request.", + "items": { + "$ref": "XPSResponseExplanationSpec" + }, + "type": "array" + }, + "imageClassificationTrainResp": { + "$ref": "XPSImageClassificationTrainResponse" + }, + "imageObjectDetectionTrainResp": { + "$ref": "XPSImageObjectDetectionModelSpec" + }, + "imageSegmentationTrainResp": { + "$ref": "XPSImageSegmentationTrainResponse" + }, + "modelToken": { + "description": "Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model.", + "format": "byte", + "type": "string" + }, + "speechTrainResp": { + "$ref": "XPSSpeechModelSpec" + }, + "tablesTrainResp": { + "$ref": "XPSTablesTrainResponse" + }, + "textToSpeechTrainResp": { + "$ref": "XPSTextToSpeechTrainResponse" + }, + "textTrainResp": { + "$ref": "XPSTextTrainResponse", + "description": "Will only be needed for uCAIP from Beta." + }, + "translationTrainResp": { + "$ref": "XPSTranslationTrainResponse" + }, + "videoActionRecognitionTrainResp": { + "$ref": "XPSVideoActionRecognitionTrainResponse" + }, + "videoClassificationTrainResp": { + "$ref": "XPSVideoClassificationTrainResponse" + }, + "videoObjectTrackingTrainResp": { + "$ref": "XPSVideoObjectTrackingTrainResponse" + } + }, + "type": "object" + }, + "XPSTrainingObjectivePoint": { + "id": "XPSTrainingObjectivePoint", + "properties": { + "createTime": { + "description": "The time at which this point was recorded.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "The objective value when this point was recorded.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTranslationEvaluationMetrics": { + "description": "Evaluation metrics for the dataset.", + "id": "XPSTranslationEvaluationMetrics", + "properties": { + "baseBleuScore": { + "description": "BLEU score for base model.", + "format": "double", + "type": "number" + }, + "bleuScore": { + "description": "BLEU score.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTranslationPreprocessResponse": { + "description": "Translation preprocess response.", + "id": "XPSTranslationPreprocessResponse", + "properties": { + "parsedExampleCount": { + "description": "Total example count parsed.", + "format": "int64", + "type": "string" + }, + "validExampleCount": { + "description": "Total valid example count.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTranslationTrainResponse": { + "description": "Train response for translation.", + "id": "XPSTranslationTrainResponse", + "properties": { + "modelType": { + "description": "Type of the model.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "LEGACY", + "CURRENT" + ], + "enumDescriptions": [ + "Default", + "Legacy model. Will be deprecated.", + "Current model." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSTuningTrial": { + "description": "Metrics for a tuning job generated, will get forwarded to Stackdriver as model tuning logs. Setting this as a standalone message out of CreateModelMetadata to avoid confusion as we expose this message only to users.", + "id": "XPSTuningTrial", + "properties": { + "modelStructure": { + "$ref": "XPSTablesModelStructure", + "description": "Model parameters for the trial." + }, + "trainingObjectivePoint": { + "$ref": "XPSTrainingObjectivePoint", + "description": "The optimization objective evaluation of the eval split data." + } + }, + "type": "object" + }, + "XPSVideoActionMetricsEntry": { + "description": "The Evaluation metrics entry given a specific precision_window_length.", + "id": "XPSVideoActionMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSVideoActionMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + }, + "precisionWindowLength": { + "description": "This VideoActionMetricsEntry is calculated based on this prediction window length. If the predicted action's timestamp is inside the time window whose center is the ground truth action's timestamp with this specific length, the prediction result is treated as a true positive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoActionMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSVideoActionMetricsEntryConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSVideoActionRecognitionEvaluationMetrics": { + "description": "Model evaluation metrics for video action recognition.", + "id": "XPSVideoActionRecognitionEvaluationMetrics", + "properties": { + "evaluatedActionCount": { + "description": "Output only. The number of ground truth actions used to create this evaluation.", + "format": "int32", + "type": "integer" + }, + "videoActionMetricsEntries": { + "description": "Output only. The metric entries for precision window lengths: 1s,2s,3s,4s, 5s.", + "items": { + "$ref": "XPSVideoActionMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoActionRecognitionTrainResponse": { + "id": "XPSVideoActionRecognitionTrainResponse", + "properties": { + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoBatchPredictOperationMetadata": { + "id": "XPSVideoBatchPredictOperationMetadata", + "properties": { + "outputExamples": { + "description": "All the partial batch prediction results that are completed at the moment. Output examples are sorted by completion time. The order will not be changed. Each output example should be the path of a single RecordIO file of AnnotatedExamples.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoClassificationTrainResponse": { + "id": "XPSVideoClassificationTrainResponse", + "properties": { + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoExportModelSpec": { + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.", + "id": "XPSVideoExportModelSpec", + "properties": { + "exportModelOutputConfig": { + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "items": { + "$ref": "XPSExportModelOutputConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoModelArtifactSpec": { + "id": "XPSVideoModelArtifactSpec", + "properties": { + "exportArtifact": { + "description": "The model binary files in different formats for model export.", + "items": { + "$ref": "XPSModelArtifactItem" + }, + "type": "array" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. batch predict) via public Cloud AI Platform API." + } + }, + "type": "object" + }, + "XPSVideoObjectTrackingEvaluationMetrics": { + "description": "Model evaluation metrics for ObjectTracking problems. Next tag: 10.", + "id": "XPSVideoObjectTrackingEvaluationMetrics", + "properties": { + "boundingBoxMeanAveragePrecision": { + "description": "Output only. The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries.", + "format": "float", + "type": "number" + }, + "boundingBoxMetricsEntries": { + "description": "Output only. The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntry" + }, + "type": "array" + }, + "evaluatedBoundingboxCount": { + "description": "The number of bounding boxes used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "evaluatedFrameCount": { + "description": "The number of video frames used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "evaluatedTrackCount": { + "description": "The number of tracks used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "trackMeanAveragePrecision": { + "description": "Output only. The single metric for tracks accuracy evaluation: the mean_average_precision averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMeanBoundingBoxIou": { + "description": "Output only. The single metric for tracks bounding box iou evaluation: the mean_bounding_box_iou averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMeanMismatchRate": { + "description": "Output only. The single metric for tracking consistency evaluation: the mean_mismatch_rate averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMetricsEntries": { + "description": "Output only. The tracks match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSTrackMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoObjectTrackingTrainResponse": { + "id": "XPSVideoObjectTrackingTrainResponse", + "properties": { + "exportModelSpec": { + "$ref": "XPSVideoExportModelSpec", + "description": "Populated for AutoML request only." + }, + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoTrainingOperationMetadata": { + "id": "XPSVideoTrainingOperationMetadata", + "properties": { + "trainCostMilliNodeHour": { + "description": "This is an estimation of the node hours necessary for training a model, expressed in milli node hours (i.e. 1,000 value in this field means 1 node hour). A node hour represents the time a virtual machine spends running your training job. The cost of one node running for one hour is a node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVisionErrorAnalysisConfig": { + "description": "The vision model error analysis configuration. Next tag: 3", + "id": "XPSVisionErrorAnalysisConfig", + "properties": { + "exampleCount": { + "description": "The number of query examples in error analysis.", + "format": "int32", + "type": "integer" + }, + "queryType": { + "description": "The query type used in retrieval. The enum values are frozen in the foreseeable future.", + "enum": [ + "QUERY_TYPE_UNSPECIFIED", + "QUERY_TYPE_ALL_SIMILAR", + "QUERY_TYPE_SAME_CLASS_SIMILAR", + "QUERY_TYPE_SAME_CLASS_DISSIMILAR" + ], + "enumDescriptions": [ + "Unspecified query type for model error analysis.", + "Query similar samples across all classes in the dataset.", + "Query similar samples from the same class of the input sample.", + "Query dissimilar samples from the same class of the input sample." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSVisionTrainingOperationMetadata": { + "deprecated": true, + "id": "XPSVisionTrainingOperationMetadata", + "properties": { + "explanationUsage": { + "$ref": "InfraUsage", + "description": "Aggregated infra usage within certain time period, for billing report purpose if XAI is enable in training request." + } + }, + "type": "object" + }, + "XPSVisualization": { + "deprecated": true, + "description": "Visualization configurations for image explanation.", + "id": "XPSVisualization", + "properties": { + "clipPercentLowerbound": { + "description": "Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.", + "format": "float", + "type": "number" + }, + "clipPercentUpperbound": { + "description": "Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.", + "format": "float", + "type": "number" + }, + "colorMap": { + "description": "The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.", + "enum": [ + "COLOR_MAP_UNSPECIFIED", + "PINK_GREEN", + "VIRIDIS", + "RED", + "GREEN", + "RED_GREEN", + "PINK_WHITE_GREEN" + ], + "enumDescriptions": [ + "Should not be used.", + "Positive: green. Negative: pink.", + "Viridis color map: A perceptually uniform color mapping which is easier to see by those with colorblindness and progresses from yellow to green to blue. Positive: yellow. Negative: blue.", + "Positive: red. Negative: red.", + "Positive: green. Negative: green.", + "Positive: green. Negative: red.", + "PiYG palette." + ], + "type": "string" + }, + "overlayType": { + "description": "How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.", + "enum": [ + "OVERLAY_TYPE_UNSPECIFIED", + "NONE", + "ORIGINAL", + "GRAYSCALE", + "MASK_BLACK" + ], + "enumDescriptions": [ + "Default value. This is the same as NONE.", + "No overlay.", + "The attributions are shown on top of the original image.", + "The attributions are shown on top of grayscaled version of the original image.", + "The attributions are used as a mask to reveal predictive parts of the image and hide the un-predictive parts." + ], + "type": "string" + }, + "polarity": { + "description": "Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.", + "enum": [ + "POLARITY_UNSPECIFIED", + "POSITIVE", + "NEGATIVE", + "BOTH" + ], + "enumDescriptions": [ + "Default value. This is the same as POSITIVE.", + "Highlights the pixels/outlines that were most influential to the model's prediction.", + "Setting polarity to negative highlights areas that does not lead to the models's current prediction.", + "Shows both positive and negative attributions." + ], + "type": "string" + }, + "type": { + "description": "Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.", + "enum": [ + "TYPE_UNSPECIFIED", + "PIXELS", + "OUTLINES" + ], + "enumDescriptions": [ + "Should not be used.", + "Shows which pixel contributed to the image prediction.", + "Shows which region contributed to the image prediction by outlining the region." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSXpsOperationMetadata": { + "id": "XPSXpsOperationMetadata", + "properties": { + "exampleCount": { + "description": "Optional. XPS server can opt to provide example count of the long running operation (e.g. training, data importing, batch prediction).", + "format": "int64", + "type": "string" + }, + "reportingMetrics": { + "$ref": "XPSReportingMetrics", + "description": "Metrics for the operation. By the time the operation is terminated (whether succeeded or failed) as returned from XPS, AutoML BE assumes the metrics are finalized. AutoML BE transparently posts the metrics to Chemist if it's not empty, regardless of the response content or error type. If user is supposed to be charged in case of cancellation/error, this field should be set. In the case where the type of LRO doesn't require any billing, this field should be left unset." + }, + "tablesTrainingOperationMetadata": { + "$ref": "XPSTablesTrainingOperationMetadata" + }, + "videoBatchPredictOperationMetadata": { + "$ref": "XPSVideoBatchPredictOperationMetadata" + }, + "videoTrainingOperationMetadata": { + "$ref": "XPSVideoTrainingOperationMetadata" + }, + "visionTrainingOperationMetadata": { + "$ref": "XPSVisionTrainingOperationMetadata" + } + }, + "type": "object" + }, + "XPSXraiAttribution": { + "deprecated": true, + "description": "An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Only supports image Models (modality is IMAGE).", + "id": "XPSXraiAttribution", + "properties": { + "stepCount": { + "description": "The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/language-v2.json b/discovery/language-v2.json index 88b57e50812..0e1a289197d 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20240217", + "revision": "20240310", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -338,12 +338,35 @@ "type": "string" }, "features": { - "$ref": "Features", + "$ref": "AnnotateTextRequestFeatures", "description": "Required. The enabled features." } }, "type": "object" }, + "AnnotateTextRequestFeatures": { + "description": "All available features. Setting each one to true will enable that specific analysis for the input.", + "id": "AnnotateTextRequestFeatures", + "properties": { + "classifyText": { + "description": "Optional. Classify the full document into categories.", + "type": "boolean" + }, + "extractDocumentSentiment": { + "description": "Optional. Extract document-level sentiment.", + "type": "boolean" + }, + "extractEntities": { + "description": "Optional. Extract entities.", + "type": "boolean" + }, + "moderateText": { + "description": "Optional. Moderate the document for harmful and sensitive categories.", + "type": "boolean" + } + }, + "type": "object" + }, "AnnotateTextResponse": { "description": "The text annotations response message.", "id": "AnnotateTextResponse", @@ -440,6 +463,450 @@ }, "type": "object" }, + "Color": { + "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", + "id": "Color", + "properties": { + "alpha": { + "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", + "format": "float", + "type": "number" + }, + "blue": { + "description": "The amount of blue in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "green": { + "description": "The amount of green in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "red": { + "description": "The amount of red in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CpuMetric": { + "description": "Metric for billing reports.", + "id": "CpuMetric", + "properties": { + "coreNumber": { + "description": "Required. Number of CPU cores.", + "format": "int64", + "type": "string" + }, + "coreSec": { + "description": "Required. Total seconds of core usage, e.g. 4.", + "format": "int64", + "type": "string" + }, + "cpuType": { + "description": "Required. Type of cpu, e.g. N2.", + "enum": [ + "UNKNOWN_CPU_TYPE", + "A2", + "A3", + "C2", + "C2D", + "CUSTOM", + "E2", + "G2", + "C3", + "M2", + "M1", + "N1", + "N2_CUSTOM", + "N2", + "N2D" + ], + "enumDescriptions": [ + "", + "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", + "COMPUTE_OPTIMIZED", + "", + "", + "", + "GPU-based machine, skip quota reporting.", + "", + "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", + "MEMORY_OPTIMIZED", + "", + "", + "", + "" + ], + "type": "string" + }, + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, + "DiskMetric": { + "id": "DiskMetric", + "properties": { + "diskType": { + "description": "Required. Type of Disk, e.g. REGIONAL_SSD.", + "enum": [ + "UNKNOWN_DISK_TYPE", + "REGIONAL_SSD", + "REGIONAL_STORAGE", + "PD_SSD", + "PD_STANDARD", + "STORAGE_SNAPSHOT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "gibSec": { + "description": "Required. Seconds of physical disk usage, e.g. 3600.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Document": { "description": "Represents the input to API methods.", "id": "Document", @@ -570,25 +1037,414 @@ }, "type": "object" }, - "Features": { - "description": "All available features. Setting each one to true will enable that specific analysis for the input.", - "id": "Features", + "GpuMetric": { + "id": "GpuMetric", "properties": { - "classifyText": { - "description": "Optional. Classify the full document into categories.", - "type": "boolean" + "gpuSec": { + "description": "Required. Seconds of GPU usage, e.g. 3600.", + "format": "int64", + "type": "string" }, - "extractDocumentSentiment": { - "description": "Optional. Extract document-level sentiment.", - "type": "boolean" + "gpuType": { + "description": "Required. Type of GPU, e.g. NVIDIA_TESLA_V100.", + "enum": [ + "UNKNOWN_GPU_TYPE", + "NVIDIA_TESLA_A100", + "NVIDIA_A100_80GB", + "NVIDIA_TESLA_K80", + "NVIDIA_L4", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_V100", + "NVIDIA_H100_80GB" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" }, - "extractEntities": { - "description": "Optional. Extract entities.", - "type": "boolean" + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" }, - "moderateText": { - "description": "Optional. Moderate the document for harmful and sensitive categories.", - "type": "boolean" + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, + "InfraUsage": { + "description": "Infra Usage of billing metrics. Next ID: 6", + "id": "InfraUsage", + "properties": { + "cpuMetrics": { + "description": "Aggregated core metrics since requested start_time.", + "items": { + "$ref": "CpuMetric" + }, + "type": "array" + }, + "diskMetrics": { + "description": "Aggregated persistent disk metrics since requested start_time.", + "items": { + "$ref": "DiskMetric" + }, + "type": "array" + }, + "gpuMetrics": { + "description": "Aggregated gpu metrics since requested start_time.", + "items": { + "$ref": "GpuMetric" + }, + "type": "array" + }, + "ramMetrics": { + "description": "Aggregated ram metrics since requested start_time.", + "items": { + "$ref": "RamMetric" + }, + "type": "array" + }, + "tpuMetrics": { + "description": "Aggregated tpu metrics since requested start_time.", + "items": { + "$ref": "TpuMetric" + }, + "type": "array" } }, "type": "object" @@ -626,6 +1482,391 @@ }, "type": "object" }, + "RamMetric": { + "id": "RamMetric", + "properties": { + "gibSec": { + "description": "Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type to match billing metrics definition.", + "format": "int64", + "type": "string" + }, + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "memories": { + "description": "Required. VM memory in gb.", + "format": "double", + "type": "number" + }, + "ramType": { + "description": "Required. Type of ram.", + "enum": [ + "UNKNOWN_RAM_TYPE", + "A2", + "A3", + "C2", + "C2D", + "CUSTOM", + "E2", + "G2", + "C3", + "M2", + "M1", + "N1", + "N2_CUSTOM", + "N2", + "N2D" + ], + "enumDescriptions": [ + "", + "", + "", + "COMPUTE_OPTIMIZED", + "", + "", + "", + "", + "", + "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", + "MEMORY_OPTIMIZED", + "", + "", + "", + "" + ], + "type": "string" + }, + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, "Sentence": { "description": "Represents a sentence in the input document.", "id": "Sentence", @@ -700,6 +1941,3080 @@ } }, "type": "object" + }, + "TpuMetric": { + "id": "TpuMetric", + "properties": { + "tpuSec": { + "description": "Required. Seconds of TPU usage, e.g. 3600.", + "format": "int64", + "type": "string" + }, + "tpuType": { + "description": "Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD.", + "enum": [ + "UNKNOWN_TPU_TYPE", + "TPU_V2_POD", + "TPU_V2", + "TPU_V3_POD", + "TPU_V3", + "TPU_V5_LITEPOD" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSArrayStats": { + "description": "The data statistics of a series of ARRAY values.", + "id": "XPSArrayStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "memberStats": { + "$ref": "XPSDataStats", + "description": "Stats of all the values of all arrays, as if they were a single long series of data. The type depends on the element type of the array." + } + }, + "type": "object" + }, + "XPSBatchPredictResponse": { + "id": "XPSBatchPredictResponse", + "properties": { + "exampleSet": { + "$ref": "XPSExampleSet", + "description": "Examples for batch prediction result. Under full API implementation, results are stored in shared RecordIO of AnnotatedExample protobufs, the annotations field of which is populated by XPS backend." + } + }, + "type": "object" + }, + "XPSBoundingBoxMetricsEntry": { + "description": "Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.", + "id": "XPSBoundingBoxMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "iouThreshold": { + "description": "The intersection-over-union threshold value used to compute this metrics entry.", + "format": "float", + "type": "number" + }, + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSCategoryStats": { + "description": "The data statistics of a series of CATEGORY values.", + "id": "XPSCategoryStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "topCategoryStats": { + "description": "The statistics of the top 20 CATEGORY values, ordered by CategoryStats.SingleCategoryStats.count.", + "items": { + "$ref": "XPSCategoryStatsSingleCategoryStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSCategoryStatsSingleCategoryStats": { + "description": "The statistics of a single CATEGORY value.", + "id": "XPSCategoryStatsSingleCategoryStats", + "properties": { + "count": { + "description": "The number of occurrences of this value in the series.", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The CATEGORY value.", + "type": "string" + } + }, + "type": "object" + }, + "XPSClassificationEvaluationMetrics": { + "description": "Model evaluation metrics for classification problems. It can be used for image and video classification. Next tag: 9.", + "id": "XPSClassificationEvaluationMetrics", + "properties": { + "auPrc": { + "description": "The Area under precision recall curve metric.", + "format": "float", + "type": "number" + }, + "auRoc": { + "description": "The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation.", + "format": "float", + "type": "number" + }, + "baseAuPrc": { + "description": "The Area under precision recall curve metric based on priors.", + "format": "float", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from it.", + "items": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "type": "array" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the evaluation. Only set for MULTICLASS classification problems where number of annotation specs is no more than 10. Only set for model level evaluation, not for evaluation per label." + }, + "evaluatedExamplesCount": { + "description": "The number of examples used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "logLoss": { + "description": "The Log Loss metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSColorMap": { + "description": "Map from color to display name. Will only be used by Image Segmentation for uCAIP.", + "id": "XPSColorMap", + "properties": { + "annotationSpecIdToken": { + "description": "Should be used during training.", + "type": "string" + }, + "color": { + "$ref": "Color", + "deprecated": true, + "description": "This type is deprecated in favor of the IntColor below. This is because google.type.Color represent color has a float which semantically does not reflect discrete classes/categories concept. Moreover, to handle it well we need to have some tolerance when converting to a discretized color. As such, the recommendation is to have API surface still use google.type.Color while internally IntColor is used." + }, + "displayName": { + "description": "Should be used during preprocessing.", + "type": "string" + }, + "intColor": { + "$ref": "XPSColorMapIntColor" + } + }, + "type": "object" + }, + "XPSColorMapIntColor": { + "description": "RGB color and each channel is represented by an integer.", + "id": "XPSColorMapIntColor", + "properties": { + "blue": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + }, + "green": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + }, + "red": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSColumnSpec": { + "id": "XPSColumnSpec", + "properties": { + "columnId": { + "description": "The unique id of the column. When Preprocess, the Tables BE will popuate the order id of the column, which reflects the order of the column inside the table, i.e. 0 means the first column in the table, N-1 means the last column. AutoML BE will persist this order id in Spanner and set the order id here when calling RefreshTablesStats and Train. Note: it's different than the column_spec_id that is generated in AutoML BE.", + "format": "int32", + "type": "integer" + }, + "dataStats": { + "$ref": "XPSDataStats", + "description": "The data stats of the column. It's outputed in RefreshTablesStats and a required input for Train." + }, + "dataType": { + "$ref": "XPSDataType", + "description": "The data type of the column. It's outputed in Preprocess rpc and a required input for RefreshTablesStats and Train." + }, + "displayName": { + "description": "The display name of the column. It's outputed in Preprocess and a required input for RefreshTablesStats and Train.", + "type": "string" + }, + "forecastingMetadata": { + "$ref": "XPSColumnSpecForecastingMetadata" + }, + "topCorrelatedColumns": { + "description": "It's outputed in RefreshTablesStats, and a required input in Train.", + "items": { + "$ref": "XPSColumnSpecCorrelatedColumn" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSColumnSpecCorrelatedColumn": { + "description": "Identifies a table's column, and its correlation with the column this ColumnSpec describes.", + "id": "XPSColumnSpecCorrelatedColumn", + "properties": { + "columnId": { + "format": "int32", + "type": "integer" + }, + "correlationStats": { + "$ref": "XPSCorrelationStats" + } + }, + "type": "object" + }, + "XPSColumnSpecForecastingMetadata": { + "description": "=========================================================================== # The fields below are used exclusively for Forecasting.", + "id": "XPSColumnSpecForecastingMetadata", + "properties": { + "columnType": { + "description": "The type of the column for FORECASTING model training purposes.", + "enum": [ + "COLUMN_TYPE_UNSPECIFIED", + "KEY", + "KEY_METADATA", + "TIME_SERIES_AVAILABLE_PAST_ONLY", + "TIME_SERIES_AVAILABLE_PAST_AND_FUTURE" + ], + "enumDescriptions": [ + "An un-set value of this enum.", + "Key columns are used to identify timeseries.", + "This column contains information describing static properties of the entities identified by the key column(s) (e.g. city's ZIP code).", + "This column contains information for the given entity, at any time poinrt, they are only available in the time series before.", + "This column contains information for the given entity is known both for the past and the sufficiently far future." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSCommonStats": { + "description": "Common statistics for a column with a specified data type.", + "id": "XPSCommonStats", + "properties": { + "distinctValueCount": { + "format": "int64", + "type": "string" + }, + "nullValueCount": { + "format": "int64", + "type": "string" + }, + "validValueCount": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSConfidenceMetricsEntry": { + "description": "ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. Next tag: 16.", + "id": "XPSConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Metrics are computed with an assumption that the model never return predictions with score lower than this value.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "f1ScoreAt1": { + "description": "The harmonic mean of recall_at1 and precision_at1.", + "format": "float", + "type": "number" + }, + "falseNegativeCount": { + "description": "The number of ground truth labels that are not matched by a model created label.", + "format": "int64", + "type": "string" + }, + "falsePositiveCount": { + "description": "The number of model created labels that do not match a ground truth label.", + "format": "int64", + "type": "string" + }, + "falsePositiveRate": { + "description": "False Positive Rate for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "falsePositiveRateAt1": { + "description": "The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "positionThreshold": { + "description": "Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold.", + "format": "int32", + "type": "integer" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "precisionAt1": { + "description": "The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall (true positive rate) for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recallAt1": { + "description": "The recall (true positive rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "trueNegativeCount": { + "description": "The number of labels that were not created by the model, but if they would, they would not match a ground truth label.", + "format": "int64", + "type": "string" + }, + "truePositiveCount": { + "description": "The number of model created labels that match a ground truth label.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSConfusionMatrix": { + "description": "Confusion matrix of the model running the classification.", + "id": "XPSConfusionMatrix", + "properties": { + "annotationSpecIdToken": { + "description": "For the following three repeated fields, only one is intended to be set. annotation_spec_id_token is preferable to be set. ID tokens of the annotation specs used in the confusion matrix.", + "items": { + "type": "string" + }, + "type": "array" + }, + "category": { + "description": "Category (mainly for segmentation). Set only for image segmentation models. Note: uCAIP Image Segmentation should use annotation_spec_id_token.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "row": { + "description": "Rows in the confusion matrix. The number of rows is equal to the size of `annotation_spec_id_token`. `row[i].value[j]` is the number of examples that have ground truth of the `annotation_spec_id_token[i]` and are predicted as `annotation_spec_id_token[j]` by the model being evaluated.", + "items": { + "$ref": "XPSConfusionMatrixRow" + }, + "type": "array" + }, + "sentimentLabel": { + "description": "Sentiment labels used in the confusion matrix. Set only for text sentiment models. For AutoML Text Revamp, use `annotation_spec_id_token` instead and leave this field empty.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSConfusionMatrixRow": { + "description": "A row in the confusion matrix.", + "id": "XPSConfusionMatrixRow", + "properties": { + "count": { + "description": "Same as above except intended to represent other counts (for e.g. for segmentation this is pixel count). NOTE(params): Only example_count or count is set (oneoff does not support repeated fields unless they are embedded inside another message).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "exampleCount": { + "description": "Value of the specific cell in the confusion matrix. The number of values each row has (i.e. the length of the row) is equal to the length of the annotation_spec_id_token field.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSCoreMlFormat": { + "description": "A model format used for iOS mobile devices.", + "id": "XPSCoreMlFormat", + "properties": {}, + "type": "object" + }, + "XPSCorrelationStats": { + "description": "A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same.", + "id": "XPSCorrelationStats", + "properties": { + "cramersV": { + "description": "The correlation value using the Cramer's V measure.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSDataErrors": { + "description": "Different types of errors and the stats associatesd with each error.", + "id": "XPSDataErrors", + "properties": { + "count": { + "description": "Number of records having errors associated with the enum.", + "format": "int32", + "type": "integer" + }, + "errorType": { + "description": "Type of the error.", + "enum": [ + "ERROR_TYPE_UNSPECIFIED", + "UNSUPPORTED_AUDIO_FORMAT", + "FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT", + "FILE_TOO_LARGE", + "MISSING_TRANSCRIPTION" + ], + "enumDescriptions": [ + "Not specified.", + "Audio format not in the formats by cloud-speech AutoML. Currently only wav and flac file formats are supported.", + "File format differnt from what is specified in the file name extension.", + "File too large. Maximum allowed size is 50 MB.", + "Transcript is missing." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSDataStats": { + "description": "The data statistics of a series of values that share the same DataType.", + "id": "XPSDataStats", + "properties": { + "arrayStats": { + "$ref": "XPSArrayStats", + "description": "The statistics for ARRAY DataType." + }, + "categoryStats": { + "$ref": "XPSCategoryStats", + "description": "The statistics for CATEGORY DataType." + }, + "distinctValueCount": { + "description": "The number of distinct values.", + "format": "int64", + "type": "string" + }, + "float64Stats": { + "$ref": "XPSFloat64Stats", + "description": "The statistics for FLOAT64 DataType." + }, + "nullValueCount": { + "description": "The number of values that are null.", + "format": "int64", + "type": "string" + }, + "stringStats": { + "$ref": "XPSStringStats", + "description": "The statistics for STRING DataType." + }, + "structStats": { + "$ref": "XPSStructStats", + "description": "The statistics for STRUCT DataType." + }, + "timestampStats": { + "$ref": "XPSTimestampStats", + "description": "The statistics for TIMESTAMP DataType." + }, + "validValueCount": { + "description": "The number of values that are valid.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSDataType": { + "description": "Indicated the type of data that can be stored in a structured data entity (e.g. a table).", + "id": "XPSDataType", + "properties": { + "compatibleDataTypes": { + "description": "The highly compatible data types to this data type.", + "items": { + "$ref": "XPSDataType" + }, + "type": "array" + }, + "listElementType": { + "$ref": "XPSDataType", + "description": "If type_code == ARRAY, then `list_element_type` is the type of the elements." + }, + "nullable": { + "description": "If true, this DataType can also be `null`.", + "type": "boolean" + }, + "structType": { + "$ref": "XPSStructType", + "description": "If type_code == STRUCT, then `struct_type` provides type information for the struct's fields." + }, + "timeFormat": { + "description": "If type_code == TIMESTAMP then `time_format` provides the format in which that time field is expressed. The time_format must be written in `strftime` syntax. If time_format is not set, then the default format as described on the field is used.", + "type": "string" + }, + "typeCode": { + "description": "Required. The TypeCode for this type.", + "enum": [ + "TYPE_CODE_UNSPECIFIED", + "FLOAT64", + "TIMESTAMP", + "STRING", + "ARRAY", + "STRUCT", + "CATEGORY" + ], + "enumDescriptions": [ + "Not specified. Should not be used.", + "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or `\"-Infinity\"`.", + "Must be between 0AD and 9999AD. Encoded as `string` according to time_format, or, if that format is not set, then in RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z).", + "Encoded as `string`.", + "Encoded as `list`, where the list elements are represented according to list_element_type.", + "Encoded as `struct`, where field values are represented according to struct_type.", + "Values of this type are not further understood by AutoML, e.g. AutoML is unable to tell the order of values (as it could with FLOAT64), or is unable to say if one value contains another (as it could with STRING). Encoded as `string` (bytes should be base64-encoded, as described in RFC 4648, section 4)." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSDockerFormat": { + "description": "A model format used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system.", + "id": "XPSDockerFormat", + "properties": { + "cpuArchitecture": { + "description": "Optional. Additional cpu information describing the requirements for the to be exported model files.", + "enum": [ + "CPU_ARCHITECTURE_UNSPECIFIED", + "CPU_ARCHITECTURE_X86_64" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "gpuArchitecture": { + "description": "Optional. Additional gpu information describing the requirements for the to be exported model files.", + "enum": [ + "GPU_ARCHITECTURE_UNSPECIFIED", + "GPU_ARCHITECTURE_NVIDIA" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSEdgeTpuTfLiteFormat": { + "description": "A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.", + "id": "XPSEdgeTpuTfLiteFormat", + "properties": {}, + "type": "object" + }, + "XPSEvaluationMetrics": { + "description": "Contains xPS-specific model evaluation metrics either for a single annotation spec (label), or for the model overall. Next tag: 18.", + "id": "XPSEvaluationMetrics", + "properties": { + "annotationSpecIdToken": { + "description": "The annotation_spec for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The value comes from the input annotations in AnnotatedExample. For MVP product or for text sentiment models where annotation_spec_id_token is not available, set label instead.", + "type": "string" + }, + "category": { + "description": "The integer category label for which this evaluation metric instance had been created. Valid categories are 0 or higher. Overall model evaluation should set this to negative values (rather than implicit zero). Only used for Image Segmentation (prefer to set annotation_spec_id_token instead). Note: uCAIP Image Segmentation should use annotation_spec_id_token.", + "format": "int32", + "type": "integer" + }, + "evaluatedExampleCount": { + "description": "The number of examples used to create this evaluation metrics instance.", + "format": "int32", + "type": "integer" + }, + "imageClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "imageObjectDetectionEvalMetrics": { + "$ref": "XPSImageObjectDetectionEvaluationMetrics" + }, + "imageSegmentationEvalMetrics": { + "$ref": "XPSImageSegmentationEvaluationMetrics" + }, + "label": { + "description": "The label for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The label maps to AnnotationSpec.display_name in Public API protos. Only used by MVP implementation and text sentiment FULL implementation.", + "type": "string" + }, + "regressionEvalMetrics": { + "$ref": "XPSRegressionEvaluationMetrics" + }, + "tablesClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "tablesEvalMetrics": { + "$ref": "XPSTablesEvaluationMetrics" + }, + "textClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "textExtractionEvalMetrics": { + "$ref": "XPSTextExtractionEvaluationMetrics" + }, + "textSentimentEvalMetrics": { + "$ref": "XPSTextSentimentEvaluationMetrics" + }, + "translationEvalMetrics": { + "$ref": "XPSTranslationEvaluationMetrics" + }, + "videoActionRecognitionEvalMetrics": { + "$ref": "XPSVideoActionRecognitionEvaluationMetrics" + }, + "videoClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "videoObjectTrackingEvalMetrics": { + "$ref": "XPSVideoObjectTrackingEvaluationMetrics" + } + }, + "type": "object" + }, + "XPSEvaluationMetricsSet": { + "description": "Specifies location of model evaluation metrics.", + "id": "XPSEvaluationMetricsSet", + "properties": { + "evaluationMetrics": { + "description": "Inline EvaluationMetrics - should be relatively small. For passing large quantities of exhaustive metrics, use file_spec.", + "items": { + "$ref": "XPSEvaluationMetrics" + }, + "type": "array" + }, + "fileSpec": { + "$ref": "XPSFileSpec", + "description": "File spec containing evaluation metrics of a model, must point to RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics messages." + }, + "numEvaluationMetrics": { + "description": "Number of the evaluation metrics (usually one per label plus overall).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSExampleSet": { + "description": "Set of examples or input sources.", + "id": "XPSExampleSet", + "properties": { + "fileSpec": { + "$ref": "XPSFileSpec", + "description": "File spec of the examples or input sources." + }, + "fingerprint": { + "description": "Fingerprint of the example set.", + "format": "int64", + "type": "string" + }, + "numExamples": { + "description": "Number of examples.", + "format": "int64", + "type": "string" + }, + "numInputSources": { + "description": "Number of input sources.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSExportModelOutputConfig": { + "id": "XPSExportModelOutputConfig", + "properties": { + "coreMlFormat": { + "$ref": "XPSCoreMlFormat" + }, + "dockerFormat": { + "$ref": "XPSDockerFormat" + }, + "edgeTpuTfLiteFormat": { + "$ref": "XPSEdgeTpuTfLiteFormat" + }, + "exportFirebaseAuxiliaryInfo": { + "description": "For any model and format: If true, will additionally export FirebaseExportedModelInfo in a firebase.txt file.", + "type": "boolean" + }, + "outputGcrUri": { + "description": "The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", + "type": "string" + }, + "outputGcsUri": { + "description": "The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory", + "type": "string" + }, + "tfJsFormat": { + "$ref": "XPSTfJsFormat" + }, + "tfLiteFormat": { + "$ref": "XPSTfLiteFormat" + }, + "tfSavedModelFormat": { + "$ref": "XPSTfSavedModelFormat" + } + }, + "type": "object" + }, + "XPSFileSpec": { + "description": "Spec of input and output files, on external file systems (CNS, GCS, etc).", + "id": "XPSFileSpec", + "properties": { + "directoryPath": { + "deprecated": true, + "description": "Deprecated. Use file_spec.", + "type": "string" + }, + "fileFormat": { + "enum": [ + "FILE_FORMAT_UNKNOWN", + "FILE_FORMAT_SSTABLE", + "FILE_FORMAT_TRANSLATION_RKV", + "FILE_FORMAT_RECORDIO", + "FILE_FORMAT_RAW_CSV", + "FILE_FORMAT_RAW_CAPACITOR" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "", + "", + "Internal format for parallel text data used by Google Translate. go/rkvtools", + "", + "Only the lexicographically first file described by the file_spec contains the header line.", + "" + ], + "type": "string" + }, + "fileSpec": { + "description": "Single file path, or file pattern of format \"/path/to/file@shard_count\". E.g. /cns/cell-d/somewhere/file@2 is expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and /cns/cell-d/somewhere/file-00001-of-00002.", + "type": "string" + }, + "singleFilePath": { + "deprecated": true, + "description": "Deprecated. Use file_spec.", + "type": "string" + } + }, + "type": "object" + }, + "XPSFloat64Stats": { + "description": "The data statistics of a series of FLOAT64 values.", + "id": "XPSFloat64Stats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "histogramBuckets": { + "description": "Histogram buckets of the data series. Sorted by the min value of the bucket, ascendingly, and the number of the buckets is dynamically generated. The buckets are non-overlapping and completely cover whole FLOAT64 range with min of first bucket being `\"-Infinity\"`, and max of the last one being `\"Infinity\"`.", + "items": { + "$ref": "XPSFloat64StatsHistogramBucket" + }, + "type": "array" + }, + "mean": { + "description": "The mean of the series.", + "format": "double", + "type": "number" + }, + "quantiles": { + "description": "Ordered from 0 to k k-quantile values of the data series of n values. The value at index i is, approximately, the i*n/k-th smallest value in the series; for i = 0 and i = k these are, respectively, the min and max values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "standardDeviation": { + "description": "The standard deviation of the series.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSFloat64StatsHistogramBucket": { + "description": "A bucket of a histogram.", + "id": "XPSFloat64StatsHistogramBucket", + "properties": { + "count": { + "description": "The number of data values that are in the bucket, i.e. are between min and max values.", + "format": "int64", + "type": "string" + }, + "max": { + "description": "The maximum value of the bucket, exclusive unless max = `\"Infinity\"`, in which case it's inclusive.", + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum value of the bucket, inclusive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSImageClassificationTrainResponse": { + "id": "XPSImageClassificationTrainResponse", + "properties": { + "classCount": { + "description": "Total number of classes.", + "format": "int64", + "type": "string" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec", + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Populated for AutoMl requests." + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostInNodeTime": { + "description": "The actual cost to create this model. - For edge type model, the cost is expressed in node hour. - For cloud type model,the cost is expressed in compute hour. - Populated for models created before GA. To be deprecated after GA.", + "format": "google-duration", + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual training cost, expressed in node seconds. Populated for models trained in node time.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageExportModelSpec": { + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.", + "id": "XPSImageExportModelSpec", + "properties": { + "exportModelOutputConfig": { + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "items": { + "$ref": "XPSExportModelOutputConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSImageModelArtifactSpec": { + "description": "Stores the locations and related metadata of the model artifacts. Populated for uCAIP requests only.", + "id": "XPSImageModelArtifactSpec", + "properties": { + "checkpointArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The Tensorflow checkpoint files. e.g. Used for resumable training." + }, + "exportArtifact": { + "description": "The model binary files in different formats for model export.", + "items": { + "$ref": "XPSModelArtifactItem" + }, + "type": "array" + }, + "labelGcsUri": { + "description": "GCS uri of decoded labels file for model export 'dict.txt'.", + "type": "string" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API." + }, + "tfJsBinaryGcsPrefix": { + "description": "GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated.", + "type": "string" + }, + "tfLiteMetadataGcsUri": { + "description": "GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'.", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageModelServingSpec": { + "description": "Serving specification for image models.", + "id": "XPSImageModelServingSpec", + "properties": { + "modelThroughputEstimation": { + "description": "Populate under uCAIP request scope.", + "items": { + "$ref": "XPSImageModelServingSpecModelThroughputEstimation" + }, + "type": "array" + }, + "nodeQps": { + "description": "An estimated value of how much traffic a node can serve. Populated for AutoMl request only.", + "format": "double", + "type": "number" + }, + "tfRuntimeVersion": { + "description": "## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageModelServingSpecModelThroughputEstimation": { + "id": "XPSImageModelServingSpecModelThroughputEstimation", + "properties": { + "computeEngineAcceleratorType": { + "enum": [ + "UNSPECIFIED", + "NVIDIA_TESLA_K80", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_V100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_A100", + "NVIDIA_A100_80GB", + "NVIDIA_L4", + "NVIDIA_H100_80GB", + "TPU_V2", + "TPU_V3", + "TPU_V4_POD", + "TPU_V5_LITEPOD" + ], + "enumDescriptions": [ + "", + "Nvidia Tesla K80 GPU.", + "Nvidia Tesla P100 GPU.", + "Nvidia Tesla V100 GPU.", + "Nvidia Tesla P4 GPU.", + "Nvidia Tesla T4 GPU.", + "Nvidia Tesla A100 GPU.", + "Nvidia A100 80GB GPU.", + "Nvidia L4 GPU.", + "Nvidia H100 80Gb GPU.", + "TPU v2 (JellyFish).", + "TPU v3 (DragonFish).", + "TPU_v4 (PufferFish).", + "TPU v5 Lite Pods." + ], + "type": "string" + }, + "latencyInMilliseconds": { + "description": "Estimated latency.", + "format": "double", + "type": "number" + }, + "nodeQps": { + "description": "The approximate qps a deployed node can serve.", + "format": "double", + "type": "number" + }, + "servomaticPartitionType": { + "enum": [ + "PARTITION_TYPE_UNSPECIFIED", + "PARTITION_ZERO", + "PARTITION_REDUCED_HOMING", + "PARTITION_JELLYFISH", + "PARTITION_CPU", + "PARTITION_CUSTOM_STORAGE_CPU" + ], + "enumDescriptions": [ + "", + "The default partition.", + "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", + "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "The partition used by regionalized servomatic cloud regions.", + "The partition used for loading models from custom storage." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSImageObjectDetectionEvaluationMetrics": { + "description": "Model evaluation metrics for image object detection problems. Evaluates prediction quality of labeled bounding boxes.", + "id": "XPSImageObjectDetectionEvaluationMetrics", + "properties": { + "boundingBoxMeanAveragePrecision": { + "description": "The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries.", + "format": "float", + "type": "number" + }, + "boundingBoxMetricsEntries": { + "description": "The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntry" + }, + "type": "array" + }, + "evaluatedBoundingBoxCount": { + "description": "The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSImageObjectDetectionModelSpec": { + "id": "XPSImageObjectDetectionModelSpec", + "properties": { + "classCount": { + "description": "Total number of classes.", + "format": "int64", + "type": "string" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec" + }, + "maxBoundingBoxCount": { + "description": "Max number of bounding box.", + "format": "int64", + "type": "string" + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageSegmentationEvaluationMetrics": { + "description": "Model evaluation metrics for image segmentation problems. Next tag: 4.", + "id": "XPSImageSegmentationEvaluationMetrics", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from it.", + "items": { + "$ref": "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the per confidence_threshold evaluation. Pixel counts are set here. Only set for model level evaluation, not for evaluation per label." + }, + "diceScoreCoefficient": { + "description": "DSC or the F1 score: The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "iouScore": { + "description": "IOU score.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSImageSegmentationTrainResponse": { + "id": "XPSImageSegmentationTrainResponse", + "properties": { + "colorMaps": { + "description": "Color map of the model.", + "items": { + "$ref": "XPSColorMap" + }, + "type": "array" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec", + "description": "NOTE: These fields are not used/needed in EAP but will be set later." + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope. Model artifact spec stores and model gcs pathes and related metadata" + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSIntegratedGradientsAttribution": { + "deprecated": true, + "description": "An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365", + "id": "XPSIntegratedGradientsAttribution", + "properties": { + "stepCount": { + "description": "The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSMetricEntry": { + "id": "XPSMetricEntry", + "properties": { + "argentumMetricId": { + "description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", + "type": "string" + }, + "doubleValue": { + "description": "A double value.", + "format": "double", + "type": "number" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "systemLabels": { + "description": "Billing system labels for this (metric, value) pair.", + "items": { + "$ref": "XPSMetricEntryLabel" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSMetricEntryLabel": { + "id": "XPSMetricEntryLabel", + "properties": { + "labelName": { + "description": "The name of the label.", + "type": "string" + }, + "labelValue": { + "description": "The value of the label.", + "type": "string" + } + }, + "type": "object" + }, + "XPSModelArtifactItem": { + "description": "A single model artifact item.", + "id": "XPSModelArtifactItem", + "properties": { + "artifactFormat": { + "description": "The model artifact format.", + "enum": [ + "ARTIFACT_FORMAT_UNSPECIFIED", + "TF_CHECKPOINT", + "TF_SAVED_MODEL", + "TF_LITE", + "EDGE_TPU_TF_LITE", + "TF_JS", + "CORE_ML" + ], + "enumDescriptions": [ + "Should not be used.", + "The Tensorflow checkpoints. See https://www.tensorflow.org/guide/checkpoint.", + "The Tensorflow SavedModel binary.", + "Model artifact in generic TensorFlow Lite (.tflite) format. See https://www.tensorflow.org/lite.", + "Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.", + "A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.", + "Used for iOS mobile devices in (.mlmodel) format. See https://developer.apple.com/documentation/coreml" + ], + "type": "string" + }, + "gcsUri": { + "description": "The Google Cloud Storage (GCS) uri that stores the model binary files.", + "type": "string" + } + }, + "type": "object" + }, + "XPSPreprocessResponse": { + "description": "Next ID: 8", + "id": "XPSPreprocessResponse", + "properties": { + "outputExampleSet": { + "$ref": "XPSExampleSet", + "description": "Preprocessed examples, that are to be imported into AutoML storage. This should point to RecordIO file(s) of PreprocessedExample messages. The PreprocessedExample.mvp_training_data-s returned here are later verbatim passed to Train() call in TrainExample.mvp_training_data." + }, + "speechPreprocessResp": { + "$ref": "XPSSpeechPreprocessResponse" + }, + "tablesPreprocessResponse": { + "$ref": "XPSTablesPreprocessResponse" + }, + "translationPreprocessResp": { + "$ref": "XPSTranslationPreprocessResponse" + } + }, + "type": "object" + }, + "XPSRegressionEvaluationMetrics": { + "description": "Model evaluation metrics for regression problems. It can be used for Tables.", + "id": "XPSRegressionEvaluationMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean Absolute Error (MAE).", + "format": "float", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error. Only set if all ground truth values are positive.", + "format": "float", + "type": "number" + }, + "rSquared": { + "description": "R squared.", + "format": "float", + "type": "number" + }, + "regressionMetricsEntries": { + "description": "A list of actual versus predicted points for the model being evaluated.", + "items": { + "$ref": "XPSRegressionMetricsEntry" + }, + "type": "array" + }, + "rootMeanSquaredError": { + "description": "Root Mean Squared Error (RMSE).", + "format": "float", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSRegressionMetricsEntry": { + "description": "A pair of actual & observed values for the model being evaluated.", + "id": "XPSRegressionMetricsEntry", + "properties": { + "predictedValue": { + "description": "The observed value for a row in the dataset.", + "format": "float", + "type": "number" + }, + "trueValue": { + "description": "The actual target value for a row in the dataset.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSReportingMetrics": { + "id": "XPSReportingMetrics", + "properties": { + "effectiveTrainingDuration": { + "deprecated": true, + "description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", + "format": "google-duration", + "type": "string" + }, + "metricEntries": { + "description": "One entry per metric name. The values must be aggregated per metric name.", + "items": { + "$ref": "XPSMetricEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadata": { + "deprecated": true, + "id": "XPSResponseExplanationMetadata", + "properties": { + "inputs": { + "additionalProperties": { + "$ref": "XPSResponseExplanationMetadataInputMetadata" + }, + "description": "Metadata of the input.", + "type": "object" + }, + "outputs": { + "additionalProperties": { + "$ref": "XPSResponseExplanationMetadataOutputMetadata" + }, + "description": "Metadata of the output.", + "type": "object" + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadataInputMetadata": { + "description": "Metadata of the input of a feature.", + "id": "XPSResponseExplanationMetadataInputMetadata", + "properties": { + "inputTensorName": { + "description": "Name of the input tensor for this model. Only needed in train response.", + "type": "string" + }, + "modality": { + "description": "Modality of the feature. Valid values are: numeric, image. Defaults to numeric.", + "enum": [ + "MODALITY_UNSPECIFIED", + "NUMERIC", + "IMAGE", + "CATEGORICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "visualizationConfig": { + "$ref": "XPSVisualization", + "description": "Visualization configurations for image explanation." + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadataOutputMetadata": { + "description": "Metadata of the prediction output to be explained.", + "id": "XPSResponseExplanationMetadataOutputMetadata", + "properties": { + "outputTensorName": { + "description": "Name of the output tensor. Only needed in train response.", + "type": "string" + } + }, + "type": "object" + }, + "XPSResponseExplanationParameters": { + "deprecated": true, + "id": "XPSResponseExplanationParameters", + "properties": { + "integratedGradientsAttribution": { + "$ref": "XPSIntegratedGradientsAttribution", + "description": "An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365" + }, + "xraiAttribution": { + "$ref": "XPSXraiAttribution", + "description": "An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead." + } + }, + "type": "object" + }, + "XPSResponseExplanationSpec": { + "deprecated": true, + "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context.", + "id": "XPSResponseExplanationSpec", + "properties": { + "explanationType": { + "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", + "type": "string" + }, + "metadata": { + "$ref": "XPSResponseExplanationMetadata", + "description": "Metadata describing the Model's input and output for explanation." + }, + "parameters": { + "$ref": "XPSResponseExplanationParameters", + "description": "Parameters that configure explaining of the Model's predictions." + } + }, + "type": "object" + }, + "XPSRow": { + "id": "XPSRow", + "properties": { + "columnIds": { + "description": "The ids of the columns. Note: The below `values` field must match order of this field, if this field is set.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "values": { + "description": "The values of the row cells, given in the same order as the column_ids. If column_ids is not set, then in the same order as the input_feature_column_ids in TablesModelMetadata.", + "items": { + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechEvaluationMetrics": { + "id": "XPSSpeechEvaluationMetrics", + "properties": { + "subModelEvaluationMetrics": { + "description": "Evaluation metrics for all submodels contained in this model.", + "items": { + "$ref": "XPSSpeechEvaluationMetricsSubModelEvaluationMetric" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechEvaluationMetricsSubModelEvaluationMetric": { + "id": "XPSSpeechEvaluationMetricsSubModelEvaluationMetric", + "properties": { + "biasingModelType": { + "description": "Type of the biasing model.", + "enum": [ + "BIASING_MODEL_TYPE_UNSPECIFIED", + "COMMAND_AND_SEARCH", + "PHONE_CALL", + "VIDEO", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "Build biasing model on top of COMMAND_AND_SEARCH model", + "Build biasing model on top of PHONE_CALL model", + "Build biasing model on top of VIDEO model", + "Build biasing model on top of DEFAULT model" + ], + "type": "string" + }, + "isEnhancedModel": { + "description": "If true then it means we have an enhanced version of the biasing models.", + "type": "boolean" + }, + "numDeletions": { + "format": "int32", + "type": "integer" + }, + "numInsertions": { + "format": "int32", + "type": "integer" + }, + "numSubstitutions": { + "format": "int32", + "type": "integer" + }, + "numUtterances": { + "description": "Number of utterances used in the wer computation.", + "format": "int32", + "type": "integer" + }, + "numWords": { + "description": "Number of words over which the word error rate was computed.", + "format": "int32", + "type": "integer" + }, + "sentenceAccuracy": { + "description": "Below fields are used for debugging purposes", + "format": "double", + "type": "number" + }, + "wer": { + "description": "Word error rate (standard error metric used for speech recognition).", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSSpeechModelSpec": { + "id": "XPSSpeechModelSpec", + "properties": { + "datasetId": { + "description": "Required for speech xps backend. Speech xps has to use dataset_id and model_id as the primary key in db so that speech API can query the db directly.", + "format": "int64", + "type": "string" + }, + "language": { + "type": "string" + }, + "subModelSpecs": { + "description": "Model specs for all submodels contained in this model.", + "items": { + "$ref": "XPSSpeechModelSpecSubModelSpec" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechModelSpecSubModelSpec": { + "id": "XPSSpeechModelSpecSubModelSpec", + "properties": { + "biasingModelType": { + "description": "Type of the biasing model.", + "enum": [ + "BIASING_MODEL_TYPE_UNSPECIFIED", + "COMMAND_AND_SEARCH", + "PHONE_CALL", + "VIDEO", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "Build biasing model on top of COMMAND_AND_SEARCH model", + "Build biasing model on top of PHONE_CALL model", + "Build biasing model on top of VIDEO model", + "Build biasing model on top of DEFAULT model" + ], + "type": "string" + }, + "clientId": { + "description": "In S3, Recognition ClientContextId.client_id", + "type": "string" + }, + "contextId": { + "description": "In S3, Recognition ClientContextId.context_id", + "type": "string" + }, + "isEnhancedModel": { + "description": "If true then it means we have an enhanced version of the biasing models.", + "type": "boolean" + } + }, + "type": "object" + }, + "XPSSpeechPreprocessResponse": { + "id": "XPSSpeechPreprocessResponse", + "properties": { + "cnsTestDataPath": { + "description": "Location od shards of sstables (test data) of DataUtterance protos.", + "type": "string" + }, + "cnsTrainDataPath": { + "description": "Location of shards of sstables (training data) of DataUtterance protos.", + "type": "string" + }, + "prebuiltModelEvaluationMetrics": { + "$ref": "XPSSpeechEvaluationMetrics", + "description": "The metrics for prebuilt speech models. They are included here because there is no prebuilt speech models stored in the AutoML." + }, + "speechPreprocessStats": { + "$ref": "XPSSpeechPreprocessStats", + "description": "Stats associated with the data." + } + }, + "type": "object" + }, + "XPSSpeechPreprocessStats": { + "id": "XPSSpeechPreprocessStats", + "properties": { + "dataErrors": { + "description": "Different types of data errors and the counts associated with them.", + "items": { + "$ref": "XPSDataErrors" + }, + "type": "array" + }, + "numHumanLabeledExamples": { + "description": "The number of rows marked HUMAN_LABELLED", + "format": "int32", + "type": "integer" + }, + "numLogsExamples": { + "description": "The number of samples found in the previously recorded logs data.", + "format": "int32", + "type": "integer" + }, + "numMachineTranscribedExamples": { + "description": "The number of rows marked as MACHINE_TRANSCRIBED", + "format": "int32", + "type": "integer" + }, + "testExamplesCount": { + "description": "The number of examples labelled as TEST by Speech xps server.", + "format": "int32", + "type": "integer" + }, + "testSentencesCount": { + "description": "The number of sentences in the test data set.", + "format": "int32", + "type": "integer" + }, + "testWordsCount": { + "description": "The number of words in the test data set.", + "format": "int32", + "type": "integer" + }, + "trainExamplesCount": { + "description": "The number of examples labeled as TRAIN by Speech xps server.", + "format": "int32", + "type": "integer" + }, + "trainSentencesCount": { + "description": "The number of sentences in the training data set.", + "format": "int32", + "type": "integer" + }, + "trainWordsCount": { + "description": "The number of words in the training data set.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSStringStats": { + "description": "The data statistics of a series of STRING values.", + "id": "XPSStringStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "topUnigramStats": { + "description": "The statistics of the top 20 unigrams, ordered by StringStats.UnigramStats.count.", + "items": { + "$ref": "XPSStringStatsUnigramStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSStringStatsUnigramStats": { + "description": "The statistics of a unigram.", + "id": "XPSStringStatsUnigramStats", + "properties": { + "count": { + "description": "The number of occurrences of this unigram in the series.", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The unigram.", + "type": "string" + } + }, + "type": "object" + }, + "XPSStructStats": { + "description": "The data statistics of a series of STRUCT values.", + "id": "XPSStructStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "fieldStats": { + "additionalProperties": { + "$ref": "XPSDataStats" + }, + "description": "Map from a field name of the struct to data stats aggregated over series of all data in that field across all the structs.", + "type": "object" + } + }, + "type": "object" + }, + "XPSStructType": { + "description": "`StructType` defines the DataType-s of a STRUCT type.", + "id": "XPSStructType", + "properties": { + "fields": { + "additionalProperties": { + "$ref": "XPSDataType" + }, + "description": "Unordered map of struct field names to their data types.", + "type": "object" + } + }, + "type": "object" + }, + "XPSTableSpec": { + "id": "XPSTableSpec", + "properties": { + "columnSpecs": { + "additionalProperties": { + "$ref": "XPSColumnSpec" + }, + "description": "Mapping from column id to column spec.", + "type": "object" + }, + "importedDataSizeInBytes": { + "description": "The total size of imported data of the table.", + "format": "int64", + "type": "string" + }, + "rowCount": { + "description": "The number of rows in the table.", + "format": "int64", + "type": "string" + }, + "timeColumnId": { + "description": "The id of the time column.", + "format": "int32", + "type": "integer" + }, + "validRowCount": { + "description": "The number of valid rows.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesClassificationMetrics": { + "description": "Metrics for Tables classification problems.", + "id": "XPSTablesClassificationMetrics", + "properties": { + "curveMetrics": { + "description": "Metrics building a curve.", + "items": { + "$ref": "XPSTablesClassificationMetricsCurveMetrics" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesClassificationMetricsCurveMetrics": { + "description": "Metrics curve data point for a single value.", + "id": "XPSTablesClassificationMetricsCurveMetrics", + "properties": { + "aucPr": { + "description": "The area under the precision-recall curve.", + "format": "double", + "type": "number" + }, + "aucRoc": { + "description": "The area under receiver operating characteristic curve.", + "format": "double", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve and ROC curve can be derived from them.", + "items": { + "$ref": "XPSTablesConfidenceMetricsEntry" + }, + "type": "array" + }, + "logLoss": { + "description": "The Log loss metric.", + "format": "double", + "type": "number" + }, + "positionThreshold": { + "description": "The position threshold value used to compute the metrics.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The CATEGORY row value (for ARRAY unnested) the curve metrics are for.", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSTablesConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "double", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision. (2 * precision * recall) / (precision + recall)", + "format": "double", + "type": "number" + }, + "falseNegativeCount": { + "description": "False negative count.", + "format": "int64", + "type": "string" + }, + "falsePositiveCount": { + "description": "False positive count.", + "format": "int64", + "type": "string" + }, + "falsePositiveRate": { + "description": "FPR = #false positives / (#false positives + #true negatives)", + "format": "double", + "type": "number" + }, + "precision": { + "description": "Precision = #true positives / (#true positives + #false positives).", + "format": "double", + "type": "number" + }, + "recall": { + "description": "Recall = #true positives / (#true positives + #false negatives).", + "format": "double", + "type": "number" + }, + "trueNegativeCount": { + "description": "True negative count.", + "format": "int64", + "type": "string" + }, + "truePositiveCount": { + "description": "True positive count.", + "format": "int64", + "type": "string" + }, + "truePositiveRate": { + "description": "TPR = #true positives / (#true positives + #false negatvies)", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesDatasetMetadata": { + "description": "Metadata for a dataset used for AutoML Tables. Next ID: 6", + "id": "XPSTablesDatasetMetadata", + "properties": { + "mlUseColumnId": { + "description": "Id the column to split the table.", + "format": "int32", + "type": "integer" + }, + "primaryTableSpec": { + "$ref": "XPSTableSpec", + "description": "Primary table." + }, + "targetColumnCorrelations": { + "additionalProperties": { + "$ref": "XPSCorrelationStats" + }, + "description": "(the column id : its CorrelationStats with target column).", + "type": "object" + }, + "targetColumnId": { + "description": "Id of the primary table column that should be used as the training label.", + "format": "int32", + "type": "integer" + }, + "weightColumnId": { + "description": "Id of the primary table column that should be used as the weight column.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSTablesEvaluationMetrics": { + "id": "XPSTablesEvaluationMetrics", + "properties": { + "classificationMetrics": { + "$ref": "XPSTablesClassificationMetrics", + "description": "Classification metrics." + }, + "regressionMetrics": { + "$ref": "XPSTablesRegressionMetrics", + "description": "Regression metrics." + } + }, + "type": "object" + }, + "XPSTablesModelColumnInfo": { + "description": "An information specific to given column and Tables Model, in context of the Model and the predictions created by it.", + "id": "XPSTablesModelColumnInfo", + "properties": { + "columnId": { + "description": "The ID of the column.", + "format": "int32", + "type": "integer" + }, + "featureImportance": { + "description": "When given as part of a Model: Measurement of how much model predictions correctness on the TEST data depend on values in this column. A value between 0 and 1, higher means higher influence. These values are normalized - for all input feature columns of a given model they add to 1. When given back by Predict or Batch Predict: Measurement of how impactful for the prediction returned for the given row the value in this column was. Specifically, the feature importance specifies the marginal contribution that the feature made to the prediction score compared to the baseline score. These values are computed using the Sampled Shapley method.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesModelStructure": { + "description": "A description of Tables model structure.", + "id": "XPSTablesModelStructure", + "properties": { + "modelParameters": { + "description": "A list of models.", + "items": { + "$ref": "XPSTablesModelStructureModelParameters" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesModelStructureModelParameters": { + "description": "Model hyper-parameters for a model.", + "id": "XPSTablesModelStructureModelParameters", + "properties": { + "hyperparameters": { + "items": { + "$ref": "XPSTablesModelStructureModelParametersParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesModelStructureModelParametersParameter": { + "id": "XPSTablesModelStructureModelParametersParameter", + "properties": { + "floatValue": { + "description": "Float type parameter value.", + "format": "double", + "type": "number" + }, + "intValue": { + "description": "Integer type parameter value.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Parameter name.", + "type": "string" + }, + "stringValue": { + "description": "String type parameter value.", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesPreprocessResponse": { + "id": "XPSTablesPreprocessResponse", + "properties": { + "tablesDatasetMetadata": { + "$ref": "XPSTablesDatasetMetadata", + "description": "The table/column id, column_name and the DataTypes of the columns will be populated." + } + }, + "type": "object" + }, + "XPSTablesRegressionMetrics": { + "description": "Metrics for Tables regression problems.", + "id": "XPSTablesRegressionMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean absolute error.", + "format": "double", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error, only set if all of the target column's values are positive.", + "format": "double", + "type": "number" + }, + "rSquared": { + "description": "R squared.", + "format": "double", + "type": "number" + }, + "regressionMetricsEntries": { + "description": "A list of actual versus predicted points for the model being evaluated.", + "items": { + "$ref": "XPSRegressionMetricsEntry" + }, + "type": "array" + }, + "rootMeanSquaredError": { + "description": "Root mean squared error.", + "format": "double", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesTrainResponse": { + "id": "XPSTablesTrainResponse", + "properties": { + "modelStructure": { + "$ref": "XPSTablesModelStructure" + }, + "predictionSampleRows": { + "description": "Sample rows from the dataset this model was trained.", + "items": { + "$ref": "XPSRow" + }, + "type": "array" + }, + "tablesModelColumnInfo": { + "description": "Output only. Auxiliary information for each of the input_feature_column_specs, with respect to this particular model.", + "items": { + "$ref": "XPSTablesModelColumnInfo" + }, + "type": "array" + }, + "trainCostMilliNodeHours": { + "description": "The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesTrainingOperationMetadata": { + "id": "XPSTablesTrainingOperationMetadata", + "properties": { + "createModelStage": { + "description": "Current stage of creating model.", + "enum": [ + "CREATE_MODEL_STAGE_UNSPECIFIED", + "DATA_PREPROCESSING", + "TRAINING", + "EVALUATING", + "MODEL_POST_PROCESSING" + ], + "enumDescriptions": [ + "Unspecified stage.", + "Prepare the model training pipeline and run data processing.", + "Training model.", + "Run evaluation.", + "Finalizing model training pipeline." + ], + "type": "string" + }, + "optimizationObjective": { + "description": "The optimization objective for model.", + "type": "string" + }, + "topTrials": { + "description": "This field is for training. When the operation is terminated successfully, AutoML Backend post this field to operation metadata in spanner. If the metadata has no trials returned, the training operation is supposed to be a failure.", + "items": { + "$ref": "XPSTuningTrial" + }, + "type": "array" + }, + "trainBudgetMilliNodeHours": { + "description": "Creating model budget.", + "format": "int64", + "type": "string" + }, + "trainingObjectivePoints": { + "description": "This field records the training objective value with respect to time, giving insight into how the model architecture search is performing as training time elapses.", + "items": { + "$ref": "XPSTrainingObjectivePoint" + }, + "type": "array" + }, + "trainingStartTime": { + "description": "Timestamp when training process starts.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "XPSTextComponentModel": { + "description": "Component model. Next ID: 10", + "id": "XPSTextComponentModel", + "properties": { + "batchPredictionModelGcsUri": { + "description": "The Cloud Storage resource path to hold batch prediction model.", + "type": "string" + }, + "onlinePredictionModelGcsUri": { + "description": "The Cloud Storage resource path to hold online prediction model.", + "type": "string" + }, + "partition": { + "description": "The partition where the model is deployed. Populated by uCAIP BE as part of online PredictRequest.", + "enum": [ + "PARTITION_TYPE_UNSPECIFIED", + "PARTITION_ZERO", + "PARTITION_REDUCED_HOMING", + "PARTITION_JELLYFISH", + "PARTITION_CPU", + "PARTITION_CUSTOM_STORAGE_CPU" + ], + "enumDescriptions": [ + "", + "The default partition.", + "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", + "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "The partition used by regionalized servomatic cloud regions.", + "The partition used for loading models from custom storage." + ], + "type": "string" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud Ai Platform API." + }, + "servoModelName": { + "description": "The name of servo model. Populated by uCAIP BE as part of online PredictRequest.", + "type": "string" + }, + "submodelName": { + "description": "The name of the trained NL submodel.", + "type": "string" + }, + "submodelType": { + "description": "The type of trained NL submodel", + "enum": [ + "TEXT_MODEL_TYPE_UNSPECIFIED", + "TEXT_MODEL_TYPE_DEFAULT", + "TEXT_MODEL_TYPE_META_ARCHITECT", + "TEXT_MODEL_TYPE_ATC", + "TEXT_MODEL_TYPE_CLARA2", + "TEXT_MODEL_TYPE_CHATBASE", + "TEXT_MODEL_TYPE_SAFT_SPAN_LABELING", + "TEXT_MODEL_TYPE_TEXT_EXTRACTION", + "TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION", + "TEXT_MODEL_TYPE_COMPOSITE", + "TEXT_MODEL_TYPE_ALL_MODELS", + "TEXT_MODEL_TYPE_BERT", + "TEXT_MODEL_TYPE_ENC_PALM" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "Model type for entity extraction.", + "Model type for relationship extraction.", + "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model. Please refer to go/cnl-composite-models for more information.", + "Model type used to train default, MA, and ATC models in a single batch worker pipeline.", + "BERT pipeline needs a specific model type, since it uses a different TFX configuration compared with DEFAULT (despite sharing most of the code).", + "Model type for EncPaLM." + ], + "type": "string" + }, + "tfRuntimeVersion": { + "description": "## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list", + "type": "string" + }, + "versionNumber": { + "description": "The servomatic model version number. Populated by uCAIP BE as part of online PredictRequest.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTextExtractionEvaluationMetrics": { + "id": "XPSTextExtractionEvaluationMetrics", + "properties": { + "bestF1ConfidenceMetrics": { + "$ref": "XPSConfidenceMetricsEntry", + "deprecated": true, + "description": "Values are at the highest F1 score on the precision-recall curve. Only confidence_threshold, recall, precision, and f1_score will be set." + }, + "confidenceMetricsEntries": { + "description": "If the enclosing EvaluationMetrics.label is empty, confidence_metrics_entries is an evaluation of the entire model across all labels. If the enclosing EvaluationMetrics.label is set, confidence_metrics_entries applies to that label.", + "items": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "type": "array" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the model, at the default confidence threshold (0.0). Only set for whole-model evaluation, not for evaluation per label." + }, + "perLabelConfidenceMetrics": { + "additionalProperties": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "deprecated": true, + "description": "Only recall, precision, and f1_score will be set.", + "type": "object" + } + }, + "type": "object" + }, + "XPSTextSentimentEvaluationMetrics": { + "description": "Model evaluation metrics for text sentiment problems.", + "id": "XPSTextSentimentEvaluationMetrics", + "properties": { + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Output only. Confusion matrix of the evaluation. Only set for the overall model evaluation, not for evaluation of a single annotation spec." + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "linearKappa": { + "description": "Output only. Linear weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "meanAbsoluteError": { + "description": "Output only. Mean absolute error. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "meanSquaredError": { + "description": "Output only. Mean squared error. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision.", + "format": "float", + "type": "number" + }, + "quadraticKappa": { + "description": "Output only. Quadratic weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTextToSpeechTrainResponse": { + "description": "TextToSpeech train response", + "id": "XPSTextToSpeechTrainResponse", + "properties": {}, + "type": "object" + }, + "XPSTextTrainResponse": { + "id": "XPSTextTrainResponse", + "properties": { + "componentModel": { + "description": "Component submodels.", + "items": { + "$ref": "XPSTextComponentModel" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTfJsFormat": { + "description": "A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.", + "id": "XPSTfJsFormat", + "properties": {}, + "type": "object" + }, + "XPSTfLiteFormat": { + "description": "LINT.IfChange A model format used for mobile and IoT devices. See https://www.tensorflow.org/lite.", + "id": "XPSTfLiteFormat", + "properties": {}, + "type": "object" + }, + "XPSTfSavedModelFormat": { + "description": "A tensorflow model format in SavedModel format.", + "id": "XPSTfSavedModelFormat", + "properties": {}, + "type": "object" + }, + "XPSTimestampStats": { + "description": "The data statistics of a series of TIMESTAMP values.", + "id": "XPSTimestampStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "granularStats": { + "additionalProperties": { + "$ref": "XPSTimestampStatsGranularStats" + }, + "description": "The string key is the pre-defined granularity. Currently supported: hour_of_day, day_of_week, month_of_year. Granularities finer that the granularity of timestamp data are not populated (e.g. if timestamps are at day granularity, then hour_of_day is not populated).", + "type": "object" + }, + "medianTimestampNanos": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTimestampStatsGranularStats": { + "description": "Stats split by a defined in context granularity.", + "id": "XPSTimestampStatsGranularStats", + "properties": { + "buckets": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "A map from granularity key to example count for that key. E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means May).", + "type": "object" + } + }, + "type": "object" + }, + "XPSTrackMetricsEntry": { + "description": "Track matching model metrics for a single track match threshold and multiple label match confidence thresholds. Next tag: 6.", + "id": "XPSTrackMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Output only. Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them.", + "items": { + "$ref": "XPSTrackMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "iouThreshold": { + "description": "Output only. The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry.", + "format": "float", + "type": "number" + }, + "meanBoundingBoxIou": { + "description": "Output only. The mean bounding box iou over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "meanMismatchRate": { + "description": "Output only. The mean mismatch rate over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "meanTrackingAveragePrecision": { + "description": "Output only. The mean average precision over all confidence thresholds.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTrackMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold. Next tag: 6.", + "id": "XPSTrackMetricsEntryConfidenceMetricsEntry", + "properties": { + "boundingBoxIou": { + "description": "Output only. Bounding box intersection-over-union precision. Measures how well the bounding boxes overlap between each other (e.g. complete overlap or just barely above iou_threshold).", + "format": "float", + "type": "number" + }, + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "mismatchRate": { + "description": "Output only. Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity.", + "format": "float", + "type": "number" + }, + "trackingPrecision": { + "description": "Output only. Tracking precision.", + "format": "float", + "type": "number" + }, + "trackingRecall": { + "description": "Output only. Tracking recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTrainResponse": { + "description": "Next ID: 18", + "id": "XPSTrainResponse", + "properties": { + "deployedModelSizeBytes": { + "description": "Estimated model size in bytes once deployed.", + "format": "int64", + "type": "string" + }, + "errorAnalysisConfigs": { + "description": "Optional vision model error analysis configuration. The field is set when model error analysis is enabled in the training request. The results of error analysis will be binded together with evaluation results (in the format of AnnotatedExample).", + "items": { + "$ref": "XPSVisionErrorAnalysisConfig" + }, + "type": "array" + }, + "evaluatedExampleSet": { + "$ref": "XPSExampleSet", + "description": "Examples used to evaluate the model (usually the test set), with the predicted annotations. The file_spec should point to recordio file(s) of AnnotatedExample. For each returned example, the example_id_token and annotations predicted by the model must be set. The example payload can and is recommended to be omitted." + }, + "evaluationMetricsSet": { + "$ref": "XPSEvaluationMetricsSet", + "description": "The trained model evaluation metrics. This can be optionally returned." + }, + "explanationConfigs": { + "deprecated": true, + "description": "VisionExplanationConfig for XAI on test set. Optional for when XAI is enable in training request.", + "items": { + "$ref": "XPSResponseExplanationSpec" + }, + "type": "array" + }, + "imageClassificationTrainResp": { + "$ref": "XPSImageClassificationTrainResponse" + }, + "imageObjectDetectionTrainResp": { + "$ref": "XPSImageObjectDetectionModelSpec" + }, + "imageSegmentationTrainResp": { + "$ref": "XPSImageSegmentationTrainResponse" + }, + "modelToken": { + "description": "Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model.", + "format": "byte", + "type": "string" + }, + "speechTrainResp": { + "$ref": "XPSSpeechModelSpec" + }, + "tablesTrainResp": { + "$ref": "XPSTablesTrainResponse" + }, + "textToSpeechTrainResp": { + "$ref": "XPSTextToSpeechTrainResponse" + }, + "textTrainResp": { + "$ref": "XPSTextTrainResponse", + "description": "Will only be needed for uCAIP from Beta." + }, + "translationTrainResp": { + "$ref": "XPSTranslationTrainResponse" + }, + "videoActionRecognitionTrainResp": { + "$ref": "XPSVideoActionRecognitionTrainResponse" + }, + "videoClassificationTrainResp": { + "$ref": "XPSVideoClassificationTrainResponse" + }, + "videoObjectTrackingTrainResp": { + "$ref": "XPSVideoObjectTrackingTrainResponse" + } + }, + "type": "object" + }, + "XPSTrainingObjectivePoint": { + "id": "XPSTrainingObjectivePoint", + "properties": { + "createTime": { + "description": "The time at which this point was recorded.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "The objective value when this point was recorded.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTranslationEvaluationMetrics": { + "description": "Evaluation metrics for the dataset.", + "id": "XPSTranslationEvaluationMetrics", + "properties": { + "baseBleuScore": { + "description": "BLEU score for base model.", + "format": "double", + "type": "number" + }, + "bleuScore": { + "description": "BLEU score.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTranslationPreprocessResponse": { + "description": "Translation preprocess response.", + "id": "XPSTranslationPreprocessResponse", + "properties": { + "parsedExampleCount": { + "description": "Total example count parsed.", + "format": "int64", + "type": "string" + }, + "validExampleCount": { + "description": "Total valid example count.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTranslationTrainResponse": { + "description": "Train response for translation.", + "id": "XPSTranslationTrainResponse", + "properties": { + "modelType": { + "description": "Type of the model.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "LEGACY", + "CURRENT" + ], + "enumDescriptions": [ + "Default", + "Legacy model. Will be deprecated.", + "Current model." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSTuningTrial": { + "description": "Metrics for a tuning job generated, will get forwarded to Stackdriver as model tuning logs. Setting this as a standalone message out of CreateModelMetadata to avoid confusion as we expose this message only to users.", + "id": "XPSTuningTrial", + "properties": { + "modelStructure": { + "$ref": "XPSTablesModelStructure", + "description": "Model parameters for the trial." + }, + "trainingObjectivePoint": { + "$ref": "XPSTrainingObjectivePoint", + "description": "The optimization objective evaluation of the eval split data." + } + }, + "type": "object" + }, + "XPSVideoActionMetricsEntry": { + "description": "The Evaluation metrics entry given a specific precision_window_length.", + "id": "XPSVideoActionMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSVideoActionMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + }, + "precisionWindowLength": { + "description": "This VideoActionMetricsEntry is calculated based on this prediction window length. If the predicted action's timestamp is inside the time window whose center is the ground truth action's timestamp with this specific length, the prediction result is treated as a true positive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoActionMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSVideoActionMetricsEntryConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSVideoActionRecognitionEvaluationMetrics": { + "description": "Model evaluation metrics for video action recognition.", + "id": "XPSVideoActionRecognitionEvaluationMetrics", + "properties": { + "evaluatedActionCount": { + "description": "Output only. The number of ground truth actions used to create this evaluation.", + "format": "int32", + "type": "integer" + }, + "videoActionMetricsEntries": { + "description": "Output only. The metric entries for precision window lengths: 1s,2s,3s,4s, 5s.", + "items": { + "$ref": "XPSVideoActionMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoActionRecognitionTrainResponse": { + "id": "XPSVideoActionRecognitionTrainResponse", + "properties": { + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoBatchPredictOperationMetadata": { + "id": "XPSVideoBatchPredictOperationMetadata", + "properties": { + "outputExamples": { + "description": "All the partial batch prediction results that are completed at the moment. Output examples are sorted by completion time. The order will not be changed. Each output example should be the path of a single RecordIO file of AnnotatedExamples.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoClassificationTrainResponse": { + "id": "XPSVideoClassificationTrainResponse", + "properties": { + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoExportModelSpec": { + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.", + "id": "XPSVideoExportModelSpec", + "properties": { + "exportModelOutputConfig": { + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "items": { + "$ref": "XPSExportModelOutputConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoModelArtifactSpec": { + "id": "XPSVideoModelArtifactSpec", + "properties": { + "exportArtifact": { + "description": "The model binary files in different formats for model export.", + "items": { + "$ref": "XPSModelArtifactItem" + }, + "type": "array" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. batch predict) via public Cloud AI Platform API." + } + }, + "type": "object" + }, + "XPSVideoObjectTrackingEvaluationMetrics": { + "description": "Model evaluation metrics for ObjectTracking problems. Next tag: 10.", + "id": "XPSVideoObjectTrackingEvaluationMetrics", + "properties": { + "boundingBoxMeanAveragePrecision": { + "description": "Output only. The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries.", + "format": "float", + "type": "number" + }, + "boundingBoxMetricsEntries": { + "description": "Output only. The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntry" + }, + "type": "array" + }, + "evaluatedBoundingboxCount": { + "description": "The number of bounding boxes used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "evaluatedFrameCount": { + "description": "The number of video frames used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "evaluatedTrackCount": { + "description": "The number of tracks used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "trackMeanAveragePrecision": { + "description": "Output only. The single metric for tracks accuracy evaluation: the mean_average_precision averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMeanBoundingBoxIou": { + "description": "Output only. The single metric for tracks bounding box iou evaluation: the mean_bounding_box_iou averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMeanMismatchRate": { + "description": "Output only. The single metric for tracking consistency evaluation: the mean_mismatch_rate averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMetricsEntries": { + "description": "Output only. The tracks match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSTrackMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoObjectTrackingTrainResponse": { + "id": "XPSVideoObjectTrackingTrainResponse", + "properties": { + "exportModelSpec": { + "$ref": "XPSVideoExportModelSpec", + "description": "Populated for AutoML request only." + }, + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoTrainingOperationMetadata": { + "id": "XPSVideoTrainingOperationMetadata", + "properties": { + "trainCostMilliNodeHour": { + "description": "This is an estimation of the node hours necessary for training a model, expressed in milli node hours (i.e. 1,000 value in this field means 1 node hour). A node hour represents the time a virtual machine spends running your training job. The cost of one node running for one hour is a node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVisionErrorAnalysisConfig": { + "description": "The vision model error analysis configuration. Next tag: 3", + "id": "XPSVisionErrorAnalysisConfig", + "properties": { + "exampleCount": { + "description": "The number of query examples in error analysis.", + "format": "int32", + "type": "integer" + }, + "queryType": { + "description": "The query type used in retrieval. The enum values are frozen in the foreseeable future.", + "enum": [ + "QUERY_TYPE_UNSPECIFIED", + "QUERY_TYPE_ALL_SIMILAR", + "QUERY_TYPE_SAME_CLASS_SIMILAR", + "QUERY_TYPE_SAME_CLASS_DISSIMILAR" + ], + "enumDescriptions": [ + "Unspecified query type for model error analysis.", + "Query similar samples across all classes in the dataset.", + "Query similar samples from the same class of the input sample.", + "Query dissimilar samples from the same class of the input sample." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSVisionTrainingOperationMetadata": { + "deprecated": true, + "id": "XPSVisionTrainingOperationMetadata", + "properties": { + "explanationUsage": { + "$ref": "InfraUsage", + "description": "Aggregated infra usage within certain time period, for billing report purpose if XAI is enable in training request." + } + }, + "type": "object" + }, + "XPSVisualization": { + "deprecated": true, + "description": "Visualization configurations for image explanation.", + "id": "XPSVisualization", + "properties": { + "clipPercentLowerbound": { + "description": "Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.", + "format": "float", + "type": "number" + }, + "clipPercentUpperbound": { + "description": "Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.", + "format": "float", + "type": "number" + }, + "colorMap": { + "description": "The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.", + "enum": [ + "COLOR_MAP_UNSPECIFIED", + "PINK_GREEN", + "VIRIDIS", + "RED", + "GREEN", + "RED_GREEN", + "PINK_WHITE_GREEN" + ], + "enumDescriptions": [ + "Should not be used.", + "Positive: green. Negative: pink.", + "Viridis color map: A perceptually uniform color mapping which is easier to see by those with colorblindness and progresses from yellow to green to blue. Positive: yellow. Negative: blue.", + "Positive: red. Negative: red.", + "Positive: green. Negative: green.", + "Positive: green. Negative: red.", + "PiYG palette." + ], + "type": "string" + }, + "overlayType": { + "description": "How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.", + "enum": [ + "OVERLAY_TYPE_UNSPECIFIED", + "NONE", + "ORIGINAL", + "GRAYSCALE", + "MASK_BLACK" + ], + "enumDescriptions": [ + "Default value. This is the same as NONE.", + "No overlay.", + "The attributions are shown on top of the original image.", + "The attributions are shown on top of grayscaled version of the original image.", + "The attributions are used as a mask to reveal predictive parts of the image and hide the un-predictive parts." + ], + "type": "string" + }, + "polarity": { + "description": "Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.", + "enum": [ + "POLARITY_UNSPECIFIED", + "POSITIVE", + "NEGATIVE", + "BOTH" + ], + "enumDescriptions": [ + "Default value. This is the same as POSITIVE.", + "Highlights the pixels/outlines that were most influential to the model's prediction.", + "Setting polarity to negative highlights areas that does not lead to the models's current prediction.", + "Shows both positive and negative attributions." + ], + "type": "string" + }, + "type": { + "description": "Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.", + "enum": [ + "TYPE_UNSPECIFIED", + "PIXELS", + "OUTLINES" + ], + "enumDescriptions": [ + "Should not be used.", + "Shows which pixel contributed to the image prediction.", + "Shows which region contributed to the image prediction by outlining the region." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSXpsOperationMetadata": { + "id": "XPSXpsOperationMetadata", + "properties": { + "exampleCount": { + "description": "Optional. XPS server can opt to provide example count of the long running operation (e.g. training, data importing, batch prediction).", + "format": "int64", + "type": "string" + }, + "reportingMetrics": { + "$ref": "XPSReportingMetrics", + "description": "Metrics for the operation. By the time the operation is terminated (whether succeeded or failed) as returned from XPS, AutoML BE assumes the metrics are finalized. AutoML BE transparently posts the metrics to Chemist if it's not empty, regardless of the response content or error type. If user is supposed to be charged in case of cancellation/error, this field should be set. In the case where the type of LRO doesn't require any billing, this field should be left unset." + }, + "tablesTrainingOperationMetadata": { + "$ref": "XPSTablesTrainingOperationMetadata" + }, + "videoBatchPredictOperationMetadata": { + "$ref": "XPSVideoBatchPredictOperationMetadata" + }, + "videoTrainingOperationMetadata": { + "$ref": "XPSVideoTrainingOperationMetadata" + }, + "visionTrainingOperationMetadata": { + "$ref": "XPSVisionTrainingOperationMetadata" + } + }, + "type": "object" + }, + "XPSXraiAttribution": { + "deprecated": true, + "description": "An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Only supports image Models (modality is IMAGE).", + "id": "XPSXraiAttribution", + "properties": { + "stepCount": { + "description": "The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/src/apis/language/v1.ts b/src/apis/language/v1.ts index 7e1ef16867d..d2935238235 100644 --- a/src/apis/language/v1.ts +++ b/src/apis/language/v1.ts @@ -251,7 +251,40 @@ export namespace language_v1 { /** * Required. The enabled features. */ - features?: Schema$Features; + features?: Schema$AnnotateTextRequestFeatures; + } + /** + * All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. + */ + export interface Schema$AnnotateTextRequestFeatures { + /** + * Optional. The model options to use for classification. Defaults to v1 options if not specified. Only used if `classify_text` is set to true. + */ + classificationModelOptions?: Schema$ClassificationModelOptions; + /** + * Classify the full document into categories. + */ + classifyText?: boolean | null; + /** + * Extract document-level sentiment. + */ + extractDocumentSentiment?: boolean | null; + /** + * Extract entities. + */ + extractEntities?: boolean | null; + /** + * Extract entities and their associated sentiment. + */ + extractEntitySentiment?: boolean | null; + /** + * Extract syntax information. + */ + extractSyntax?: boolean | null; + /** + * Moderate the document for harmful and sensitive categories. + */ + moderateText?: boolean | null; } /** * The text annotations response message. @@ -306,11 +339,24 @@ export namespace language_v1 { /** * Setting this field will use the V1 model and V1 content categories version. The V1 model is a legacy model; support for this will be discontinued in the future. */ - v1Model?: Schema$V1Model; + v1Model?: Schema$ClassificationModelOptionsV1Model; /** * Setting this field will use the V2 model with the appropriate content categories version. The V2 model is a better performing model. */ - v2Model?: Schema$V2Model; + v2Model?: Schema$ClassificationModelOptionsV2Model; + } + /** + * Options for the V1 model. + */ + export interface Schema$ClassificationModelOptionsV1Model {} + /** + * Options for the V2 model. + */ + export interface Schema$ClassificationModelOptionsV2Model { + /** + * The content categories used for classification. + */ + contentCategoriesVersion?: string | null; } /** * The document classification request message. @@ -334,6 +380,52 @@ export namespace language_v1 { */ categories?: Schema$ClassificationCategory[]; } + /** + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); \} public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); \} return resultBuilder.build(); \} // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; \} return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; \} static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; \} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; \} [result autorelease]; return result; \} // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); \} var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); \}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); \} resultBuilder.push(hexString); return resultBuilder.join(''); \}; // ... + */ + export interface Schema$Color { + /** + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). + */ + alpha?: number | null; + /** + * The amount of blue in the color as a value in the interval [0, 1]. + */ + blue?: number | null; + /** + * The amount of green in the color as a value in the interval [0, 1]. + */ + green?: number | null; + /** + * The amount of red in the color as a value in the interval [0, 1]. + */ + red?: number | null; + } + /** + * Metric for billing reports. + */ + export interface Schema$CpuMetric { + /** + * Required. Number of CPU cores. + */ + coreNumber?: string | null; + /** + * Required. Total seconds of core usage, e.g. 4. + */ + coreSec?: string | null; + /** + * Required. Type of cpu, e.g. N2. + */ + cpuType?: string | null; + /** + * Required. Machine spec, e.g. N1_STANDARD_4. + */ + machineSpec?: string | null; + /** + * Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\p{Ll\}\p{N\}]+ E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + */ + trackingLabels?: {[key: string]: string} | null; + } /** * Represents dependency parse tree information for a token. (For more information on dependency labels, see http://www.aclweb.org/anthology/P13-2017 */ @@ -347,6 +439,16 @@ export namespace language_v1 { */ label?: string | null; } + export interface Schema$DiskMetric { + /** + * Required. Type of Disk, e.g. REGIONAL_SSD. + */ + diskType?: string | null; + /** + * Required. Seconds of physical disk usage, e.g. 3600. + */ + gibSec?: string | null; + } /** * Represents the input to API methods. */ @@ -414,38 +516,48 @@ export namespace language_v1 { */ type?: string | null; } - /** - * All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. - */ - export interface Schema$Features { + export interface Schema$GpuMetric { /** - * Optional. The model options to use for classification. Defaults to v1 options if not specified. Only used if `classify_text` is set to true. + * Required. Seconds of GPU usage, e.g. 3600. */ - classificationModelOptions?: Schema$ClassificationModelOptions; + gpuSec?: string | null; /** - * Classify the full document into categories. + * Required. Type of GPU, e.g. NVIDIA_TESLA_V100. */ - classifyText?: boolean | null; + gpuType?: string | null; /** - * Extract document-level sentiment. + * Required. Machine spec, e.g. N1_STANDARD_4. */ - extractDocumentSentiment?: boolean | null; + machineSpec?: string | null; /** - * Extract entities. + * Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\p{Ll\}\p{N\}]+ E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" */ - extractEntities?: boolean | null; + trackingLabels?: {[key: string]: string} | null; + } + /** + * Infra Usage of billing metrics. Next ID: 6 + */ + export interface Schema$InfraUsage { /** - * Extract entities and their associated sentiment. + * Aggregated core metrics since requested start_time. */ - extractEntitySentiment?: boolean | null; + cpuMetrics?: Schema$CpuMetric[]; /** - * Extract syntax information. + * Aggregated persistent disk metrics since requested start_time. */ - extractSyntax?: boolean | null; + diskMetrics?: Schema$DiskMetric[]; /** - * Moderate the document for harmful and sensitive categories. + * Aggregated gpu metrics since requested start_time. */ - moderateText?: boolean | null; + gpuMetrics?: Schema$GpuMetric[]; + /** + * Aggregated ram metrics since requested start_time. + */ + ramMetrics?: Schema$RamMetric[]; + /** + * Aggregated tpu metrics since requested start_time. + */ + tpuMetrics?: Schema$TpuMetric[]; } /** * The document moderation request message. @@ -518,6 +630,28 @@ export namespace language_v1 { */ voice?: string | null; } + export interface Schema$RamMetric { + /** + * Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type to match billing metrics definition. + */ + gibSec?: string | null; + /** + * Required. Machine spec, e.g. N1_STANDARD_4. + */ + machineSpec?: string | null; + /** + * Required. VM memory in gb. + */ + memories?: number | null; + /** + * Required. Type of ram. + */ + ramType?: string | null; + /** + * Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\p{Ll\}\p{N\}]+ E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + */ + trackingLabels?: {[key: string]: string} | null; + } /** * Represents a sentence in the input document. */ @@ -595,18 +729,1906 @@ export namespace language_v1 { */ text?: Schema$TextSpan; } + export interface Schema$TpuMetric { + /** + * Required. Seconds of TPU usage, e.g. 3600. + */ + tpuSec?: string | null; + /** + * Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. + */ + tpuType?: string | null; + } /** - * Options for the V1 model. + * The data statistics of a series of ARRAY values. */ - export interface Schema$V1Model {} + export interface Schema$XPSArrayStats { + commonStats?: Schema$XPSCommonStats; + /** + * Stats of all the values of all arrays, as if they were a single long series of data. The type depends on the element type of the array. + */ + memberStats?: Schema$XPSDataStats; + } + export interface Schema$XPSBatchPredictResponse { + /** + * Examples for batch prediction result. Under full API implementation, results are stored in shared RecordIO of AnnotatedExample protobufs, the annotations field of which is populated by XPS backend. + */ + exampleSet?: Schema$XPSExampleSet; + } /** - * Options for the V2 model. + * Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds. */ - export interface Schema$V2Model { + export interface Schema$XPSBoundingBoxMetricsEntry { /** - * The content categories used for classification. + * Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. */ - contentCategoriesVersion?: string | null; + confidenceMetricsEntries?: Schema$XPSBoundingBoxMetricsEntryConfidenceMetricsEntry[]; + /** + * The intersection-over-union threshold value used to compute this metrics entry. + */ + iouThreshold?: number | null; + /** + * The mean average precision. + */ + meanAveragePrecision?: number | null; + } + /** + * Metrics for a single confidence threshold. + */ + export interface Schema$XPSBoundingBoxMetricsEntryConfidenceMetricsEntry { + /** + * The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * The harmonic mean of recall and precision. + */ + f1Score?: number | null; + /** + * Precision for the given confidence threshold. + */ + precision?: number | null; + /** + * Recall for the given confidence threshold. + */ + recall?: number | null; + } + /** + * The data statistics of a series of CATEGORY values. + */ + export interface Schema$XPSCategoryStats { + commonStats?: Schema$XPSCommonStats; + /** + * The statistics of the top 20 CATEGORY values, ordered by CategoryStats.SingleCategoryStats.count. + */ + topCategoryStats?: Schema$XPSCategoryStatsSingleCategoryStats[]; + } + /** + * The statistics of a single CATEGORY value. + */ + export interface Schema$XPSCategoryStatsSingleCategoryStats { + /** + * The number of occurrences of this value in the series. + */ + count?: string | null; + /** + * The CATEGORY value. + */ + value?: string | null; + } + /** + * Model evaluation metrics for classification problems. It can be used for image and video classification. Next tag: 9. + */ + export interface Schema$XPSClassificationEvaluationMetrics { + /** + * The Area under precision recall curve metric. + */ + auPrc?: number | null; + /** + * The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation. + */ + auRoc?: number | null; + /** + * The Area under precision recall curve metric based on priors. + */ + baseAuPrc?: number | null; + /** + * Metrics that have confidence thresholds. Precision-recall curve can be derived from it. + */ + confidenceMetricsEntries?: Schema$XPSConfidenceMetricsEntry[]; + /** + * Confusion matrix of the evaluation. Only set for MULTICLASS classification problems where number of annotation specs is no more than 10. Only set for model level evaluation, not for evaluation per label. + */ + confusionMatrix?: Schema$XPSConfusionMatrix; + /** + * The number of examples used for model evaluation. + */ + evaluatedExamplesCount?: number | null; + /** + * The Log Loss metric. + */ + logLoss?: number | null; + } + /** + * Map from color to display name. Will only be used by Image Segmentation for uCAIP. + */ + export interface Schema$XPSColorMap { + /** + * Should be used during training. + */ + annotationSpecIdToken?: string | null; + /** + * This type is deprecated in favor of the IntColor below. This is because google.type.Color represent color has a float which semantically does not reflect discrete classes/categories concept. Moreover, to handle it well we need to have some tolerance when converting to a discretized color. As such, the recommendation is to have API surface still use google.type.Color while internally IntColor is used. + */ + color?: Schema$Color; + /** + * Should be used during preprocessing. + */ + displayName?: string | null; + intColor?: Schema$XPSColorMapIntColor; + } + /** + * RGB color and each channel is represented by an integer. + */ + export interface Schema$XPSColorMapIntColor { + /** + * The value should be in range of [0, 255]. + */ + blue?: number | null; + /** + * The value should be in range of [0, 255]. + */ + green?: number | null; + /** + * The value should be in range of [0, 255]. + */ + red?: number | null; + } + export interface Schema$XPSColumnSpec { + /** + * The unique id of the column. When Preprocess, the Tables BE will popuate the order id of the column, which reflects the order of the column inside the table, i.e. 0 means the first column in the table, N-1 means the last column. AutoML BE will persist this order id in Spanner and set the order id here when calling RefreshTablesStats and Train. Note: it's different than the column_spec_id that is generated in AutoML BE. + */ + columnId?: number | null; + /** + * The data stats of the column. It's outputed in RefreshTablesStats and a required input for Train. + */ + dataStats?: Schema$XPSDataStats; + /** + * The data type of the column. It's outputed in Preprocess rpc and a required input for RefreshTablesStats and Train. + */ + dataType?: Schema$XPSDataType; + /** + * The display name of the column. It's outputed in Preprocess and a required input for RefreshTablesStats and Train. + */ + displayName?: string | null; + forecastingMetadata?: Schema$XPSColumnSpecForecastingMetadata; + /** + * It's outputed in RefreshTablesStats, and a required input in Train. + */ + topCorrelatedColumns?: Schema$XPSColumnSpecCorrelatedColumn[]; + } + /** + * Identifies a table's column, and its correlation with the column this ColumnSpec describes. + */ + export interface Schema$XPSColumnSpecCorrelatedColumn { + columnId?: number | null; + correlationStats?: Schema$XPSCorrelationStats; + } + /** + * =========================================================================== # The fields below are used exclusively for Forecasting. + */ + export interface Schema$XPSColumnSpecForecastingMetadata { + /** + * The type of the column for FORECASTING model training purposes. + */ + columnType?: string | null; + } + /** + * Common statistics for a column with a specified data type. + */ + export interface Schema$XPSCommonStats { + distinctValueCount?: string | null; + nullValueCount?: string | null; + validValueCount?: string | null; + } + /** + * ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. Next tag: 16. + */ + export interface Schema$XPSConfidenceMetricsEntry { + /** + * Metrics are computed with an assumption that the model never return predictions with score lower than this value. + */ + confidenceThreshold?: number | null; + /** + * The harmonic mean of recall and precision. + */ + f1Score?: number | null; + /** + * The harmonic mean of recall_at1 and precision_at1. + */ + f1ScoreAt1?: number | null; + /** + * The number of ground truth labels that are not matched by a model created label. + */ + falseNegativeCount?: string | null; + /** + * The number of model created labels that do not match a ground truth label. + */ + falsePositiveCount?: string | null; + /** + * False Positive Rate for the given confidence threshold. + */ + falsePositiveRate?: number | null; + /** + * The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example. + */ + falsePositiveRateAt1?: number | null; + /** + * Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold. + */ + positionThreshold?: number | null; + /** + * Precision for the given confidence threshold. + */ + precision?: number | null; + /** + * The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example. + */ + precisionAt1?: number | null; + /** + * Recall (true positive rate) for the given confidence threshold. + */ + recall?: number | null; + /** + * The recall (true positive rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example. + */ + recallAt1?: number | null; + /** + * The number of labels that were not created by the model, but if they would, they would not match a ground truth label. + */ + trueNegativeCount?: string | null; + /** + * The number of model created labels that match a ground truth label. + */ + truePositiveCount?: string | null; + } + /** + * Confusion matrix of the model running the classification. + */ + export interface Schema$XPSConfusionMatrix { + /** + * For the following three repeated fields, only one is intended to be set. annotation_spec_id_token is preferable to be set. ID tokens of the annotation specs used in the confusion matrix. + */ + annotationSpecIdToken?: string[] | null; + /** + * Category (mainly for segmentation). Set only for image segmentation models. Note: uCAIP Image Segmentation should use annotation_spec_id_token. + */ + category?: number[] | null; + /** + * Rows in the confusion matrix. The number of rows is equal to the size of `annotation_spec_id_token`. `row[i].value[j]` is the number of examples that have ground truth of the `annotation_spec_id_token[i]` and are predicted as `annotation_spec_id_token[j]` by the model being evaluated. + */ + row?: Schema$XPSConfusionMatrixRow[]; + /** + * Sentiment labels used in the confusion matrix. Set only for text sentiment models. For AutoML Text Revamp, use `annotation_spec_id_token` instead and leave this field empty. + */ + sentimentLabel?: number[] | null; + } + /** + * A row in the confusion matrix. + */ + export interface Schema$XPSConfusionMatrixRow { + /** + * Same as above except intended to represent other counts (for e.g. for segmentation this is pixel count). NOTE(params): Only example_count or count is set (oneoff does not support repeated fields unless they are embedded inside another message). + */ + count?: string[] | null; + /** + * Value of the specific cell in the confusion matrix. The number of values each row has (i.e. the length of the row) is equal to the length of the annotation_spec_id_token field. + */ + exampleCount?: number[] | null; + } + /** + * A model format used for iOS mobile devices. + */ + export interface Schema$XPSCoreMlFormat {} + /** + * A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same. + */ + export interface Schema$XPSCorrelationStats { + /** + * The correlation value using the Cramer's V measure. + */ + cramersV?: number | null; + } + /** + * Different types of errors and the stats associatesd with each error. + */ + export interface Schema$XPSDataErrors { + /** + * Number of records having errors associated with the enum. + */ + count?: number | null; + /** + * Type of the error. + */ + errorType?: string | null; + } + /** + * The data statistics of a series of values that share the same DataType. + */ + export interface Schema$XPSDataStats { + /** + * The statistics for ARRAY DataType. + */ + arrayStats?: Schema$XPSArrayStats; + /** + * The statistics for CATEGORY DataType. + */ + categoryStats?: Schema$XPSCategoryStats; + /** + * The number of distinct values. + */ + distinctValueCount?: string | null; + /** + * The statistics for FLOAT64 DataType. + */ + float64Stats?: Schema$XPSFloat64Stats; + /** + * The number of values that are null. + */ + nullValueCount?: string | null; + /** + * The statistics for STRING DataType. + */ + stringStats?: Schema$XPSStringStats; + /** + * The statistics for STRUCT DataType. + */ + structStats?: Schema$XPSStructStats; + /** + * The statistics for TIMESTAMP DataType. + */ + timestampStats?: Schema$XPSTimestampStats; + /** + * The number of values that are valid. + */ + validValueCount?: string | null; + } + /** + * Indicated the type of data that can be stored in a structured data entity (e.g. a table). + */ + export interface Schema$XPSDataType { + /** + * The highly compatible data types to this data type. + */ + compatibleDataTypes?: Schema$XPSDataType[]; + /** + * If type_code == ARRAY, then `list_element_type` is the type of the elements. + */ + listElementType?: Schema$XPSDataType; + /** + * If true, this DataType can also be `null`. + */ + nullable?: boolean | null; + /** + * If type_code == STRUCT, then `struct_type` provides type information for the struct's fields. + */ + structType?: Schema$XPSStructType; + /** + * If type_code == TIMESTAMP then `time_format` provides the format in which that time field is expressed. The time_format must be written in `strftime` syntax. If time_format is not set, then the default format as described on the field is used. + */ + timeFormat?: string | null; + /** + * Required. The TypeCode for this type. + */ + typeCode?: string | null; + } + /** + * A model format used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system. + */ + export interface Schema$XPSDockerFormat { + /** + * Optional. Additional cpu information describing the requirements for the to be exported model files. + */ + cpuArchitecture?: string | null; + /** + * Optional. Additional gpu information describing the requirements for the to be exported model files. + */ + gpuArchitecture?: string | null; + } + /** + * A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. + */ + export interface Schema$XPSEdgeTpuTfLiteFormat {} + /** + * Contains xPS-specific model evaluation metrics either for a single annotation spec (label), or for the model overall. Next tag: 18. + */ + export interface Schema$XPSEvaluationMetrics { + /** + * The annotation_spec for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The value comes from the input annotations in AnnotatedExample. For MVP product or for text sentiment models where annotation_spec_id_token is not available, set label instead. + */ + annotationSpecIdToken?: string | null; + /** + * The integer category label for which this evaluation metric instance had been created. Valid categories are 0 or higher. Overall model evaluation should set this to negative values (rather than implicit zero). Only used for Image Segmentation (prefer to set annotation_spec_id_token instead). Note: uCAIP Image Segmentation should use annotation_spec_id_token. + */ + category?: number | null; + /** + * The number of examples used to create this evaluation metrics instance. + */ + evaluatedExampleCount?: number | null; + imageClassificationEvalMetrics?: Schema$XPSClassificationEvaluationMetrics; + imageObjectDetectionEvalMetrics?: Schema$XPSImageObjectDetectionEvaluationMetrics; + imageSegmentationEvalMetrics?: Schema$XPSImageSegmentationEvaluationMetrics; + /** + * The label for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The label maps to AnnotationSpec.display_name in Public API protos. Only used by MVP implementation and text sentiment FULL implementation. + */ + label?: string | null; + regressionEvalMetrics?: Schema$XPSRegressionEvaluationMetrics; + tablesClassificationEvalMetrics?: Schema$XPSClassificationEvaluationMetrics; + tablesEvalMetrics?: Schema$XPSTablesEvaluationMetrics; + textClassificationEvalMetrics?: Schema$XPSClassificationEvaluationMetrics; + textExtractionEvalMetrics?: Schema$XPSTextExtractionEvaluationMetrics; + textSentimentEvalMetrics?: Schema$XPSTextSentimentEvaluationMetrics; + translationEvalMetrics?: Schema$XPSTranslationEvaluationMetrics; + videoActionRecognitionEvalMetrics?: Schema$XPSVideoActionRecognitionEvaluationMetrics; + videoClassificationEvalMetrics?: Schema$XPSClassificationEvaluationMetrics; + videoObjectTrackingEvalMetrics?: Schema$XPSVideoObjectTrackingEvaluationMetrics; + } + /** + * Specifies location of model evaluation metrics. + */ + export interface Schema$XPSEvaluationMetricsSet { + /** + * Inline EvaluationMetrics - should be relatively small. For passing large quantities of exhaustive metrics, use file_spec. + */ + evaluationMetrics?: Schema$XPSEvaluationMetrics[]; + /** + * File spec containing evaluation metrics of a model, must point to RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics messages. + */ + fileSpec?: Schema$XPSFileSpec; + /** + * Number of the evaluation metrics (usually one per label plus overall). + */ + numEvaluationMetrics?: string | null; + } + /** + * Set of examples or input sources. + */ + export interface Schema$XPSExampleSet { + /** + * File spec of the examples or input sources. + */ + fileSpec?: Schema$XPSFileSpec; + /** + * Fingerprint of the example set. + */ + fingerprint?: string | null; + /** + * Number of examples. + */ + numExamples?: string | null; + /** + * Number of input sources. + */ + numInputSources?: string | null; + } + export interface Schema$XPSExportModelOutputConfig { + coreMlFormat?: Schema$XPSCoreMlFormat; + dockerFormat?: Schema$XPSDockerFormat; + edgeTpuTfLiteFormat?: Schema$XPSEdgeTpuTfLiteFormat; + /** + * For any model and format: If true, will additionally export FirebaseExportedModelInfo in a firebase.txt file. + */ + exportFirebaseAuxiliaryInfo?: boolean | null; + /** + * The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER. + */ + outputGcrUri?: string | null; + /** + * The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory + */ + outputGcsUri?: string | null; + tfJsFormat?: Schema$XPSTfJsFormat; + tfLiteFormat?: Schema$XPSTfLiteFormat; + tfSavedModelFormat?: Schema$XPSTfSavedModelFormat; + } + /** + * Spec of input and output files, on external file systems (CNS, GCS, etc). + */ + export interface Schema$XPSFileSpec { + /** + * Deprecated. Use file_spec. + */ + directoryPath?: string | null; + fileFormat?: string | null; + /** + * Single file path, or file pattern of format "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and /cns/cell-d/somewhere/file-00001-of-00002. + */ + fileSpec?: string | null; + /** + * Deprecated. Use file_spec. + */ + singleFilePath?: string | null; + } + /** + * The data statistics of a series of FLOAT64 values. + */ + export interface Schema$XPSFloat64Stats { + commonStats?: Schema$XPSCommonStats; + /** + * Histogram buckets of the data series. Sorted by the min value of the bucket, ascendingly, and the number of the buckets is dynamically generated. The buckets are non-overlapping and completely cover whole FLOAT64 range with min of first bucket being `"-Infinity"`, and max of the last one being `"Infinity"`. + */ + histogramBuckets?: Schema$XPSFloat64StatsHistogramBucket[]; + /** + * The mean of the series. + */ + mean?: number | null; + /** + * Ordered from 0 to k k-quantile values of the data series of n values. The value at index i is, approximately, the i*n/k-th smallest value in the series; for i = 0 and i = k these are, respectively, the min and max values. + */ + quantiles?: number[] | null; + /** + * The standard deviation of the series. + */ + standardDeviation?: number | null; + } + /** + * A bucket of a histogram. + */ + export interface Schema$XPSFloat64StatsHistogramBucket { + /** + * The number of data values that are in the bucket, i.e. are between min and max values. + */ + count?: string | null; + /** + * The maximum value of the bucket, exclusive unless max = `"Infinity"`, in which case it's inclusive. + */ + max?: number | null; + /** + * The minimum value of the bucket, inclusive. + */ + min?: number | null; + } + export interface Schema$XPSImageClassificationTrainResponse { + /** + * Total number of classes. + */ + classCount?: string | null; + /** + * Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Populated for AutoMl requests. + */ + exportModelSpec?: Schema$XPSImageExportModelSpec; + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSImageModelArtifactSpec; + modelServingSpec?: Schema$XPSImageModelServingSpec; + /** + * Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + */ + stopReason?: string | null; + /** + * The actual cost to create this model. - For edge type model, the cost is expressed in node hour. - For cloud type model,the cost is expressed in compute hour. - Populated for models created before GA. To be deprecated after GA. + */ + trainCostInNodeTime?: string | null; + /** + * The actual training cost, expressed in node seconds. Populated for models trained in node time. + */ + trainCostNodeSeconds?: string | null; + } + /** + * Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format. + */ + export interface Schema$XPSImageExportModelSpec { + /** + * Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files. + */ + exportModelOutputConfig?: Schema$XPSExportModelOutputConfig[]; + } + /** + * Stores the locations and related metadata of the model artifacts. Populated for uCAIP requests only. + */ + export interface Schema$XPSImageModelArtifactSpec { + /** + * The Tensorflow checkpoint files. e.g. Used for resumable training. + */ + checkpointArtifact?: Schema$XPSModelArtifactItem; + /** + * The model binary files in different formats for model export. + */ + exportArtifact?: Schema$XPSModelArtifactItem[]; + /** + * GCS uri of decoded labels file for model export 'dict.txt'. + */ + labelGcsUri?: string | null; + /** + * The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API. + */ + servingArtifact?: Schema$XPSModelArtifactItem; + /** + * GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated. + */ + tfJsBinaryGcsPrefix?: string | null; + /** + * GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. + */ + tfLiteMetadataGcsUri?: string | null; + } + /** + * Serving specification for image models. + */ + export interface Schema$XPSImageModelServingSpec { + /** + * Populate under uCAIP request scope. + */ + modelThroughputEstimation?: Schema$XPSImageModelServingSpecModelThroughputEstimation[]; + /** + * An estimated value of how much traffic a node can serve. Populated for AutoMl request only. + */ + nodeQps?: number | null; + /** + * ## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list + */ + tfRuntimeVersion?: string | null; + } + export interface Schema$XPSImageModelServingSpecModelThroughputEstimation { + computeEngineAcceleratorType?: string | null; + /** + * Estimated latency. + */ + latencyInMilliseconds?: number | null; + /** + * The approximate qps a deployed node can serve. + */ + nodeQps?: number | null; + servomaticPartitionType?: string | null; + } + /** + * Model evaluation metrics for image object detection problems. Evaluates prediction quality of labeled bounding boxes. + */ + export interface Schema$XPSImageObjectDetectionEvaluationMetrics { + /** + * The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries. + */ + boundingBoxMeanAveragePrecision?: number | null; + /** + * The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + */ + boundingBoxMetricsEntries?: Schema$XPSBoundingBoxMetricsEntry[]; + /** + * The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had. + */ + evaluatedBoundingBoxCount?: number | null; + } + export interface Schema$XPSImageObjectDetectionModelSpec { + /** + * Total number of classes. + */ + classCount?: string | null; + exportModelSpec?: Schema$XPSImageExportModelSpec; + /** + * Max number of bounding box. + */ + maxBoundingBoxCount?: string | null; + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSImageModelArtifactSpec; + modelServingSpec?: Schema$XPSImageModelServingSpec; + /** + * Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. + */ + stopReason?: string | null; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + /** + * Model evaluation metrics for image segmentation problems. Next tag: 4. + */ + export interface Schema$XPSImageSegmentationEvaluationMetrics { + /** + * Metrics that have confidence thresholds. Precision-recall curve can be derived from it. + */ + confidenceMetricsEntries?: Schema$XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry[]; + } + /** + * Metrics for a single confidence threshold. + */ + export interface Schema$XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry { + /** + * The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * Confusion matrix of the per confidence_threshold evaluation. Pixel counts are set here. Only set for model level evaluation, not for evaluation per label. + */ + confusionMatrix?: Schema$XPSConfusionMatrix; + /** + * DSC or the F1 score: The harmonic mean of recall and precision. + */ + diceScoreCoefficient?: number | null; + /** + * IOU score. + */ + iouScore?: number | null; + /** + * Precision for the given confidence threshold. + */ + precision?: number | null; + /** + * Recall for the given confidence threshold. + */ + recall?: number | null; + } + export interface Schema$XPSImageSegmentationTrainResponse { + /** + * Color map of the model. + */ + colorMaps?: Schema$XPSColorMap[]; + /** + * NOTE: These fields are not used/needed in EAP but will be set later. + */ + exportModelSpec?: Schema$XPSImageExportModelSpec; + /** + * ## The fields below are only populated under uCAIP request scope. Model artifact spec stores and model gcs pathes and related metadata + */ + modelArtifactSpec?: Schema$XPSImageModelArtifactSpec; + modelServingSpec?: Schema$XPSImageModelServingSpec; + /** + * Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. + */ + stopReason?: string | null; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + /** + * An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 + */ + export interface Schema$XPSIntegratedGradientsAttribution { + /** + * The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively. + */ + stepCount?: number | null; + } + export interface Schema$XPSMetricEntry { + /** + * For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise leave empty. + */ + argentumMetricId?: string | null; + /** + * A double value. + */ + doubleValue?: number | null; + /** + * A signed 64-bit integer value. + */ + int64Value?: string | null; + /** + * The metric name defined in the service configuration. + */ + metricName?: string | null; + /** + * Billing system labels for this (metric, value) pair. + */ + systemLabels?: Schema$XPSMetricEntryLabel[]; + } + export interface Schema$XPSMetricEntryLabel { + /** + * The name of the label. + */ + labelName?: string | null; + /** + * The value of the label. + */ + labelValue?: string | null; + } + /** + * A single model artifact item. + */ + export interface Schema$XPSModelArtifactItem { + /** + * The model artifact format. + */ + artifactFormat?: string | null; + /** + * The Google Cloud Storage (GCS) uri that stores the model binary files. + */ + gcsUri?: string | null; + } + /** + * Next ID: 8 + */ + export interface Schema$XPSPreprocessResponse { + /** + * Preprocessed examples, that are to be imported into AutoML storage. This should point to RecordIO file(s) of PreprocessedExample messages. The PreprocessedExample.mvp_training_data-s returned here are later verbatim passed to Train() call in TrainExample.mvp_training_data. + */ + outputExampleSet?: Schema$XPSExampleSet; + speechPreprocessResp?: Schema$XPSSpeechPreprocessResponse; + tablesPreprocessResponse?: Schema$XPSTablesPreprocessResponse; + translationPreprocessResp?: Schema$XPSTranslationPreprocessResponse; + } + /** + * Model evaluation metrics for regression problems. It can be used for Tables. + */ + export interface Schema$XPSRegressionEvaluationMetrics { + /** + * Mean Absolute Error (MAE). + */ + meanAbsoluteError?: number | null; + /** + * Mean absolute percentage error. Only set if all ground truth values are positive. + */ + meanAbsolutePercentageError?: number | null; + /** + * A list of actual versus predicted points for the model being evaluated. + */ + regressionMetricsEntries?: Schema$XPSRegressionMetricsEntry[]; + /** + * Root Mean Squared Error (RMSE). + */ + rootMeanSquaredError?: number | null; + /** + * Root mean squared log error. + */ + rootMeanSquaredLogError?: number | null; + /** + * R squared. + */ + rSquared?: number | null; + } + /** + * A pair of actual & observed values for the model being evaluated. + */ + export interface Schema$XPSRegressionMetricsEntry { + /** + * The observed value for a row in the dataset. + */ + predictedValue?: number | null; + /** + * The actual target value for a row in the dataset. + */ + trueValue?: number | null; + } + export interface Schema$XPSReportingMetrics { + /** + * The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set. + */ + effectiveTrainingDuration?: string | null; + /** + * One entry per metric name. The values must be aggregated per metric name. + */ + metricEntries?: Schema$XPSMetricEntry[]; + } + export interface Schema$XPSResponseExplanationMetadata { + /** + * Metadata of the input. + */ + inputs?: { + [key: string]: Schema$XPSResponseExplanationMetadataInputMetadata; + } | null; + /** + * Metadata of the output. + */ + outputs?: { + [key: string]: Schema$XPSResponseExplanationMetadataOutputMetadata; + } | null; + } + /** + * Metadata of the input of a feature. + */ + export interface Schema$XPSResponseExplanationMetadataInputMetadata { + /** + * Name of the input tensor for this model. Only needed in train response. + */ + inputTensorName?: string | null; + /** + * Modality of the feature. Valid values are: numeric, image. Defaults to numeric. + */ + modality?: string | null; + /** + * Visualization configurations for image explanation. + */ + visualizationConfig?: Schema$XPSVisualization; + } + /** + * Metadata of the prediction output to be explained. + */ + export interface Schema$XPSResponseExplanationMetadataOutputMetadata { + /** + * Name of the output tensor. Only needed in train response. + */ + outputTensorName?: string | null; + } + export interface Schema$XPSResponseExplanationParameters { + /** + * An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 + */ + integratedGradientsAttribution?: Schema$XPSIntegratedGradientsAttribution; + /** + * An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead. + */ + xraiAttribution?: Schema$XPSXraiAttribution; + } + /** + * Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context. + */ + export interface Schema$XPSResponseExplanationSpec { + /** + * Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai` + */ + explanationType?: string | null; + /** + * Metadata describing the Model's input and output for explanation. + */ + metadata?: Schema$XPSResponseExplanationMetadata; + /** + * Parameters that configure explaining of the Model's predictions. + */ + parameters?: Schema$XPSResponseExplanationParameters; + } + export interface Schema$XPSRow { + /** + * The ids of the columns. Note: The below `values` field must match order of this field, if this field is set. + */ + columnIds?: number[] | null; + /** + * The values of the row cells, given in the same order as the column_ids. If column_ids is not set, then in the same order as the input_feature_column_ids in TablesModelMetadata. + */ + values?: any[] | null; + } + export interface Schema$XPSSpeechEvaluationMetrics { + /** + * Evaluation metrics for all submodels contained in this model. + */ + subModelEvaluationMetrics?: Schema$XPSSpeechEvaluationMetricsSubModelEvaluationMetric[]; + } + export interface Schema$XPSSpeechEvaluationMetricsSubModelEvaluationMetric { + /** + * Type of the biasing model. + */ + biasingModelType?: string | null; + /** + * If true then it means we have an enhanced version of the biasing models. + */ + isEnhancedModel?: boolean | null; + numDeletions?: number | null; + numInsertions?: number | null; + numSubstitutions?: number | null; + /** + * Number of utterances used in the wer computation. + */ + numUtterances?: number | null; + /** + * Number of words over which the word error rate was computed. + */ + numWords?: number | null; + /** + * Below fields are used for debugging purposes + */ + sentenceAccuracy?: number | null; + /** + * Word error rate (standard error metric used for speech recognition). + */ + wer?: number | null; + } + export interface Schema$XPSSpeechModelSpec { + /** + * Required for speech xps backend. Speech xps has to use dataset_id and model_id as the primary key in db so that speech API can query the db directly. + */ + datasetId?: string | null; + language?: string | null; + /** + * Model specs for all submodels contained in this model. + */ + subModelSpecs?: Schema$XPSSpeechModelSpecSubModelSpec[]; + } + export interface Schema$XPSSpeechModelSpecSubModelSpec { + /** + * Type of the biasing model. + */ + biasingModelType?: string | null; + /** + * In S3, Recognition ClientContextId.client_id + */ + clientId?: string | null; + /** + * In S3, Recognition ClientContextId.context_id + */ + contextId?: string | null; + /** + * If true then it means we have an enhanced version of the biasing models. + */ + isEnhancedModel?: boolean | null; + } + export interface Schema$XPSSpeechPreprocessResponse { + /** + * Location od shards of sstables (test data) of DataUtterance protos. + */ + cnsTestDataPath?: string | null; + /** + * Location of shards of sstables (training data) of DataUtterance protos. + */ + cnsTrainDataPath?: string | null; + /** + * The metrics for prebuilt speech models. They are included here because there is no prebuilt speech models stored in the AutoML. + */ + prebuiltModelEvaluationMetrics?: Schema$XPSSpeechEvaluationMetrics; + /** + * Stats associated with the data. + */ + speechPreprocessStats?: Schema$XPSSpeechPreprocessStats; + } + export interface Schema$XPSSpeechPreprocessStats { + /** + * Different types of data errors and the counts associated with them. + */ + dataErrors?: Schema$XPSDataErrors[]; + /** + * The number of rows marked HUMAN_LABELLED + */ + numHumanLabeledExamples?: number | null; + /** + * The number of samples found in the previously recorded logs data. + */ + numLogsExamples?: number | null; + /** + * The number of rows marked as MACHINE_TRANSCRIBED + */ + numMachineTranscribedExamples?: number | null; + /** + * The number of examples labelled as TEST by Speech xps server. + */ + testExamplesCount?: number | null; + /** + * The number of sentences in the test data set. + */ + testSentencesCount?: number | null; + /** + * The number of words in the test data set. + */ + testWordsCount?: number | null; + /** + * The number of examples labeled as TRAIN by Speech xps server. + */ + trainExamplesCount?: number | null; + /** + * The number of sentences in the training data set. + */ + trainSentencesCount?: number | null; + /** + * The number of words in the training data set. + */ + trainWordsCount?: number | null; + } + /** + * The data statistics of a series of STRING values. + */ + export interface Schema$XPSStringStats { + commonStats?: Schema$XPSCommonStats; + /** + * The statistics of the top 20 unigrams, ordered by StringStats.UnigramStats.count. + */ + topUnigramStats?: Schema$XPSStringStatsUnigramStats[]; + } + /** + * The statistics of a unigram. + */ + export interface Schema$XPSStringStatsUnigramStats { + /** + * The number of occurrences of this unigram in the series. + */ + count?: string | null; + /** + * The unigram. + */ + value?: string | null; + } + /** + * The data statistics of a series of STRUCT values. + */ + export interface Schema$XPSStructStats { + commonStats?: Schema$XPSCommonStats; + /** + * Map from a field name of the struct to data stats aggregated over series of all data in that field across all the structs. + */ + fieldStats?: {[key: string]: Schema$XPSDataStats} | null; + } + /** + * `StructType` defines the DataType-s of a STRUCT type. + */ + export interface Schema$XPSStructType { + /** + * Unordered map of struct field names to their data types. + */ + fields?: {[key: string]: Schema$XPSDataType} | null; + } + /** + * Metrics for Tables classification problems. + */ + export interface Schema$XPSTablesClassificationMetrics { + /** + * Metrics building a curve. + */ + curveMetrics?: Schema$XPSTablesClassificationMetricsCurveMetrics[]; + } + /** + * Metrics curve data point for a single value. + */ + export interface Schema$XPSTablesClassificationMetricsCurveMetrics { + /** + * The area under the precision-recall curve. + */ + aucPr?: number | null; + /** + * The area under receiver operating characteristic curve. + */ + aucRoc?: number | null; + /** + * Metrics that have confidence thresholds. Precision-recall curve and ROC curve can be derived from them. + */ + confidenceMetricsEntries?: Schema$XPSTablesConfidenceMetricsEntry[]; + /** + * The Log loss metric. + */ + logLoss?: number | null; + /** + * The position threshold value used to compute the metrics. + */ + positionThreshold?: number | null; + /** + * The CATEGORY row value (for ARRAY unnested) the curve metrics are for. + */ + value?: string | null; + } + /** + * Metrics for a single confidence threshold. + */ + export interface Schema$XPSTablesConfidenceMetricsEntry { + /** + * The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * The harmonic mean of recall and precision. (2 * precision * recall) / (precision + recall) + */ + f1Score?: number | null; + /** + * False negative count. + */ + falseNegativeCount?: string | null; + /** + * False positive count. + */ + falsePositiveCount?: string | null; + /** + * FPR = #false positives / (#false positives + #true negatives) + */ + falsePositiveRate?: number | null; + /** + * Precision = #true positives / (#true positives + #false positives). + */ + precision?: number | null; + /** + * Recall = #true positives / (#true positives + #false negatives). + */ + recall?: number | null; + /** + * True negative count. + */ + trueNegativeCount?: string | null; + /** + * True positive count. + */ + truePositiveCount?: string | null; + /** + * TPR = #true positives / (#true positives + #false negatvies) + */ + truePositiveRate?: number | null; + } + /** + * Metadata for a dataset used for AutoML Tables. Next ID: 6 + */ + export interface Schema$XPSTablesDatasetMetadata { + /** + * Id the column to split the table. + */ + mlUseColumnId?: number | null; + /** + * Primary table. + */ + primaryTableSpec?: Schema$XPSTableSpec; + /** + * (the column id : its CorrelationStats with target column). + */ + targetColumnCorrelations?: { + [key: string]: Schema$XPSCorrelationStats; + } | null; + /** + * Id of the primary table column that should be used as the training label. + */ + targetColumnId?: number | null; + /** + * Id of the primary table column that should be used as the weight column. + */ + weightColumnId?: number | null; + } + export interface Schema$XPSTablesEvaluationMetrics { + /** + * Classification metrics. + */ + classificationMetrics?: Schema$XPSTablesClassificationMetrics; + /** + * Regression metrics. + */ + regressionMetrics?: Schema$XPSTablesRegressionMetrics; + } + /** + * An information specific to given column and Tables Model, in context of the Model and the predictions created by it. + */ + export interface Schema$XPSTablesModelColumnInfo { + /** + * The ID of the column. + */ + columnId?: number | null; + /** + * When given as part of a Model: Measurement of how much model predictions correctness on the TEST data depend on values in this column. A value between 0 and 1, higher means higher influence. These values are normalized - for all input feature columns of a given model they add to 1. When given back by Predict or Batch Predict: Measurement of how impactful for the prediction returned for the given row the value in this column was. Specifically, the feature importance specifies the marginal contribution that the feature made to the prediction score compared to the baseline score. These values are computed using the Sampled Shapley method. + */ + featureImportance?: number | null; + } + /** + * A description of Tables model structure. + */ + export interface Schema$XPSTablesModelStructure { + /** + * A list of models. + */ + modelParameters?: Schema$XPSTablesModelStructureModelParameters[]; + } + /** + * Model hyper-parameters for a model. + */ + export interface Schema$XPSTablesModelStructureModelParameters { + hyperparameters?: Schema$XPSTablesModelStructureModelParametersParameter[]; + } + export interface Schema$XPSTablesModelStructureModelParametersParameter { + /** + * Float type parameter value. + */ + floatValue?: number | null; + /** + * Integer type parameter value. + */ + intValue?: string | null; + /** + * Parameter name. + */ + name?: string | null; + /** + * String type parameter value. + */ + stringValue?: string | null; + } + export interface Schema$XPSTableSpec { + /** + * Mapping from column id to column spec. + */ + columnSpecs?: {[key: string]: Schema$XPSColumnSpec} | null; + /** + * The total size of imported data of the table. + */ + importedDataSizeInBytes?: string | null; + /** + * The number of rows in the table. + */ + rowCount?: string | null; + /** + * The id of the time column. + */ + timeColumnId?: number | null; + /** + * The number of valid rows. + */ + validRowCount?: string | null; + } + export interface Schema$XPSTablesPreprocessResponse { + /** + * The table/column id, column_name and the DataTypes of the columns will be populated. + */ + tablesDatasetMetadata?: Schema$XPSTablesDatasetMetadata; + } + /** + * Metrics for Tables regression problems. + */ + export interface Schema$XPSTablesRegressionMetrics { + /** + * Mean absolute error. + */ + meanAbsoluteError?: number | null; + /** + * Mean absolute percentage error, only set if all of the target column's values are positive. + */ + meanAbsolutePercentageError?: number | null; + /** + * A list of actual versus predicted points for the model being evaluated. + */ + regressionMetricsEntries?: Schema$XPSRegressionMetricsEntry[]; + /** + * Root mean squared error. + */ + rootMeanSquaredError?: number | null; + /** + * Root mean squared log error. + */ + rootMeanSquaredLogError?: number | null; + /** + * R squared. + */ + rSquared?: number | null; + } + export interface Schema$XPSTablesTrainingOperationMetadata { + /** + * Current stage of creating model. + */ + createModelStage?: string | null; + /** + * The optimization objective for model. + */ + optimizationObjective?: string | null; + /** + * This field is for training. When the operation is terminated successfully, AutoML Backend post this field to operation metadata in spanner. If the metadata has no trials returned, the training operation is supposed to be a failure. + */ + topTrials?: Schema$XPSTuningTrial[]; + /** + * Creating model budget. + */ + trainBudgetMilliNodeHours?: string | null; + /** + * This field records the training objective value with respect to time, giving insight into how the model architecture search is performing as training time elapses. + */ + trainingObjectivePoints?: Schema$XPSTrainingObjectivePoint[]; + /** + * Timestamp when training process starts. + */ + trainingStartTime?: string | null; + } + export interface Schema$XPSTablesTrainResponse { + modelStructure?: Schema$XPSTablesModelStructure; + /** + * Sample rows from the dataset this model was trained. + */ + predictionSampleRows?: Schema$XPSRow[]; + /** + * Output only. Auxiliary information for each of the input_feature_column_specs, with respect to this particular model. + */ + tablesModelColumnInfo?: Schema$XPSTablesModelColumnInfo[]; + /** + * The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget. + */ + trainCostMilliNodeHours?: string | null; + } + /** + * Component model. Next ID: 10 + */ + export interface Schema$XPSTextComponentModel { + /** + * The Cloud Storage resource path to hold batch prediction model. + */ + batchPredictionModelGcsUri?: string | null; + /** + * The Cloud Storage resource path to hold online prediction model. + */ + onlinePredictionModelGcsUri?: string | null; + /** + * The partition where the model is deployed. Populated by uCAIP BE as part of online PredictRequest. + */ + partition?: string | null; + /** + * The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud Ai Platform API. + */ + servingArtifact?: Schema$XPSModelArtifactItem; + /** + * The name of servo model. Populated by uCAIP BE as part of online PredictRequest. + */ + servoModelName?: string | null; + /** + * The name of the trained NL submodel. + */ + submodelName?: string | null; + /** + * The type of trained NL submodel + */ + submodelType?: string | null; + /** + * ## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list + */ + tfRuntimeVersion?: string | null; + /** + * The servomatic model version number. Populated by uCAIP BE as part of online PredictRequest. + */ + versionNumber?: string | null; + } + export interface Schema$XPSTextExtractionEvaluationMetrics { + /** + * Values are at the highest F1 score on the precision-recall curve. Only confidence_threshold, recall, precision, and f1_score will be set. + */ + bestF1ConfidenceMetrics?: Schema$XPSConfidenceMetricsEntry; + /** + * If the enclosing EvaluationMetrics.label is empty, confidence_metrics_entries is an evaluation of the entire model across all labels. If the enclosing EvaluationMetrics.label is set, confidence_metrics_entries applies to that label. + */ + confidenceMetricsEntries?: Schema$XPSConfidenceMetricsEntry[]; + /** + * Confusion matrix of the model, at the default confidence threshold (0.0). Only set for whole-model evaluation, not for evaluation per label. + */ + confusionMatrix?: Schema$XPSConfusionMatrix; + /** + * Only recall, precision, and f1_score will be set. + */ + perLabelConfidenceMetrics?: { + [key: string]: Schema$XPSConfidenceMetricsEntry; + } | null; + } + /** + * Model evaluation metrics for text sentiment problems. + */ + export interface Schema$XPSTextSentimentEvaluationMetrics { + /** + * Output only. Confusion matrix of the evaluation. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + confusionMatrix?: Schema$XPSConfusionMatrix; + /** + * Output only. The harmonic mean of recall and precision. + */ + f1Score?: number | null; + /** + * Output only. Linear weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + linearKappa?: number | null; + /** + * Output only. Mean absolute error. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + meanAbsoluteError?: number | null; + /** + * Output only. Mean squared error. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + meanSquaredError?: number | null; + /** + * Output only. Precision. + */ + precision?: number | null; + /** + * Output only. Quadratic weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + quadraticKappa?: number | null; + /** + * Output only. Recall. + */ + recall?: number | null; + } + /** + * TextToSpeech train response + */ + export interface Schema$XPSTextToSpeechTrainResponse {} + export interface Schema$XPSTextTrainResponse { + /** + * Component submodels. + */ + componentModel?: Schema$XPSTextComponentModel[]; + } + /** + * A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. + */ + export interface Schema$XPSTfJsFormat {} + /** + * LINT.IfChange A model format used for mobile and IoT devices. See https://www.tensorflow.org/lite. + */ + export interface Schema$XPSTfLiteFormat {} + /** + * A tensorflow model format in SavedModel format. + */ + export interface Schema$XPSTfSavedModelFormat {} + /** + * The data statistics of a series of TIMESTAMP values. + */ + export interface Schema$XPSTimestampStats { + commonStats?: Schema$XPSCommonStats; + /** + * The string key is the pre-defined granularity. Currently supported: hour_of_day, day_of_week, month_of_year. Granularities finer that the granularity of timestamp data are not populated (e.g. if timestamps are at day granularity, then hour_of_day is not populated). + */ + granularStats?: { + [key: string]: Schema$XPSTimestampStatsGranularStats; + } | null; + medianTimestampNanos?: string | null; + } + /** + * Stats split by a defined in context granularity. + */ + export interface Schema$XPSTimestampStatsGranularStats { + /** + * A map from granularity key to example count for that key. E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means May). + */ + buckets?: {[key: string]: string} | null; + } + /** + * Track matching model metrics for a single track match threshold and multiple label match confidence thresholds. Next tag: 6. + */ + export interface Schema$XPSTrackMetricsEntry { + /** + * Output only. Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them. + */ + confidenceMetricsEntries?: Schema$XPSTrackMetricsEntryConfidenceMetricsEntry[]; + /** + * Output only. The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry. + */ + iouThreshold?: number | null; + /** + * Output only. The mean bounding box iou over all confidence thresholds. + */ + meanBoundingBoxIou?: number | null; + /** + * Output only. The mean mismatch rate over all confidence thresholds. + */ + meanMismatchRate?: number | null; + /** + * Output only. The mean average precision over all confidence thresholds. + */ + meanTrackingAveragePrecision?: number | null; + } + /** + * Metrics for a single confidence threshold. Next tag: 6. + */ + export interface Schema$XPSTrackMetricsEntryConfidenceMetricsEntry { + /** + * Output only. Bounding box intersection-over-union precision. Measures how well the bounding boxes overlap between each other (e.g. complete overlap or just barely above iou_threshold). + */ + boundingBoxIou?: number | null; + /** + * Output only. The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * Output only. Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity. + */ + mismatchRate?: number | null; + /** + * Output only. Tracking precision. + */ + trackingPrecision?: number | null; + /** + * Output only. Tracking recall. + */ + trackingRecall?: number | null; + } + export interface Schema$XPSTrainingObjectivePoint { + /** + * The time at which this point was recorded. + */ + createTime?: string | null; + /** + * The objective value when this point was recorded. + */ + value?: number | null; + } + /** + * Next ID: 18 + */ + export interface Schema$XPSTrainResponse { + /** + * Estimated model size in bytes once deployed. + */ + deployedModelSizeBytes?: string | null; + /** + * Optional vision model error analysis configuration. The field is set when model error analysis is enabled in the training request. The results of error analysis will be binded together with evaluation results (in the format of AnnotatedExample). + */ + errorAnalysisConfigs?: Schema$XPSVisionErrorAnalysisConfig[]; + /** + * Examples used to evaluate the model (usually the test set), with the predicted annotations. The file_spec should point to recordio file(s) of AnnotatedExample. For each returned example, the example_id_token and annotations predicted by the model must be set. The example payload can and is recommended to be omitted. + */ + evaluatedExampleSet?: Schema$XPSExampleSet; + /** + * The trained model evaluation metrics. This can be optionally returned. + */ + evaluationMetricsSet?: Schema$XPSEvaluationMetricsSet; + /** + * VisionExplanationConfig for XAI on test set. Optional for when XAI is enable in training request. + */ + explanationConfigs?: Schema$XPSResponseExplanationSpec[]; + imageClassificationTrainResp?: Schema$XPSImageClassificationTrainResponse; + imageObjectDetectionTrainResp?: Schema$XPSImageObjectDetectionModelSpec; + imageSegmentationTrainResp?: Schema$XPSImageSegmentationTrainResponse; + /** + * Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model. + */ + modelToken?: string | null; + speechTrainResp?: Schema$XPSSpeechModelSpec; + tablesTrainResp?: Schema$XPSTablesTrainResponse; + textToSpeechTrainResp?: Schema$XPSTextToSpeechTrainResponse; + /** + * Will only be needed for uCAIP from Beta. + */ + textTrainResp?: Schema$XPSTextTrainResponse; + translationTrainResp?: Schema$XPSTranslationTrainResponse; + videoActionRecognitionTrainResp?: Schema$XPSVideoActionRecognitionTrainResponse; + videoClassificationTrainResp?: Schema$XPSVideoClassificationTrainResponse; + videoObjectTrackingTrainResp?: Schema$XPSVideoObjectTrackingTrainResponse; + } + /** + * Evaluation metrics for the dataset. + */ + export interface Schema$XPSTranslationEvaluationMetrics { + /** + * BLEU score for base model. + */ + baseBleuScore?: number | null; + /** + * BLEU score. + */ + bleuScore?: number | null; + } + /** + * Translation preprocess response. + */ + export interface Schema$XPSTranslationPreprocessResponse { + /** + * Total example count parsed. + */ + parsedExampleCount?: string | null; + /** + * Total valid example count. + */ + validExampleCount?: string | null; + } + /** + * Train response for translation. + */ + export interface Schema$XPSTranslationTrainResponse { + /** + * Type of the model. + */ + modelType?: string | null; + } + /** + * Metrics for a tuning job generated, will get forwarded to Stackdriver as model tuning logs. Setting this as a standalone message out of CreateModelMetadata to avoid confusion as we expose this message only to users. + */ + export interface Schema$XPSTuningTrial { + /** + * Model parameters for the trial. + */ + modelStructure?: Schema$XPSTablesModelStructure; + /** + * The optimization objective evaluation of the eval split data. + */ + trainingObjectivePoint?: Schema$XPSTrainingObjectivePoint; + } + /** + * The Evaluation metrics entry given a specific precision_window_length. + */ + export interface Schema$XPSVideoActionMetricsEntry { + /** + * Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + */ + confidenceMetricsEntries?: Schema$XPSVideoActionMetricsEntryConfidenceMetricsEntry[]; + /** + * The mean average precision. + */ + meanAveragePrecision?: number | null; + /** + * This VideoActionMetricsEntry is calculated based on this prediction window length. If the predicted action's timestamp is inside the time window whose center is the ground truth action's timestamp with this specific length, the prediction result is treated as a true positive. + */ + precisionWindowLength?: string | null; + } + /** + * Metrics for a single confidence threshold. + */ + export interface Schema$XPSVideoActionMetricsEntryConfidenceMetricsEntry { + /** + * Output only. The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * Output only. The harmonic mean of recall and precision. + */ + f1Score?: number | null; + /** + * Output only. Precision for the given confidence threshold. + */ + precision?: number | null; + /** + * Output only. Recall for the given confidence threshold. + */ + recall?: number | null; + } + /** + * Model evaluation metrics for video action recognition. + */ + export interface Schema$XPSVideoActionRecognitionEvaluationMetrics { + /** + * Output only. The number of ground truth actions used to create this evaluation. + */ + evaluatedActionCount?: number | null; + /** + * Output only. The metric entries for precision window lengths: 1s,2s,3s,4s, 5s. + */ + videoActionMetricsEntries?: Schema$XPSVideoActionMetricsEntry[]; + } + export interface Schema$XPSVideoActionRecognitionTrainResponse { + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSVideoModelArtifactSpec; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + export interface Schema$XPSVideoBatchPredictOperationMetadata { + /** + * All the partial batch prediction results that are completed at the moment. Output examples are sorted by completion time. The order will not be changed. Each output example should be the path of a single RecordIO file of AnnotatedExamples. + */ + outputExamples?: string[] | null; + } + export interface Schema$XPSVideoClassificationTrainResponse { + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSVideoModelArtifactSpec; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + /** + * Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format. + */ + export interface Schema$XPSVideoExportModelSpec { + /** + * Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files. + */ + exportModelOutputConfig?: Schema$XPSExportModelOutputConfig[]; + } + export interface Schema$XPSVideoModelArtifactSpec { + /** + * The model binary files in different formats for model export. + */ + exportArtifact?: Schema$XPSModelArtifactItem[]; + /** + * The default model binary file used for serving (e.g. batch predict) via public Cloud AI Platform API. + */ + servingArtifact?: Schema$XPSModelArtifactItem; + } + /** + * Model evaluation metrics for ObjectTracking problems. Next tag: 10. + */ + export interface Schema$XPSVideoObjectTrackingEvaluationMetrics { + /** + * Output only. The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries. + */ + boundingBoxMeanAveragePrecision?: number | null; + /** + * Output only. The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + */ + boundingBoxMetricsEntries?: Schema$XPSBoundingBoxMetricsEntry[]; + /** + * The number of bounding boxes used for model evaluation. + */ + evaluatedBoundingboxCount?: number | null; + /** + * The number of video frames used for model evaluation. + */ + evaluatedFrameCount?: number | null; + /** + * The number of tracks used for model evaluation. + */ + evaluatedTrackCount?: number | null; + /** + * Output only. The single metric for tracks accuracy evaluation: the mean_average_precision averaged over all track_metrics_entries. + */ + trackMeanAveragePrecision?: number | null; + /** + * Output only. The single metric for tracks bounding box iou evaluation: the mean_bounding_box_iou averaged over all track_metrics_entries. + */ + trackMeanBoundingBoxIou?: number | null; + /** + * Output only. The single metric for tracking consistency evaluation: the mean_mismatch_rate averaged over all track_metrics_entries. + */ + trackMeanMismatchRate?: number | null; + /** + * Output only. The tracks match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + */ + trackMetricsEntries?: Schema$XPSTrackMetricsEntry[]; + } + export interface Schema$XPSVideoObjectTrackingTrainResponse { + /** + * Populated for AutoML request only. + */ + exportModelSpec?: Schema$XPSVideoExportModelSpec; + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSVideoModelArtifactSpec; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + export interface Schema$XPSVideoTrainingOperationMetadata { + /** + * This is an estimation of the node hours necessary for training a model, expressed in milli node hours (i.e. 1,000 value in this field means 1 node hour). A node hour represents the time a virtual machine spends running your training job. The cost of one node running for one hour is a node hour. + */ + trainCostMilliNodeHour?: string | null; + } + /** + * The vision model error analysis configuration. Next tag: 3 + */ + export interface Schema$XPSVisionErrorAnalysisConfig { + /** + * The number of query examples in error analysis. + */ + exampleCount?: number | null; + /** + * The query type used in retrieval. The enum values are frozen in the foreseeable future. + */ + queryType?: string | null; + } + export interface Schema$XPSVisionTrainingOperationMetadata { + /** + * Aggregated infra usage within certain time period, for billing report purpose if XAI is enable in training request. + */ + explanationUsage?: Schema$InfraUsage; + } + /** + * Visualization configurations for image explanation. + */ + export interface Schema$XPSVisualization { + /** + * Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62. + */ + clipPercentLowerbound?: number | null; + /** + * Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9. + */ + clipPercentUpperbound?: number | null; + /** + * The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue. + */ + colorMap?: string | null; + /** + * How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE. + */ + overlayType?: string | null; + /** + * Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE. + */ + polarity?: string | null; + /** + * Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES. + */ + type?: string | null; + } + export interface Schema$XPSXpsOperationMetadata { + /** + * Optional. XPS server can opt to provide example count of the long running operation (e.g. training, data importing, batch prediction). + */ + exampleCount?: string | null; + /** + * Metrics for the operation. By the time the operation is terminated (whether succeeded or failed) as returned from XPS, AutoML BE assumes the metrics are finalized. AutoML BE transparently posts the metrics to Chemist if it's not empty, regardless of the response content or error type. If user is supposed to be charged in case of cancellation/error, this field should be set. In the case where the type of LRO doesn't require any billing, this field should be left unset. + */ + reportingMetrics?: Schema$XPSReportingMetrics; + tablesTrainingOperationMetadata?: Schema$XPSTablesTrainingOperationMetadata; + videoBatchPredictOperationMetadata?: Schema$XPSVideoBatchPredictOperationMetadata; + videoTrainingOperationMetadata?: Schema$XPSVideoTrainingOperationMetadata; + visionTrainingOperationMetadata?: Schema$XPSVisionTrainingOperationMetadata; + } + /** + * An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Only supports image Models (modality is IMAGE). + */ + export interface Schema$XPSXraiAttribution { + /** + * The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively. + */ + stepCount?: number | null; } export class Resource$Documents { diff --git a/src/apis/language/v2.ts b/src/apis/language/v2.ts index 14a3aa2ffc5..9d760284099 100644 --- a/src/apis/language/v2.ts +++ b/src/apis/language/v2.ts @@ -203,7 +203,28 @@ export namespace language_v2 { /** * Required. The enabled features. */ - features?: Schema$Features; + features?: Schema$AnnotateTextRequestFeatures; + } + /** + * All available features. Setting each one to true will enable that specific analysis for the input. + */ + export interface Schema$AnnotateTextRequestFeatures { + /** + * Optional. Classify the full document into categories. + */ + classifyText?: boolean | null; + /** + * Optional. Extract document-level sentiment. + */ + extractDocumentSentiment?: boolean | null; + /** + * Optional. Extract entities. + */ + extractEntities?: boolean | null; + /** + * Optional. Moderate the document for harmful and sensitive categories. + */ + moderateText?: boolean | null; } /** * The text annotations response message. @@ -277,6 +298,62 @@ export namespace language_v2 { */ languageSupported?: boolean | null; } + /** + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); \} public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); \} return resultBuilder.build(); \} // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; \} return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; \} static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; \} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; \} [result autorelease]; return result; \} // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); \} var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); \}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); \} resultBuilder.push(hexString); return resultBuilder.join(''); \}; // ... + */ + export interface Schema$Color { + /** + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). + */ + alpha?: number | null; + /** + * The amount of blue in the color as a value in the interval [0, 1]. + */ + blue?: number | null; + /** + * The amount of green in the color as a value in the interval [0, 1]. + */ + green?: number | null; + /** + * The amount of red in the color as a value in the interval [0, 1]. + */ + red?: number | null; + } + /** + * Metric for billing reports. + */ + export interface Schema$CpuMetric { + /** + * Required. Number of CPU cores. + */ + coreNumber?: string | null; + /** + * Required. Total seconds of core usage, e.g. 4. + */ + coreSec?: string | null; + /** + * Required. Type of cpu, e.g. N2. + */ + cpuType?: string | null; + /** + * Required. Machine spec, e.g. N1_STANDARD_4. + */ + machineSpec?: string | null; + /** + * Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\p{Ll\}\p{N\}]+ E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + */ + trackingLabels?: {[key: string]: string} | null; + } + export interface Schema$DiskMetric { + /** + * Required. Type of Disk, e.g. REGIONAL_SSD. + */ + diskType?: string | null; + /** + * Required. Seconds of physical disk usage, e.g. 3600. + */ + gibSec?: string | null; + } /** * Represents the input to API methods. */ @@ -344,26 +421,48 @@ export namespace language_v2 { */ type?: string | null; } + export interface Schema$GpuMetric { + /** + * Required. Seconds of GPU usage, e.g. 3600. + */ + gpuSec?: string | null; + /** + * Required. Type of GPU, e.g. NVIDIA_TESLA_V100. + */ + gpuType?: string | null; + /** + * Required. Machine spec, e.g. N1_STANDARD_4. + */ + machineSpec?: string | null; + /** + * Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\p{Ll\}\p{N\}]+ E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + */ + trackingLabels?: {[key: string]: string} | null; + } /** - * All available features. Setting each one to true will enable that specific analysis for the input. + * Infra Usage of billing metrics. Next ID: 6 */ - export interface Schema$Features { + export interface Schema$InfraUsage { /** - * Optional. Classify the full document into categories. + * Aggregated core metrics since requested start_time. */ - classifyText?: boolean | null; + cpuMetrics?: Schema$CpuMetric[]; /** - * Optional. Extract document-level sentiment. + * Aggregated persistent disk metrics since requested start_time. */ - extractDocumentSentiment?: boolean | null; + diskMetrics?: Schema$DiskMetric[]; /** - * Optional. Extract entities. + * Aggregated gpu metrics since requested start_time. */ - extractEntities?: boolean | null; + gpuMetrics?: Schema$GpuMetric[]; /** - * Optional. Moderate the document for harmful and sensitive categories. + * Aggregated ram metrics since requested start_time. */ - moderateText?: boolean | null; + ramMetrics?: Schema$RamMetric[]; + /** + * Aggregated tpu metrics since requested start_time. + */ + tpuMetrics?: Schema$TpuMetric[]; } /** * The document moderation request message. @@ -391,6 +490,28 @@ export namespace language_v2 { */ moderationCategories?: Schema$ClassificationCategory[]; } + export interface Schema$RamMetric { + /** + * Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type to match billing metrics definition. + */ + gibSec?: string | null; + /** + * Required. Machine spec, e.g. N1_STANDARD_4. + */ + machineSpec?: string | null; + /** + * Required. VM memory in gb. + */ + memories?: number | null; + /** + * Required. Type of ram. + */ + ramType?: string | null; + /** + * Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\p{Ll\}\p{N\}]+ E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + */ + trackingLabels?: {[key: string]: string} | null; + } /** * Represents a sentence in the input document. */ @@ -447,6 +568,1907 @@ export namespace language_v2 { */ content?: string | null; } + export interface Schema$TpuMetric { + /** + * Required. Seconds of TPU usage, e.g. 3600. + */ + tpuSec?: string | null; + /** + * Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. + */ + tpuType?: string | null; + } + /** + * The data statistics of a series of ARRAY values. + */ + export interface Schema$XPSArrayStats { + commonStats?: Schema$XPSCommonStats; + /** + * Stats of all the values of all arrays, as if they were a single long series of data. The type depends on the element type of the array. + */ + memberStats?: Schema$XPSDataStats; + } + export interface Schema$XPSBatchPredictResponse { + /** + * Examples for batch prediction result. Under full API implementation, results are stored in shared RecordIO of AnnotatedExample protobufs, the annotations field of which is populated by XPS backend. + */ + exampleSet?: Schema$XPSExampleSet; + } + /** + * Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds. + */ + export interface Schema$XPSBoundingBoxMetricsEntry { + /** + * Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + */ + confidenceMetricsEntries?: Schema$XPSBoundingBoxMetricsEntryConfidenceMetricsEntry[]; + /** + * The intersection-over-union threshold value used to compute this metrics entry. + */ + iouThreshold?: number | null; + /** + * The mean average precision. + */ + meanAveragePrecision?: number | null; + } + /** + * Metrics for a single confidence threshold. + */ + export interface Schema$XPSBoundingBoxMetricsEntryConfidenceMetricsEntry { + /** + * The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * The harmonic mean of recall and precision. + */ + f1Score?: number | null; + /** + * Precision for the given confidence threshold. + */ + precision?: number | null; + /** + * Recall for the given confidence threshold. + */ + recall?: number | null; + } + /** + * The data statistics of a series of CATEGORY values. + */ + export interface Schema$XPSCategoryStats { + commonStats?: Schema$XPSCommonStats; + /** + * The statistics of the top 20 CATEGORY values, ordered by CategoryStats.SingleCategoryStats.count. + */ + topCategoryStats?: Schema$XPSCategoryStatsSingleCategoryStats[]; + } + /** + * The statistics of a single CATEGORY value. + */ + export interface Schema$XPSCategoryStatsSingleCategoryStats { + /** + * The number of occurrences of this value in the series. + */ + count?: string | null; + /** + * The CATEGORY value. + */ + value?: string | null; + } + /** + * Model evaluation metrics for classification problems. It can be used for image and video classification. Next tag: 9. + */ + export interface Schema$XPSClassificationEvaluationMetrics { + /** + * The Area under precision recall curve metric. + */ + auPrc?: number | null; + /** + * The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation. + */ + auRoc?: number | null; + /** + * The Area under precision recall curve metric based on priors. + */ + baseAuPrc?: number | null; + /** + * Metrics that have confidence thresholds. Precision-recall curve can be derived from it. + */ + confidenceMetricsEntries?: Schema$XPSConfidenceMetricsEntry[]; + /** + * Confusion matrix of the evaluation. Only set for MULTICLASS classification problems where number of annotation specs is no more than 10. Only set for model level evaluation, not for evaluation per label. + */ + confusionMatrix?: Schema$XPSConfusionMatrix; + /** + * The number of examples used for model evaluation. + */ + evaluatedExamplesCount?: number | null; + /** + * The Log Loss metric. + */ + logLoss?: number | null; + } + /** + * Map from color to display name. Will only be used by Image Segmentation for uCAIP. + */ + export interface Schema$XPSColorMap { + /** + * Should be used during training. + */ + annotationSpecIdToken?: string | null; + /** + * This type is deprecated in favor of the IntColor below. This is because google.type.Color represent color has a float which semantically does not reflect discrete classes/categories concept. Moreover, to handle it well we need to have some tolerance when converting to a discretized color. As such, the recommendation is to have API surface still use google.type.Color while internally IntColor is used. + */ + color?: Schema$Color; + /** + * Should be used during preprocessing. + */ + displayName?: string | null; + intColor?: Schema$XPSColorMapIntColor; + } + /** + * RGB color and each channel is represented by an integer. + */ + export interface Schema$XPSColorMapIntColor { + /** + * The value should be in range of [0, 255]. + */ + blue?: number | null; + /** + * The value should be in range of [0, 255]. + */ + green?: number | null; + /** + * The value should be in range of [0, 255]. + */ + red?: number | null; + } + export interface Schema$XPSColumnSpec { + /** + * The unique id of the column. When Preprocess, the Tables BE will popuate the order id of the column, which reflects the order of the column inside the table, i.e. 0 means the first column in the table, N-1 means the last column. AutoML BE will persist this order id in Spanner and set the order id here when calling RefreshTablesStats and Train. Note: it's different than the column_spec_id that is generated in AutoML BE. + */ + columnId?: number | null; + /** + * The data stats of the column. It's outputed in RefreshTablesStats and a required input for Train. + */ + dataStats?: Schema$XPSDataStats; + /** + * The data type of the column. It's outputed in Preprocess rpc and a required input for RefreshTablesStats and Train. + */ + dataType?: Schema$XPSDataType; + /** + * The display name of the column. It's outputed in Preprocess and a required input for RefreshTablesStats and Train. + */ + displayName?: string | null; + forecastingMetadata?: Schema$XPSColumnSpecForecastingMetadata; + /** + * It's outputed in RefreshTablesStats, and a required input in Train. + */ + topCorrelatedColumns?: Schema$XPSColumnSpecCorrelatedColumn[]; + } + /** + * Identifies a table's column, and its correlation with the column this ColumnSpec describes. + */ + export interface Schema$XPSColumnSpecCorrelatedColumn { + columnId?: number | null; + correlationStats?: Schema$XPSCorrelationStats; + } + /** + * =========================================================================== # The fields below are used exclusively for Forecasting. + */ + export interface Schema$XPSColumnSpecForecastingMetadata { + /** + * The type of the column for FORECASTING model training purposes. + */ + columnType?: string | null; + } + /** + * Common statistics for a column with a specified data type. + */ + export interface Schema$XPSCommonStats { + distinctValueCount?: string | null; + nullValueCount?: string | null; + validValueCount?: string | null; + } + /** + * ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. Next tag: 16. + */ + export interface Schema$XPSConfidenceMetricsEntry { + /** + * Metrics are computed with an assumption that the model never return predictions with score lower than this value. + */ + confidenceThreshold?: number | null; + /** + * The harmonic mean of recall and precision. + */ + f1Score?: number | null; + /** + * The harmonic mean of recall_at1 and precision_at1. + */ + f1ScoreAt1?: number | null; + /** + * The number of ground truth labels that are not matched by a model created label. + */ + falseNegativeCount?: string | null; + /** + * The number of model created labels that do not match a ground truth label. + */ + falsePositiveCount?: string | null; + /** + * False Positive Rate for the given confidence threshold. + */ + falsePositiveRate?: number | null; + /** + * The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example. + */ + falsePositiveRateAt1?: number | null; + /** + * Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold. + */ + positionThreshold?: number | null; + /** + * Precision for the given confidence threshold. + */ + precision?: number | null; + /** + * The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example. + */ + precisionAt1?: number | null; + /** + * Recall (true positive rate) for the given confidence threshold. + */ + recall?: number | null; + /** + * The recall (true positive rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example. + */ + recallAt1?: number | null; + /** + * The number of labels that were not created by the model, but if they would, they would not match a ground truth label. + */ + trueNegativeCount?: string | null; + /** + * The number of model created labels that match a ground truth label. + */ + truePositiveCount?: string | null; + } + /** + * Confusion matrix of the model running the classification. + */ + export interface Schema$XPSConfusionMatrix { + /** + * For the following three repeated fields, only one is intended to be set. annotation_spec_id_token is preferable to be set. ID tokens of the annotation specs used in the confusion matrix. + */ + annotationSpecIdToken?: string[] | null; + /** + * Category (mainly for segmentation). Set only for image segmentation models. Note: uCAIP Image Segmentation should use annotation_spec_id_token. + */ + category?: number[] | null; + /** + * Rows in the confusion matrix. The number of rows is equal to the size of `annotation_spec_id_token`. `row[i].value[j]` is the number of examples that have ground truth of the `annotation_spec_id_token[i]` and are predicted as `annotation_spec_id_token[j]` by the model being evaluated. + */ + row?: Schema$XPSConfusionMatrixRow[]; + /** + * Sentiment labels used in the confusion matrix. Set only for text sentiment models. For AutoML Text Revamp, use `annotation_spec_id_token` instead and leave this field empty. + */ + sentimentLabel?: number[] | null; + } + /** + * A row in the confusion matrix. + */ + export interface Schema$XPSConfusionMatrixRow { + /** + * Same as above except intended to represent other counts (for e.g. for segmentation this is pixel count). NOTE(params): Only example_count or count is set (oneoff does not support repeated fields unless they are embedded inside another message). + */ + count?: string[] | null; + /** + * Value of the specific cell in the confusion matrix. The number of values each row has (i.e. the length of the row) is equal to the length of the annotation_spec_id_token field. + */ + exampleCount?: number[] | null; + } + /** + * A model format used for iOS mobile devices. + */ + export interface Schema$XPSCoreMlFormat {} + /** + * A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same. + */ + export interface Schema$XPSCorrelationStats { + /** + * The correlation value using the Cramer's V measure. + */ + cramersV?: number | null; + } + /** + * Different types of errors and the stats associatesd with each error. + */ + export interface Schema$XPSDataErrors { + /** + * Number of records having errors associated with the enum. + */ + count?: number | null; + /** + * Type of the error. + */ + errorType?: string | null; + } + /** + * The data statistics of a series of values that share the same DataType. + */ + export interface Schema$XPSDataStats { + /** + * The statistics for ARRAY DataType. + */ + arrayStats?: Schema$XPSArrayStats; + /** + * The statistics for CATEGORY DataType. + */ + categoryStats?: Schema$XPSCategoryStats; + /** + * The number of distinct values. + */ + distinctValueCount?: string | null; + /** + * The statistics for FLOAT64 DataType. + */ + float64Stats?: Schema$XPSFloat64Stats; + /** + * The number of values that are null. + */ + nullValueCount?: string | null; + /** + * The statistics for STRING DataType. + */ + stringStats?: Schema$XPSStringStats; + /** + * The statistics for STRUCT DataType. + */ + structStats?: Schema$XPSStructStats; + /** + * The statistics for TIMESTAMP DataType. + */ + timestampStats?: Schema$XPSTimestampStats; + /** + * The number of values that are valid. + */ + validValueCount?: string | null; + } + /** + * Indicated the type of data that can be stored in a structured data entity (e.g. a table). + */ + export interface Schema$XPSDataType { + /** + * The highly compatible data types to this data type. + */ + compatibleDataTypes?: Schema$XPSDataType[]; + /** + * If type_code == ARRAY, then `list_element_type` is the type of the elements. + */ + listElementType?: Schema$XPSDataType; + /** + * If true, this DataType can also be `null`. + */ + nullable?: boolean | null; + /** + * If type_code == STRUCT, then `struct_type` provides type information for the struct's fields. + */ + structType?: Schema$XPSStructType; + /** + * If type_code == TIMESTAMP then `time_format` provides the format in which that time field is expressed. The time_format must be written in `strftime` syntax. If time_format is not set, then the default format as described on the field is used. + */ + timeFormat?: string | null; + /** + * Required. The TypeCode for this type. + */ + typeCode?: string | null; + } + /** + * A model format used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system. + */ + export interface Schema$XPSDockerFormat { + /** + * Optional. Additional cpu information describing the requirements for the to be exported model files. + */ + cpuArchitecture?: string | null; + /** + * Optional. Additional gpu information describing the requirements for the to be exported model files. + */ + gpuArchitecture?: string | null; + } + /** + * A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. + */ + export interface Schema$XPSEdgeTpuTfLiteFormat {} + /** + * Contains xPS-specific model evaluation metrics either for a single annotation spec (label), or for the model overall. Next tag: 18. + */ + export interface Schema$XPSEvaluationMetrics { + /** + * The annotation_spec for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The value comes from the input annotations in AnnotatedExample. For MVP product or for text sentiment models where annotation_spec_id_token is not available, set label instead. + */ + annotationSpecIdToken?: string | null; + /** + * The integer category label for which this evaluation metric instance had been created. Valid categories are 0 or higher. Overall model evaluation should set this to negative values (rather than implicit zero). Only used for Image Segmentation (prefer to set annotation_spec_id_token instead). Note: uCAIP Image Segmentation should use annotation_spec_id_token. + */ + category?: number | null; + /** + * The number of examples used to create this evaluation metrics instance. + */ + evaluatedExampleCount?: number | null; + imageClassificationEvalMetrics?: Schema$XPSClassificationEvaluationMetrics; + imageObjectDetectionEvalMetrics?: Schema$XPSImageObjectDetectionEvaluationMetrics; + imageSegmentationEvalMetrics?: Schema$XPSImageSegmentationEvaluationMetrics; + /** + * The label for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The label maps to AnnotationSpec.display_name in Public API protos. Only used by MVP implementation and text sentiment FULL implementation. + */ + label?: string | null; + regressionEvalMetrics?: Schema$XPSRegressionEvaluationMetrics; + tablesClassificationEvalMetrics?: Schema$XPSClassificationEvaluationMetrics; + tablesEvalMetrics?: Schema$XPSTablesEvaluationMetrics; + textClassificationEvalMetrics?: Schema$XPSClassificationEvaluationMetrics; + textExtractionEvalMetrics?: Schema$XPSTextExtractionEvaluationMetrics; + textSentimentEvalMetrics?: Schema$XPSTextSentimentEvaluationMetrics; + translationEvalMetrics?: Schema$XPSTranslationEvaluationMetrics; + videoActionRecognitionEvalMetrics?: Schema$XPSVideoActionRecognitionEvaluationMetrics; + videoClassificationEvalMetrics?: Schema$XPSClassificationEvaluationMetrics; + videoObjectTrackingEvalMetrics?: Schema$XPSVideoObjectTrackingEvaluationMetrics; + } + /** + * Specifies location of model evaluation metrics. + */ + export interface Schema$XPSEvaluationMetricsSet { + /** + * Inline EvaluationMetrics - should be relatively small. For passing large quantities of exhaustive metrics, use file_spec. + */ + evaluationMetrics?: Schema$XPSEvaluationMetrics[]; + /** + * File spec containing evaluation metrics of a model, must point to RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics messages. + */ + fileSpec?: Schema$XPSFileSpec; + /** + * Number of the evaluation metrics (usually one per label plus overall). + */ + numEvaluationMetrics?: string | null; + } + /** + * Set of examples or input sources. + */ + export interface Schema$XPSExampleSet { + /** + * File spec of the examples or input sources. + */ + fileSpec?: Schema$XPSFileSpec; + /** + * Fingerprint of the example set. + */ + fingerprint?: string | null; + /** + * Number of examples. + */ + numExamples?: string | null; + /** + * Number of input sources. + */ + numInputSources?: string | null; + } + export interface Schema$XPSExportModelOutputConfig { + coreMlFormat?: Schema$XPSCoreMlFormat; + dockerFormat?: Schema$XPSDockerFormat; + edgeTpuTfLiteFormat?: Schema$XPSEdgeTpuTfLiteFormat; + /** + * For any model and format: If true, will additionally export FirebaseExportedModelInfo in a firebase.txt file. + */ + exportFirebaseAuxiliaryInfo?: boolean | null; + /** + * The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER. + */ + outputGcrUri?: string | null; + /** + * The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory + */ + outputGcsUri?: string | null; + tfJsFormat?: Schema$XPSTfJsFormat; + tfLiteFormat?: Schema$XPSTfLiteFormat; + tfSavedModelFormat?: Schema$XPSTfSavedModelFormat; + } + /** + * Spec of input and output files, on external file systems (CNS, GCS, etc). + */ + export interface Schema$XPSFileSpec { + /** + * Deprecated. Use file_spec. + */ + directoryPath?: string | null; + fileFormat?: string | null; + /** + * Single file path, or file pattern of format "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and /cns/cell-d/somewhere/file-00001-of-00002. + */ + fileSpec?: string | null; + /** + * Deprecated. Use file_spec. + */ + singleFilePath?: string | null; + } + /** + * The data statistics of a series of FLOAT64 values. + */ + export interface Schema$XPSFloat64Stats { + commonStats?: Schema$XPSCommonStats; + /** + * Histogram buckets of the data series. Sorted by the min value of the bucket, ascendingly, and the number of the buckets is dynamically generated. The buckets are non-overlapping and completely cover whole FLOAT64 range with min of first bucket being `"-Infinity"`, and max of the last one being `"Infinity"`. + */ + histogramBuckets?: Schema$XPSFloat64StatsHistogramBucket[]; + /** + * The mean of the series. + */ + mean?: number | null; + /** + * Ordered from 0 to k k-quantile values of the data series of n values. The value at index i is, approximately, the i*n/k-th smallest value in the series; for i = 0 and i = k these are, respectively, the min and max values. + */ + quantiles?: number[] | null; + /** + * The standard deviation of the series. + */ + standardDeviation?: number | null; + } + /** + * A bucket of a histogram. + */ + export interface Schema$XPSFloat64StatsHistogramBucket { + /** + * The number of data values that are in the bucket, i.e. are between min and max values. + */ + count?: string | null; + /** + * The maximum value of the bucket, exclusive unless max = `"Infinity"`, in which case it's inclusive. + */ + max?: number | null; + /** + * The minimum value of the bucket, inclusive. + */ + min?: number | null; + } + export interface Schema$XPSImageClassificationTrainResponse { + /** + * Total number of classes. + */ + classCount?: string | null; + /** + * Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Populated for AutoMl requests. + */ + exportModelSpec?: Schema$XPSImageExportModelSpec; + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSImageModelArtifactSpec; + modelServingSpec?: Schema$XPSImageModelServingSpec; + /** + * Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + */ + stopReason?: string | null; + /** + * The actual cost to create this model. - For edge type model, the cost is expressed in node hour. - For cloud type model,the cost is expressed in compute hour. - Populated for models created before GA. To be deprecated after GA. + */ + trainCostInNodeTime?: string | null; + /** + * The actual training cost, expressed in node seconds. Populated for models trained in node time. + */ + trainCostNodeSeconds?: string | null; + } + /** + * Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format. + */ + export interface Schema$XPSImageExportModelSpec { + /** + * Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files. + */ + exportModelOutputConfig?: Schema$XPSExportModelOutputConfig[]; + } + /** + * Stores the locations and related metadata of the model artifacts. Populated for uCAIP requests only. + */ + export interface Schema$XPSImageModelArtifactSpec { + /** + * The Tensorflow checkpoint files. e.g. Used for resumable training. + */ + checkpointArtifact?: Schema$XPSModelArtifactItem; + /** + * The model binary files in different formats for model export. + */ + exportArtifact?: Schema$XPSModelArtifactItem[]; + /** + * GCS uri of decoded labels file for model export 'dict.txt'. + */ + labelGcsUri?: string | null; + /** + * The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API. + */ + servingArtifact?: Schema$XPSModelArtifactItem; + /** + * GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated. + */ + tfJsBinaryGcsPrefix?: string | null; + /** + * GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. + */ + tfLiteMetadataGcsUri?: string | null; + } + /** + * Serving specification for image models. + */ + export interface Schema$XPSImageModelServingSpec { + /** + * Populate under uCAIP request scope. + */ + modelThroughputEstimation?: Schema$XPSImageModelServingSpecModelThroughputEstimation[]; + /** + * An estimated value of how much traffic a node can serve. Populated for AutoMl request only. + */ + nodeQps?: number | null; + /** + * ## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list + */ + tfRuntimeVersion?: string | null; + } + export interface Schema$XPSImageModelServingSpecModelThroughputEstimation { + computeEngineAcceleratorType?: string | null; + /** + * Estimated latency. + */ + latencyInMilliseconds?: number | null; + /** + * The approximate qps a deployed node can serve. + */ + nodeQps?: number | null; + servomaticPartitionType?: string | null; + } + /** + * Model evaluation metrics for image object detection problems. Evaluates prediction quality of labeled bounding boxes. + */ + export interface Schema$XPSImageObjectDetectionEvaluationMetrics { + /** + * The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries. + */ + boundingBoxMeanAveragePrecision?: number | null; + /** + * The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + */ + boundingBoxMetricsEntries?: Schema$XPSBoundingBoxMetricsEntry[]; + /** + * The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had. + */ + evaluatedBoundingBoxCount?: number | null; + } + export interface Schema$XPSImageObjectDetectionModelSpec { + /** + * Total number of classes. + */ + classCount?: string | null; + exportModelSpec?: Schema$XPSImageExportModelSpec; + /** + * Max number of bounding box. + */ + maxBoundingBoxCount?: string | null; + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSImageModelArtifactSpec; + modelServingSpec?: Schema$XPSImageModelServingSpec; + /** + * Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. + */ + stopReason?: string | null; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + /** + * Model evaluation metrics for image segmentation problems. Next tag: 4. + */ + export interface Schema$XPSImageSegmentationEvaluationMetrics { + /** + * Metrics that have confidence thresholds. Precision-recall curve can be derived from it. + */ + confidenceMetricsEntries?: Schema$XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry[]; + } + /** + * Metrics for a single confidence threshold. + */ + export interface Schema$XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry { + /** + * The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * Confusion matrix of the per confidence_threshold evaluation. Pixel counts are set here. Only set for model level evaluation, not for evaluation per label. + */ + confusionMatrix?: Schema$XPSConfusionMatrix; + /** + * DSC or the F1 score: The harmonic mean of recall and precision. + */ + diceScoreCoefficient?: number | null; + /** + * IOU score. + */ + iouScore?: number | null; + /** + * Precision for the given confidence threshold. + */ + precision?: number | null; + /** + * Recall for the given confidence threshold. + */ + recall?: number | null; + } + export interface Schema$XPSImageSegmentationTrainResponse { + /** + * Color map of the model. + */ + colorMaps?: Schema$XPSColorMap[]; + /** + * NOTE: These fields are not used/needed in EAP but will be set later. + */ + exportModelSpec?: Schema$XPSImageExportModelSpec; + /** + * ## The fields below are only populated under uCAIP request scope. Model artifact spec stores and model gcs pathes and related metadata + */ + modelArtifactSpec?: Schema$XPSImageModelArtifactSpec; + modelServingSpec?: Schema$XPSImageModelServingSpec; + /** + * Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. + */ + stopReason?: string | null; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + /** + * An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 + */ + export interface Schema$XPSIntegratedGradientsAttribution { + /** + * The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively. + */ + stepCount?: number | null; + } + export interface Schema$XPSMetricEntry { + /** + * For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise leave empty. + */ + argentumMetricId?: string | null; + /** + * A double value. + */ + doubleValue?: number | null; + /** + * A signed 64-bit integer value. + */ + int64Value?: string | null; + /** + * The metric name defined in the service configuration. + */ + metricName?: string | null; + /** + * Billing system labels for this (metric, value) pair. + */ + systemLabels?: Schema$XPSMetricEntryLabel[]; + } + export interface Schema$XPSMetricEntryLabel { + /** + * The name of the label. + */ + labelName?: string | null; + /** + * The value of the label. + */ + labelValue?: string | null; + } + /** + * A single model artifact item. + */ + export interface Schema$XPSModelArtifactItem { + /** + * The model artifact format. + */ + artifactFormat?: string | null; + /** + * The Google Cloud Storage (GCS) uri that stores the model binary files. + */ + gcsUri?: string | null; + } + /** + * Next ID: 8 + */ + export interface Schema$XPSPreprocessResponse { + /** + * Preprocessed examples, that are to be imported into AutoML storage. This should point to RecordIO file(s) of PreprocessedExample messages. The PreprocessedExample.mvp_training_data-s returned here are later verbatim passed to Train() call in TrainExample.mvp_training_data. + */ + outputExampleSet?: Schema$XPSExampleSet; + speechPreprocessResp?: Schema$XPSSpeechPreprocessResponse; + tablesPreprocessResponse?: Schema$XPSTablesPreprocessResponse; + translationPreprocessResp?: Schema$XPSTranslationPreprocessResponse; + } + /** + * Model evaluation metrics for regression problems. It can be used for Tables. + */ + export interface Schema$XPSRegressionEvaluationMetrics { + /** + * Mean Absolute Error (MAE). + */ + meanAbsoluteError?: number | null; + /** + * Mean absolute percentage error. Only set if all ground truth values are positive. + */ + meanAbsolutePercentageError?: number | null; + /** + * A list of actual versus predicted points for the model being evaluated. + */ + regressionMetricsEntries?: Schema$XPSRegressionMetricsEntry[]; + /** + * Root Mean Squared Error (RMSE). + */ + rootMeanSquaredError?: number | null; + /** + * Root mean squared log error. + */ + rootMeanSquaredLogError?: number | null; + /** + * R squared. + */ + rSquared?: number | null; + } + /** + * A pair of actual & observed values for the model being evaluated. + */ + export interface Schema$XPSRegressionMetricsEntry { + /** + * The observed value for a row in the dataset. + */ + predictedValue?: number | null; + /** + * The actual target value for a row in the dataset. + */ + trueValue?: number | null; + } + export interface Schema$XPSReportingMetrics { + /** + * The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set. + */ + effectiveTrainingDuration?: string | null; + /** + * One entry per metric name. The values must be aggregated per metric name. + */ + metricEntries?: Schema$XPSMetricEntry[]; + } + export interface Schema$XPSResponseExplanationMetadata { + /** + * Metadata of the input. + */ + inputs?: { + [key: string]: Schema$XPSResponseExplanationMetadataInputMetadata; + } | null; + /** + * Metadata of the output. + */ + outputs?: { + [key: string]: Schema$XPSResponseExplanationMetadataOutputMetadata; + } | null; + } + /** + * Metadata of the input of a feature. + */ + export interface Schema$XPSResponseExplanationMetadataInputMetadata { + /** + * Name of the input tensor for this model. Only needed in train response. + */ + inputTensorName?: string | null; + /** + * Modality of the feature. Valid values are: numeric, image. Defaults to numeric. + */ + modality?: string | null; + /** + * Visualization configurations for image explanation. + */ + visualizationConfig?: Schema$XPSVisualization; + } + /** + * Metadata of the prediction output to be explained. + */ + export interface Schema$XPSResponseExplanationMetadataOutputMetadata { + /** + * Name of the output tensor. Only needed in train response. + */ + outputTensorName?: string | null; + } + export interface Schema$XPSResponseExplanationParameters { + /** + * An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 + */ + integratedGradientsAttribution?: Schema$XPSIntegratedGradientsAttribution; + /** + * An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead. + */ + xraiAttribution?: Schema$XPSXraiAttribution; + } + /** + * Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context. + */ + export interface Schema$XPSResponseExplanationSpec { + /** + * Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai` + */ + explanationType?: string | null; + /** + * Metadata describing the Model's input and output for explanation. + */ + metadata?: Schema$XPSResponseExplanationMetadata; + /** + * Parameters that configure explaining of the Model's predictions. + */ + parameters?: Schema$XPSResponseExplanationParameters; + } + export interface Schema$XPSRow { + /** + * The ids of the columns. Note: The below `values` field must match order of this field, if this field is set. + */ + columnIds?: number[] | null; + /** + * The values of the row cells, given in the same order as the column_ids. If column_ids is not set, then in the same order as the input_feature_column_ids in TablesModelMetadata. + */ + values?: any[] | null; + } + export interface Schema$XPSSpeechEvaluationMetrics { + /** + * Evaluation metrics for all submodels contained in this model. + */ + subModelEvaluationMetrics?: Schema$XPSSpeechEvaluationMetricsSubModelEvaluationMetric[]; + } + export interface Schema$XPSSpeechEvaluationMetricsSubModelEvaluationMetric { + /** + * Type of the biasing model. + */ + biasingModelType?: string | null; + /** + * If true then it means we have an enhanced version of the biasing models. + */ + isEnhancedModel?: boolean | null; + numDeletions?: number | null; + numInsertions?: number | null; + numSubstitutions?: number | null; + /** + * Number of utterances used in the wer computation. + */ + numUtterances?: number | null; + /** + * Number of words over which the word error rate was computed. + */ + numWords?: number | null; + /** + * Below fields are used for debugging purposes + */ + sentenceAccuracy?: number | null; + /** + * Word error rate (standard error metric used for speech recognition). + */ + wer?: number | null; + } + export interface Schema$XPSSpeechModelSpec { + /** + * Required for speech xps backend. Speech xps has to use dataset_id and model_id as the primary key in db so that speech API can query the db directly. + */ + datasetId?: string | null; + language?: string | null; + /** + * Model specs for all submodels contained in this model. + */ + subModelSpecs?: Schema$XPSSpeechModelSpecSubModelSpec[]; + } + export interface Schema$XPSSpeechModelSpecSubModelSpec { + /** + * Type of the biasing model. + */ + biasingModelType?: string | null; + /** + * In S3, Recognition ClientContextId.client_id + */ + clientId?: string | null; + /** + * In S3, Recognition ClientContextId.context_id + */ + contextId?: string | null; + /** + * If true then it means we have an enhanced version of the biasing models. + */ + isEnhancedModel?: boolean | null; + } + export interface Schema$XPSSpeechPreprocessResponse { + /** + * Location od shards of sstables (test data) of DataUtterance protos. + */ + cnsTestDataPath?: string | null; + /** + * Location of shards of sstables (training data) of DataUtterance protos. + */ + cnsTrainDataPath?: string | null; + /** + * The metrics for prebuilt speech models. They are included here because there is no prebuilt speech models stored in the AutoML. + */ + prebuiltModelEvaluationMetrics?: Schema$XPSSpeechEvaluationMetrics; + /** + * Stats associated with the data. + */ + speechPreprocessStats?: Schema$XPSSpeechPreprocessStats; + } + export interface Schema$XPSSpeechPreprocessStats { + /** + * Different types of data errors and the counts associated with them. + */ + dataErrors?: Schema$XPSDataErrors[]; + /** + * The number of rows marked HUMAN_LABELLED + */ + numHumanLabeledExamples?: number | null; + /** + * The number of samples found in the previously recorded logs data. + */ + numLogsExamples?: number | null; + /** + * The number of rows marked as MACHINE_TRANSCRIBED + */ + numMachineTranscribedExamples?: number | null; + /** + * The number of examples labelled as TEST by Speech xps server. + */ + testExamplesCount?: number | null; + /** + * The number of sentences in the test data set. + */ + testSentencesCount?: number | null; + /** + * The number of words in the test data set. + */ + testWordsCount?: number | null; + /** + * The number of examples labeled as TRAIN by Speech xps server. + */ + trainExamplesCount?: number | null; + /** + * The number of sentences in the training data set. + */ + trainSentencesCount?: number | null; + /** + * The number of words in the training data set. + */ + trainWordsCount?: number | null; + } + /** + * The data statistics of a series of STRING values. + */ + export interface Schema$XPSStringStats { + commonStats?: Schema$XPSCommonStats; + /** + * The statistics of the top 20 unigrams, ordered by StringStats.UnigramStats.count. + */ + topUnigramStats?: Schema$XPSStringStatsUnigramStats[]; + } + /** + * The statistics of a unigram. + */ + export interface Schema$XPSStringStatsUnigramStats { + /** + * The number of occurrences of this unigram in the series. + */ + count?: string | null; + /** + * The unigram. + */ + value?: string | null; + } + /** + * The data statistics of a series of STRUCT values. + */ + export interface Schema$XPSStructStats { + commonStats?: Schema$XPSCommonStats; + /** + * Map from a field name of the struct to data stats aggregated over series of all data in that field across all the structs. + */ + fieldStats?: {[key: string]: Schema$XPSDataStats} | null; + } + /** + * `StructType` defines the DataType-s of a STRUCT type. + */ + export interface Schema$XPSStructType { + /** + * Unordered map of struct field names to their data types. + */ + fields?: {[key: string]: Schema$XPSDataType} | null; + } + /** + * Metrics for Tables classification problems. + */ + export interface Schema$XPSTablesClassificationMetrics { + /** + * Metrics building a curve. + */ + curveMetrics?: Schema$XPSTablesClassificationMetricsCurveMetrics[]; + } + /** + * Metrics curve data point for a single value. + */ + export interface Schema$XPSTablesClassificationMetricsCurveMetrics { + /** + * The area under the precision-recall curve. + */ + aucPr?: number | null; + /** + * The area under receiver operating characteristic curve. + */ + aucRoc?: number | null; + /** + * Metrics that have confidence thresholds. Precision-recall curve and ROC curve can be derived from them. + */ + confidenceMetricsEntries?: Schema$XPSTablesConfidenceMetricsEntry[]; + /** + * The Log loss metric. + */ + logLoss?: number | null; + /** + * The position threshold value used to compute the metrics. + */ + positionThreshold?: number | null; + /** + * The CATEGORY row value (for ARRAY unnested) the curve metrics are for. + */ + value?: string | null; + } + /** + * Metrics for a single confidence threshold. + */ + export interface Schema$XPSTablesConfidenceMetricsEntry { + /** + * The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * The harmonic mean of recall and precision. (2 * precision * recall) / (precision + recall) + */ + f1Score?: number | null; + /** + * False negative count. + */ + falseNegativeCount?: string | null; + /** + * False positive count. + */ + falsePositiveCount?: string | null; + /** + * FPR = #false positives / (#false positives + #true negatives) + */ + falsePositiveRate?: number | null; + /** + * Precision = #true positives / (#true positives + #false positives). + */ + precision?: number | null; + /** + * Recall = #true positives / (#true positives + #false negatives). + */ + recall?: number | null; + /** + * True negative count. + */ + trueNegativeCount?: string | null; + /** + * True positive count. + */ + truePositiveCount?: string | null; + /** + * TPR = #true positives / (#true positives + #false negatvies) + */ + truePositiveRate?: number | null; + } + /** + * Metadata for a dataset used for AutoML Tables. Next ID: 6 + */ + export interface Schema$XPSTablesDatasetMetadata { + /** + * Id the column to split the table. + */ + mlUseColumnId?: number | null; + /** + * Primary table. + */ + primaryTableSpec?: Schema$XPSTableSpec; + /** + * (the column id : its CorrelationStats with target column). + */ + targetColumnCorrelations?: { + [key: string]: Schema$XPSCorrelationStats; + } | null; + /** + * Id of the primary table column that should be used as the training label. + */ + targetColumnId?: number | null; + /** + * Id of the primary table column that should be used as the weight column. + */ + weightColumnId?: number | null; + } + export interface Schema$XPSTablesEvaluationMetrics { + /** + * Classification metrics. + */ + classificationMetrics?: Schema$XPSTablesClassificationMetrics; + /** + * Regression metrics. + */ + regressionMetrics?: Schema$XPSTablesRegressionMetrics; + } + /** + * An information specific to given column and Tables Model, in context of the Model and the predictions created by it. + */ + export interface Schema$XPSTablesModelColumnInfo { + /** + * The ID of the column. + */ + columnId?: number | null; + /** + * When given as part of a Model: Measurement of how much model predictions correctness on the TEST data depend on values in this column. A value between 0 and 1, higher means higher influence. These values are normalized - for all input feature columns of a given model they add to 1. When given back by Predict or Batch Predict: Measurement of how impactful for the prediction returned for the given row the value in this column was. Specifically, the feature importance specifies the marginal contribution that the feature made to the prediction score compared to the baseline score. These values are computed using the Sampled Shapley method. + */ + featureImportance?: number | null; + } + /** + * A description of Tables model structure. + */ + export interface Schema$XPSTablesModelStructure { + /** + * A list of models. + */ + modelParameters?: Schema$XPSTablesModelStructureModelParameters[]; + } + /** + * Model hyper-parameters for a model. + */ + export interface Schema$XPSTablesModelStructureModelParameters { + hyperparameters?: Schema$XPSTablesModelStructureModelParametersParameter[]; + } + export interface Schema$XPSTablesModelStructureModelParametersParameter { + /** + * Float type parameter value. + */ + floatValue?: number | null; + /** + * Integer type parameter value. + */ + intValue?: string | null; + /** + * Parameter name. + */ + name?: string | null; + /** + * String type parameter value. + */ + stringValue?: string | null; + } + export interface Schema$XPSTableSpec { + /** + * Mapping from column id to column spec. + */ + columnSpecs?: {[key: string]: Schema$XPSColumnSpec} | null; + /** + * The total size of imported data of the table. + */ + importedDataSizeInBytes?: string | null; + /** + * The number of rows in the table. + */ + rowCount?: string | null; + /** + * The id of the time column. + */ + timeColumnId?: number | null; + /** + * The number of valid rows. + */ + validRowCount?: string | null; + } + export interface Schema$XPSTablesPreprocessResponse { + /** + * The table/column id, column_name and the DataTypes of the columns will be populated. + */ + tablesDatasetMetadata?: Schema$XPSTablesDatasetMetadata; + } + /** + * Metrics for Tables regression problems. + */ + export interface Schema$XPSTablesRegressionMetrics { + /** + * Mean absolute error. + */ + meanAbsoluteError?: number | null; + /** + * Mean absolute percentage error, only set if all of the target column's values are positive. + */ + meanAbsolutePercentageError?: number | null; + /** + * A list of actual versus predicted points for the model being evaluated. + */ + regressionMetricsEntries?: Schema$XPSRegressionMetricsEntry[]; + /** + * Root mean squared error. + */ + rootMeanSquaredError?: number | null; + /** + * Root mean squared log error. + */ + rootMeanSquaredLogError?: number | null; + /** + * R squared. + */ + rSquared?: number | null; + } + export interface Schema$XPSTablesTrainingOperationMetadata { + /** + * Current stage of creating model. + */ + createModelStage?: string | null; + /** + * The optimization objective for model. + */ + optimizationObjective?: string | null; + /** + * This field is for training. When the operation is terminated successfully, AutoML Backend post this field to operation metadata in spanner. If the metadata has no trials returned, the training operation is supposed to be a failure. + */ + topTrials?: Schema$XPSTuningTrial[]; + /** + * Creating model budget. + */ + trainBudgetMilliNodeHours?: string | null; + /** + * This field records the training objective value with respect to time, giving insight into how the model architecture search is performing as training time elapses. + */ + trainingObjectivePoints?: Schema$XPSTrainingObjectivePoint[]; + /** + * Timestamp when training process starts. + */ + trainingStartTime?: string | null; + } + export interface Schema$XPSTablesTrainResponse { + modelStructure?: Schema$XPSTablesModelStructure; + /** + * Sample rows from the dataset this model was trained. + */ + predictionSampleRows?: Schema$XPSRow[]; + /** + * Output only. Auxiliary information for each of the input_feature_column_specs, with respect to this particular model. + */ + tablesModelColumnInfo?: Schema$XPSTablesModelColumnInfo[]; + /** + * The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget. + */ + trainCostMilliNodeHours?: string | null; + } + /** + * Component model. Next ID: 10 + */ + export interface Schema$XPSTextComponentModel { + /** + * The Cloud Storage resource path to hold batch prediction model. + */ + batchPredictionModelGcsUri?: string | null; + /** + * The Cloud Storage resource path to hold online prediction model. + */ + onlinePredictionModelGcsUri?: string | null; + /** + * The partition where the model is deployed. Populated by uCAIP BE as part of online PredictRequest. + */ + partition?: string | null; + /** + * The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud Ai Platform API. + */ + servingArtifact?: Schema$XPSModelArtifactItem; + /** + * The name of servo model. Populated by uCAIP BE as part of online PredictRequest. + */ + servoModelName?: string | null; + /** + * The name of the trained NL submodel. + */ + submodelName?: string | null; + /** + * The type of trained NL submodel + */ + submodelType?: string | null; + /** + * ## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list + */ + tfRuntimeVersion?: string | null; + /** + * The servomatic model version number. Populated by uCAIP BE as part of online PredictRequest. + */ + versionNumber?: string | null; + } + export interface Schema$XPSTextExtractionEvaluationMetrics { + /** + * Values are at the highest F1 score on the precision-recall curve. Only confidence_threshold, recall, precision, and f1_score will be set. + */ + bestF1ConfidenceMetrics?: Schema$XPSConfidenceMetricsEntry; + /** + * If the enclosing EvaluationMetrics.label is empty, confidence_metrics_entries is an evaluation of the entire model across all labels. If the enclosing EvaluationMetrics.label is set, confidence_metrics_entries applies to that label. + */ + confidenceMetricsEntries?: Schema$XPSConfidenceMetricsEntry[]; + /** + * Confusion matrix of the model, at the default confidence threshold (0.0). Only set for whole-model evaluation, not for evaluation per label. + */ + confusionMatrix?: Schema$XPSConfusionMatrix; + /** + * Only recall, precision, and f1_score will be set. + */ + perLabelConfidenceMetrics?: { + [key: string]: Schema$XPSConfidenceMetricsEntry; + } | null; + } + /** + * Model evaluation metrics for text sentiment problems. + */ + export interface Schema$XPSTextSentimentEvaluationMetrics { + /** + * Output only. Confusion matrix of the evaluation. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + confusionMatrix?: Schema$XPSConfusionMatrix; + /** + * Output only. The harmonic mean of recall and precision. + */ + f1Score?: number | null; + /** + * Output only. Linear weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + linearKappa?: number | null; + /** + * Output only. Mean absolute error. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + meanAbsoluteError?: number | null; + /** + * Output only. Mean squared error. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + meanSquaredError?: number | null; + /** + * Output only. Precision. + */ + precision?: number | null; + /** + * Output only. Quadratic weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + */ + quadraticKappa?: number | null; + /** + * Output only. Recall. + */ + recall?: number | null; + } + /** + * TextToSpeech train response + */ + export interface Schema$XPSTextToSpeechTrainResponse {} + export interface Schema$XPSTextTrainResponse { + /** + * Component submodels. + */ + componentModel?: Schema$XPSTextComponentModel[]; + } + /** + * A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. + */ + export interface Schema$XPSTfJsFormat {} + /** + * LINT.IfChange A model format used for mobile and IoT devices. See https://www.tensorflow.org/lite. + */ + export interface Schema$XPSTfLiteFormat {} + /** + * A tensorflow model format in SavedModel format. + */ + export interface Schema$XPSTfSavedModelFormat {} + /** + * The data statistics of a series of TIMESTAMP values. + */ + export interface Schema$XPSTimestampStats { + commonStats?: Schema$XPSCommonStats; + /** + * The string key is the pre-defined granularity. Currently supported: hour_of_day, day_of_week, month_of_year. Granularities finer that the granularity of timestamp data are not populated (e.g. if timestamps are at day granularity, then hour_of_day is not populated). + */ + granularStats?: { + [key: string]: Schema$XPSTimestampStatsGranularStats; + } | null; + medianTimestampNanos?: string | null; + } + /** + * Stats split by a defined in context granularity. + */ + export interface Schema$XPSTimestampStatsGranularStats { + /** + * A map from granularity key to example count for that key. E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means May). + */ + buckets?: {[key: string]: string} | null; + } + /** + * Track matching model metrics for a single track match threshold and multiple label match confidence thresholds. Next tag: 6. + */ + export interface Schema$XPSTrackMetricsEntry { + /** + * Output only. Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them. + */ + confidenceMetricsEntries?: Schema$XPSTrackMetricsEntryConfidenceMetricsEntry[]; + /** + * Output only. The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry. + */ + iouThreshold?: number | null; + /** + * Output only. The mean bounding box iou over all confidence thresholds. + */ + meanBoundingBoxIou?: number | null; + /** + * Output only. The mean mismatch rate over all confidence thresholds. + */ + meanMismatchRate?: number | null; + /** + * Output only. The mean average precision over all confidence thresholds. + */ + meanTrackingAveragePrecision?: number | null; + } + /** + * Metrics for a single confidence threshold. Next tag: 6. + */ + export interface Schema$XPSTrackMetricsEntryConfidenceMetricsEntry { + /** + * Output only. Bounding box intersection-over-union precision. Measures how well the bounding boxes overlap between each other (e.g. complete overlap or just barely above iou_threshold). + */ + boundingBoxIou?: number | null; + /** + * Output only. The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * Output only. Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity. + */ + mismatchRate?: number | null; + /** + * Output only. Tracking precision. + */ + trackingPrecision?: number | null; + /** + * Output only. Tracking recall. + */ + trackingRecall?: number | null; + } + export interface Schema$XPSTrainingObjectivePoint { + /** + * The time at which this point was recorded. + */ + createTime?: string | null; + /** + * The objective value when this point was recorded. + */ + value?: number | null; + } + /** + * Next ID: 18 + */ + export interface Schema$XPSTrainResponse { + /** + * Estimated model size in bytes once deployed. + */ + deployedModelSizeBytes?: string | null; + /** + * Optional vision model error analysis configuration. The field is set when model error analysis is enabled in the training request. The results of error analysis will be binded together with evaluation results (in the format of AnnotatedExample). + */ + errorAnalysisConfigs?: Schema$XPSVisionErrorAnalysisConfig[]; + /** + * Examples used to evaluate the model (usually the test set), with the predicted annotations. The file_spec should point to recordio file(s) of AnnotatedExample. For each returned example, the example_id_token and annotations predicted by the model must be set. The example payload can and is recommended to be omitted. + */ + evaluatedExampleSet?: Schema$XPSExampleSet; + /** + * The trained model evaluation metrics. This can be optionally returned. + */ + evaluationMetricsSet?: Schema$XPSEvaluationMetricsSet; + /** + * VisionExplanationConfig for XAI on test set. Optional for when XAI is enable in training request. + */ + explanationConfigs?: Schema$XPSResponseExplanationSpec[]; + imageClassificationTrainResp?: Schema$XPSImageClassificationTrainResponse; + imageObjectDetectionTrainResp?: Schema$XPSImageObjectDetectionModelSpec; + imageSegmentationTrainResp?: Schema$XPSImageSegmentationTrainResponse; + /** + * Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model. + */ + modelToken?: string | null; + speechTrainResp?: Schema$XPSSpeechModelSpec; + tablesTrainResp?: Schema$XPSTablesTrainResponse; + textToSpeechTrainResp?: Schema$XPSTextToSpeechTrainResponse; + /** + * Will only be needed for uCAIP from Beta. + */ + textTrainResp?: Schema$XPSTextTrainResponse; + translationTrainResp?: Schema$XPSTranslationTrainResponse; + videoActionRecognitionTrainResp?: Schema$XPSVideoActionRecognitionTrainResponse; + videoClassificationTrainResp?: Schema$XPSVideoClassificationTrainResponse; + videoObjectTrackingTrainResp?: Schema$XPSVideoObjectTrackingTrainResponse; + } + /** + * Evaluation metrics for the dataset. + */ + export interface Schema$XPSTranslationEvaluationMetrics { + /** + * BLEU score for base model. + */ + baseBleuScore?: number | null; + /** + * BLEU score. + */ + bleuScore?: number | null; + } + /** + * Translation preprocess response. + */ + export interface Schema$XPSTranslationPreprocessResponse { + /** + * Total example count parsed. + */ + parsedExampleCount?: string | null; + /** + * Total valid example count. + */ + validExampleCount?: string | null; + } + /** + * Train response for translation. + */ + export interface Schema$XPSTranslationTrainResponse { + /** + * Type of the model. + */ + modelType?: string | null; + } + /** + * Metrics for a tuning job generated, will get forwarded to Stackdriver as model tuning logs. Setting this as a standalone message out of CreateModelMetadata to avoid confusion as we expose this message only to users. + */ + export interface Schema$XPSTuningTrial { + /** + * Model parameters for the trial. + */ + modelStructure?: Schema$XPSTablesModelStructure; + /** + * The optimization objective evaluation of the eval split data. + */ + trainingObjectivePoint?: Schema$XPSTrainingObjectivePoint; + } + /** + * The Evaluation metrics entry given a specific precision_window_length. + */ + export interface Schema$XPSVideoActionMetricsEntry { + /** + * Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + */ + confidenceMetricsEntries?: Schema$XPSVideoActionMetricsEntryConfidenceMetricsEntry[]; + /** + * The mean average precision. + */ + meanAveragePrecision?: number | null; + /** + * This VideoActionMetricsEntry is calculated based on this prediction window length. If the predicted action's timestamp is inside the time window whose center is the ground truth action's timestamp with this specific length, the prediction result is treated as a true positive. + */ + precisionWindowLength?: string | null; + } + /** + * Metrics for a single confidence threshold. + */ + export interface Schema$XPSVideoActionMetricsEntryConfidenceMetricsEntry { + /** + * Output only. The confidence threshold value used to compute the metrics. + */ + confidenceThreshold?: number | null; + /** + * Output only. The harmonic mean of recall and precision. + */ + f1Score?: number | null; + /** + * Output only. Precision for the given confidence threshold. + */ + precision?: number | null; + /** + * Output only. Recall for the given confidence threshold. + */ + recall?: number | null; + } + /** + * Model evaluation metrics for video action recognition. + */ + export interface Schema$XPSVideoActionRecognitionEvaluationMetrics { + /** + * Output only. The number of ground truth actions used to create this evaluation. + */ + evaluatedActionCount?: number | null; + /** + * Output only. The metric entries for precision window lengths: 1s,2s,3s,4s, 5s. + */ + videoActionMetricsEntries?: Schema$XPSVideoActionMetricsEntry[]; + } + export interface Schema$XPSVideoActionRecognitionTrainResponse { + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSVideoModelArtifactSpec; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + export interface Schema$XPSVideoBatchPredictOperationMetadata { + /** + * All the partial batch prediction results that are completed at the moment. Output examples are sorted by completion time. The order will not be changed. Each output example should be the path of a single RecordIO file of AnnotatedExamples. + */ + outputExamples?: string[] | null; + } + export interface Schema$XPSVideoClassificationTrainResponse { + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSVideoModelArtifactSpec; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + /** + * Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format. + */ + export interface Schema$XPSVideoExportModelSpec { + /** + * Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files. + */ + exportModelOutputConfig?: Schema$XPSExportModelOutputConfig[]; + } + export interface Schema$XPSVideoModelArtifactSpec { + /** + * The model binary files in different formats for model export. + */ + exportArtifact?: Schema$XPSModelArtifactItem[]; + /** + * The default model binary file used for serving (e.g. batch predict) via public Cloud AI Platform API. + */ + servingArtifact?: Schema$XPSModelArtifactItem; + } + /** + * Model evaluation metrics for ObjectTracking problems. Next tag: 10. + */ + export interface Schema$XPSVideoObjectTrackingEvaluationMetrics { + /** + * Output only. The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries. + */ + boundingBoxMeanAveragePrecision?: number | null; + /** + * Output only. The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + */ + boundingBoxMetricsEntries?: Schema$XPSBoundingBoxMetricsEntry[]; + /** + * The number of bounding boxes used for model evaluation. + */ + evaluatedBoundingboxCount?: number | null; + /** + * The number of video frames used for model evaluation. + */ + evaluatedFrameCount?: number | null; + /** + * The number of tracks used for model evaluation. + */ + evaluatedTrackCount?: number | null; + /** + * Output only. The single metric for tracks accuracy evaluation: the mean_average_precision averaged over all track_metrics_entries. + */ + trackMeanAveragePrecision?: number | null; + /** + * Output only. The single metric for tracks bounding box iou evaluation: the mean_bounding_box_iou averaged over all track_metrics_entries. + */ + trackMeanBoundingBoxIou?: number | null; + /** + * Output only. The single metric for tracking consistency evaluation: the mean_mismatch_rate averaged over all track_metrics_entries. + */ + trackMeanMismatchRate?: number | null; + /** + * Output only. The tracks match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + */ + trackMetricsEntries?: Schema$XPSTrackMetricsEntry[]; + } + export interface Schema$XPSVideoObjectTrackingTrainResponse { + /** + * Populated for AutoML request only. + */ + exportModelSpec?: Schema$XPSVideoExportModelSpec; + /** + * ## The fields below are only populated under uCAIP request scope. + */ + modelArtifactSpec?: Schema$XPSVideoModelArtifactSpec; + /** + * The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. + */ + trainCostNodeSeconds?: string | null; + } + export interface Schema$XPSVideoTrainingOperationMetadata { + /** + * This is an estimation of the node hours necessary for training a model, expressed in milli node hours (i.e. 1,000 value in this field means 1 node hour). A node hour represents the time a virtual machine spends running your training job. The cost of one node running for one hour is a node hour. + */ + trainCostMilliNodeHour?: string | null; + } + /** + * The vision model error analysis configuration. Next tag: 3 + */ + export interface Schema$XPSVisionErrorAnalysisConfig { + /** + * The number of query examples in error analysis. + */ + exampleCount?: number | null; + /** + * The query type used in retrieval. The enum values are frozen in the foreseeable future. + */ + queryType?: string | null; + } + export interface Schema$XPSVisionTrainingOperationMetadata { + /** + * Aggregated infra usage within certain time period, for billing report purpose if XAI is enable in training request. + */ + explanationUsage?: Schema$InfraUsage; + } + /** + * Visualization configurations for image explanation. + */ + export interface Schema$XPSVisualization { + /** + * Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62. + */ + clipPercentLowerbound?: number | null; + /** + * Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9. + */ + clipPercentUpperbound?: number | null; + /** + * The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue. + */ + colorMap?: string | null; + /** + * How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE. + */ + overlayType?: string | null; + /** + * Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE. + */ + polarity?: string | null; + /** + * Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES. + */ + type?: string | null; + } + export interface Schema$XPSXpsOperationMetadata { + /** + * Optional. XPS server can opt to provide example count of the long running operation (e.g. training, data importing, batch prediction). + */ + exampleCount?: string | null; + /** + * Metrics for the operation. By the time the operation is terminated (whether succeeded or failed) as returned from XPS, AutoML BE assumes the metrics are finalized. AutoML BE transparently posts the metrics to Chemist if it's not empty, regardless of the response content or error type. If user is supposed to be charged in case of cancellation/error, this field should be set. In the case where the type of LRO doesn't require any billing, this field should be left unset. + */ + reportingMetrics?: Schema$XPSReportingMetrics; + tablesTrainingOperationMetadata?: Schema$XPSTablesTrainingOperationMetadata; + videoBatchPredictOperationMetadata?: Schema$XPSVideoBatchPredictOperationMetadata; + videoTrainingOperationMetadata?: Schema$XPSVideoTrainingOperationMetadata; + visionTrainingOperationMetadata?: Schema$XPSVisionTrainingOperationMetadata; + } + /** + * An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Only supports image Models (modality is IMAGE). + */ + export interface Schema$XPSXraiAttribution { + /** + * The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively. + */ + stepCount?: number | null; + } export class Resource$Documents { context: APIRequestContext; From 2df1a80842487da7f97dae86d145ec16aec79c62 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 48/78] feat(logging)!: update the API BREAKING CHANGE: This release has breaking changes. #### logging:v2 The following keys were deleted: - schemas.Settings.properties.analyticsMode.description - schemas.Settings.properties.analyticsMode.enum - schemas.Settings.properties.analyticsMode.enumDescriptions - schemas.Settings.properties.analyticsMode.type The following keys were added: - schemas.CopyLogEntriesMetadata.properties.request.deprecated - schemas.SavedQuery.properties.visibility.description - schemas.SavedQuery.properties.visibility.enum - schemas.SavedQuery.properties.visibility.enumDescriptions - schemas.SavedQuery.properties.visibility.type The following keys were changed: - endpoints - resources.billingAccounts.resources.locations.resources.buckets.methods.create.parameters.bucketId.description - resources.billingAccounts.resources.locations.resources.buckets.methods.createAsync.parameters.bucketId.description - resources.folders.resources.locations.resources.buckets.methods.create.parameters.bucketId.description - resources.folders.resources.locations.resources.buckets.methods.createAsync.parameters.bucketId.description - resources.locations.resources.buckets.methods.create.parameters.bucketId.description - resources.locations.resources.buckets.methods.createAsync.parameters.bucketId.description - resources.organizations.resources.locations.resources.buckets.methods.create.parameters.bucketId.description - resources.organizations.resources.locations.resources.buckets.methods.createAsync.parameters.bucketId.description - resources.projects.resources.locations.resources.buckets.methods.create.parameters.bucketId.description - resources.projects.resources.locations.resources.buckets.methods.createAsync.parameters.bucketId.description - schemas.CopyLogEntriesMetadata.properties.request.description - schemas.CreateBucketRequest.properties.bucketId.description - schemas.LogBucket.properties.analyticsEnabled.description - schemas.SavedQuery.properties.displayName.description --- discovery/logging-v2.json | 134 +++++++++++++++++++++++++++++--------- src/apis/logging/v2.ts | 36 +++++----- 2 files changed, 123 insertions(+), 47 deletions(-) diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 07503e649f2..7fe5e8b1529 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -28,10 +28,85 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/logging/docs/", "endpoints": [ + { + "endpointUrl": "https://logging.europe-west3.rep.googleapis.com/", + "location": "europe-west3", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.europe-west8.rep.googleapis.com/", + "location": "europe-west8", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.europe-west9.rep.googleapis.com/", + "location": "europe-west9", + "description": "Regional Endpoint" + }, { "endpointUrl": "https://logging.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-central1.rep.googleapis.com/", + "location": "us-central1", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-central2.rep.googleapis.com/", + "location": "us-central2", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-east1.rep.googleapis.com/", + "location": "us-east1", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-east4.rep.googleapis.com/", + "location": "us-east4", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-east5.rep.googleapis.com/", + "location": "us-east5", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-east7.rep.googleapis.com/", + "location": "us-east7", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-south1.rep.googleapis.com/", + "location": "us-south1", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-west1.rep.googleapis.com/", + "location": "us-west1", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-west2.rep.googleapis.com/", + "location": "us-west2", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-west3.rep.googleapis.com/", + "location": "us-west3", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-west4.rep.googleapis.com/", + "location": "us-west4", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://logging.us-west8.rep.googleapis.com/", + "location": "us-west8", + "description": "Regional Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -433,7 +508,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -467,7 +542,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -2181,7 +2256,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -2215,7 +2290,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -3427,7 +3502,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -3461,7 +3536,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -4573,7 +4648,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -4607,7 +4682,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -6040,7 +6115,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -6074,7 +6149,7 @@ ], "parameters": { "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query", "type": "string" }, @@ -7668,7 +7743,7 @@ } } }, - "revision": "20240207", + "revision": "20240301", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryDataset": { @@ -7824,7 +7899,8 @@ }, "request": { "$ref": "CopyLogEntriesRequest", - "description": "CopyLogEntries RPC request." + "deprecated": true, + "description": "CopyLogEntries RPC request. This field is deprecated and not used." }, "source": { "description": "Source from which to copy log entries.For example, a log bucket:\"projects/my-project/locations/global/buckets/my-source-bucket\"", @@ -7911,7 +7987,7 @@ "description": "Required. The new bucket. The region specified in the new bucket must be compliant with any Location Restriction Org Policy. The name field in the bucket is ignored." }, "bucketId": { - "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-bucket\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "type": "string" }, "parent": { @@ -8614,7 +8690,7 @@ "id": "LogBucket", "properties": { "analyticsEnabled": { - "description": "Optional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.", + "description": "Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.", "type": "boolean" }, "cmekSettings": { @@ -9665,7 +9741,7 @@ "type": "string" }, "displayName": { - "description": "Optional. The user specified title for the SavedQuery.", + "description": "Required. The user specified title for the SavedQuery.", "type": "string" }, "loggingQuery": { @@ -9686,6 +9762,20 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "visibility": { + "description": "Required. The visibility status of this query, which determines its ownership.", + "enum": [ + "VISIBILITY_UNSPECIFIED", + "PRIVATE", + "SHARED" + ], + "enumDescriptions": [ + "The saved query visibility is unspecified. A CreateSavedQuery request with an unspecified visibility will be rejected.", + "The saved query is only visible to the user that created it.", + "The saved query is visible to anyone in the project." + ], + "type": "string" } }, "type": "object" @@ -9694,20 +9784,6 @@ "description": "Describes the settings associated with a project, folder, organization, or billing account.", "id": "Settings", "properties": { - "analyticsMode": { - "description": "Optional. The default analytics mode of an org or folder which is inherited by all newly created child project buckets.", - "enum": [ - "ANALYTICS_MODE_UNSPECIFIED", - "ANALYTICS_ENABLED", - "ANALYTICS_DISABLED" - ], - "enumDescriptions": [ - "No default analytics mode defined at this resource level, it will inherit from the closest ancester which has a defined analytics mode. If there is no specified analytics mode across the resource hierarchy, analytics will be disabled by default.", - "By default, analytics will be enabled for all new project-level buckets unless explicitly specified otherwise at bucket creation time.", - "By default, analytics will be disabled for new project-level buckets unless explicitly specified otherwise at bucket creation time." - ], - "type": "string" - }, "defaultSinkConfig": { "$ref": "DefaultSinkConfig", "description": "Optional. Overrides the built-in configuration for _Default sink." diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 7eeda85f15f..a945f7aa9c0 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -255,7 +255,7 @@ export namespace logging_v2 { */ progress?: number | null; /** - * CopyLogEntries RPC request. + * CopyLogEntries RPC request. This field is deprecated and not used. */ request?: Schema$CopyLogEntriesRequest; /** @@ -314,7 +314,7 @@ export namespace logging_v2 { */ bucket?: Schema$LogBucket; /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string | null; /** @@ -806,7 +806,7 @@ export namespace logging_v2 { */ export interface Schema$LogBucket { /** - * Optional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. + * Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. */ analyticsEnabled?: boolean | null; /** @@ -1527,7 +1527,7 @@ export namespace logging_v2 { */ description?: string | null; /** - * Optional. The user specified title for the SavedQuery. + * Required. The user specified title for the SavedQuery. */ displayName?: string | null; /** @@ -1546,15 +1546,15 @@ export namespace logging_v2 { * Output only. The timestamp when the saved query was last updated. */ updateTime?: string | null; + /** + * Required. The visibility status of this query, which determines its ownership. + */ + visibility?: string | null; } /** * Describes the settings associated with a project, folder, organization, or billing account. */ export interface Schema$Settings { - /** - * Optional. The default analytics mode of an org or folder which is inherited by all newly created child project buckets. - */ - analyticsMode?: string | null; /** * Optional. Overrides the built-in configuration for _Default sink. */ @@ -3375,7 +3375,7 @@ export namespace logging_v2 { export interface Params$Resource$Billingaccounts$Locations$Buckets$Create extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -3391,7 +3391,7 @@ export namespace logging_v2 { export interface Params$Resource$Billingaccounts$Locations$Buckets$Createasync extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -8655,7 +8655,7 @@ export namespace logging_v2 { export interface Params$Resource$Folders$Locations$Buckets$Create extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -8671,7 +8671,7 @@ export namespace logging_v2 { export interface Params$Resource$Folders$Locations$Buckets$Createasync extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -12236,7 +12236,7 @@ export namespace logging_v2 { export interface Params$Resource$Locations$Buckets$Create extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -12252,7 +12252,7 @@ export namespace logging_v2 { export interface Params$Resource$Locations$Buckets$Createasync extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -15696,7 +15696,7 @@ export namespace logging_v2 { export interface Params$Resource$Organizations$Locations$Buckets$Create extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -15712,7 +15712,7 @@ export namespace logging_v2 { export interface Params$Resource$Organizations$Locations$Buckets$Createasync extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -20007,7 +20007,7 @@ export namespace logging_v2 { export interface Params$Resource$Projects$Locations$Buckets$Create extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** @@ -20023,7 +20023,7 @@ export namespace logging_v2 { export interface Params$Resource$Projects$Locations$Buckets$Createasync extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ bucketId?: string; /** From 36a47c8bb2e52a76b00ca635b108bb94b406e0ce Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 49/78] feat(looker)!: update the API BREAKING CHANGE: This release has breaking changes. #### looker:v1 The following keys were deleted: - schemas.Instance.properties.pscConfig.$ref - schemas.Instance.properties.pscConfig.description - schemas.Instance.properties.pscEnabled.description - schemas.Instance.properties.pscEnabled.type - schemas.PscConfig.description - schemas.PscConfig.id - schemas.PscConfig.properties.allowedVpcs.description - schemas.PscConfig.properties.allowedVpcs.items.type - schemas.PscConfig.properties.allowedVpcs.type - schemas.PscConfig.properties.lookerServiceAttachmentUri.description - schemas.PscConfig.properties.lookerServiceAttachmentUri.readOnly - schemas.PscConfig.properties.lookerServiceAttachmentUri.type - schemas.PscConfig.properties.serviceAttachments.description - schemas.PscConfig.properties.serviceAttachments.items.$ref - schemas.PscConfig.properties.serviceAttachments.type - schemas.PscConfig.type - schemas.ServiceAttachment.description - schemas.ServiceAttachment.id - schemas.ServiceAttachment.properties.connectionStatus.description - schemas.ServiceAttachment.properties.connectionStatus.enum - schemas.ServiceAttachment.properties.connectionStatus.enumDescriptions - schemas.ServiceAttachment.properties.connectionStatus.readOnly - schemas.ServiceAttachment.properties.connectionStatus.type - schemas.ServiceAttachment.properties.localFqdn.description - schemas.ServiceAttachment.properties.localFqdn.type - schemas.ServiceAttachment.properties.targetServiceAttachmentUri.description - schemas.ServiceAttachment.properties.targetServiceAttachmentUri.type - schemas.ServiceAttachment.type The following keys were added: - schemas.Instance.properties.linkedLspProjectNumber.description - schemas.Instance.properties.linkedLspProjectNumber.format - schemas.Instance.properties.linkedLspProjectNumber.type --- discovery/looker-v1.json | 77 ++++------------------------------------ src/apis/looker/v1.ts | 46 +++--------------------- 2 files changed, 10 insertions(+), 113 deletions(-) diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index fb50847bb87..f25a3cf3b7d 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -731,7 +731,7 @@ } } }, - "revision": "20240220", + "revision": "20240307", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1107,6 +1107,11 @@ "description": "Output only. Last computed maintenance denial period for this instance.", "readOnly": true }, + "linkedLspProjectNumber": { + "description": "Optional. Linked Google Cloud Project Number for Looker Studio Pro.", + "format": "int64", + "type": "string" + }, "lookerUri": { "description": "Output only. Looker instance URI which can be used to access the Looker Instance UI.", "readOnly": true, @@ -1158,14 +1163,6 @@ "description": "Whether private IP is enabled on the Looker instance.", "type": "boolean" }, - "pscConfig": { - "$ref": "PscConfig", - "description": "Optional. PSC configuration. Used when `enable_private_ip` and `psc_enabled` are both true." - }, - "pscEnabled": { - "description": "Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, VPC peering (PSA) will not be used.", - "type": "boolean" - }, "publicIpEnabled": { "description": "Whether public IP is enabled on the Looker instance.", "type": "boolean" @@ -1479,74 +1476,12 @@ }, "type": "object" }, - "PscConfig": { - "description": "Information for Private Service Connect (PSC) setup for a Looker instance.", - "id": "PscConfig", - "properties": { - "allowedVpcs": { - "description": "Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}", - "items": { - "type": "string" - }, - "type": "array" - }, - "lookerServiceAttachmentUri": { - "description": "Output only. URI of the Looker service attachment.", - "readOnly": true, - "type": "string" - }, - "serviceAttachments": { - "description": "Optional. List of egress service attachment configurations.", - "items": { - "$ref": "ServiceAttachment" - }, - "type": "array" - } - }, - "type": "object" - }, "RestartInstanceRequest": { "description": "Request options for restarting an instance.", "id": "RestartInstanceRequest", "properties": {}, "type": "object" }, - "ServiceAttachment": { - "description": "Service attachment configuration.", - "id": "ServiceAttachment", - "properties": { - "connectionStatus": { - "description": "Output only. Connection status.", - "enum": [ - "UNKNOWN", - "ACCEPTED", - "PENDING", - "REJECTED", - "NEEDS_ATTENTION", - "CLOSED" - ], - "enumDescriptions": [ - "Connection status is unspecified.", - "Connection is established and functioning normally.", - "Connection is not established (Looker tenant project hasn't been allowlisted).", - "Connection is not established (Looker tenant project is explicitly in reject list).", - "Issue with target service attachment, e.g. NAT subnet is exhausted.", - "Target service attachment does not exist. This status is a terminal state." - ], - "readOnly": true, - "type": "string" - }, - "localFqdn": { - "description": "Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment.", - "type": "string" - }, - "targetServiceAttachmentUri": { - "description": "Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}", - "type": "string" - } - }, - "type": "object" - }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index 5aa3624953b..55e434ba7ee 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -387,6 +387,10 @@ export namespace looker_v1 { * Output only. Last computed maintenance denial period for this instance. */ lastDenyMaintenancePeriod?: Schema$DenyMaintenancePeriod; + /** + * Optional. Linked Google Cloud Project Number for Looker Studio Pro. + */ + linkedLspProjectNumber?: string | null; /** * Output only. Looker instance URI which can be used to access the Looker Instance UI. */ @@ -419,14 +423,6 @@ export namespace looker_v1 { * Whether private IP is enabled on the Looker instance. */ privateIpEnabled?: boolean | null; - /** - * Optional. PSC configuration. Used when `enable_private_ip` and `psc_enabled` are both true. - */ - pscConfig?: Schema$PscConfig; - /** - * Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, VPC peering (PSA) will not be used. - */ - pscEnabled?: boolean | null; /** * Whether public IP is enabled on the Looker instance. */ @@ -634,44 +630,10 @@ export namespace looker_v1 { */ version?: number | null; } - /** - * Information for Private Service Connect (PSC) setup for a Looker instance. - */ - export interface Schema$PscConfig { - /** - * Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project\}/global/networks/{network\} - */ - allowedVpcs?: string[] | null; - /** - * Output only. URI of the Looker service attachment. - */ - lookerServiceAttachmentUri?: string | null; - /** - * Optional. List of egress service attachment configurations. - */ - serviceAttachments?: Schema$ServiceAttachment[]; - } /** * Request options for restarting an instance. */ export interface Schema$RestartInstanceRequest {} - /** - * Service attachment configuration. - */ - export interface Schema$ServiceAttachment { - /** - * Output only. Connection status. - */ - connectionStatus?: string | null; - /** - * Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. - */ - localFqdn?: string | null; - /** - * Required. URI of the service attachment to connect to. Format: projects/{project\}/regions/{region\}/serviceAttachments/{service_attachment\} - */ - targetServiceAttachmentUri?: string | null; - } /** * Request message for `SetIamPolicy` method. */ From 0fd37f9c20fcd20cd4bb14ebea028b2ab95cd975 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 50/78] fix(marketingplatformadmin): update the API --- discovery/marketingplatformadmin-v1alpha.json | 336 ++++++++++ src/apis/marketingplatformadmin/README.md | 28 + src/apis/marketingplatformadmin/index.ts | 50 ++ src/apis/marketingplatformadmin/package.json | 43 ++ src/apis/marketingplatformadmin/tsconfig.json | 10 + src/apis/marketingplatformadmin/v1alpha.ts | 621 ++++++++++++++++++ .../marketingplatformadmin/webpack.config.js | 79 +++ 7 files changed, 1167 insertions(+) create mode 100644 discovery/marketingplatformadmin-v1alpha.json create mode 100644 src/apis/marketingplatformadmin/README.md create mode 100644 src/apis/marketingplatformadmin/index.ts create mode 100644 src/apis/marketingplatformadmin/package.json create mode 100644 src/apis/marketingplatformadmin/tsconfig.json create mode 100644 src/apis/marketingplatformadmin/v1alpha.ts create mode 100644 src/apis/marketingplatformadmin/webpack.config.js diff --git a/discovery/marketingplatformadmin-v1alpha.json b/discovery/marketingplatformadmin-v1alpha.json new file mode 100644 index 00000000000..32713e62cc4 --- /dev/null +++ b/discovery/marketingplatformadmin-v1alpha.json @@ -0,0 +1,336 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read": { + "description": "View your Google Analytics product account data in GMP home" + }, + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update": { + "description": "Manage your Google Analytics product account data in GMP home" + } + } + } + }, + "basePath": "", + "baseUrl": "https://marketingplatformadmin.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Google Marketing Platform Admin API", + "description": "The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, set the service level of your GA4 properties.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/analytics/devguides/config/gmp/v1", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "marketingplatformadmin:v1alpha", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://marketingplatformadmin.mtls.googleapis.com/", + "name": "marketingplatformadmin", + "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": { + "organizations": { + "resources": { + "analyticsAccountLinks": { + "methods": { + "create": { + "description": "Creates the link between the Analytics account and the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.", + "flatPath": "v1alpha/organizations/{organizationsId}/analyticsAccountLinks", + "httpMethod": "POST", + "id": "marketingplatformadmin.organizations.analyticsAccountLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id}", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/analyticsAccountLinks", + "request": { + "$ref": "AnalyticsAccountLink" + }, + "response": { + "$ref": "AnalyticsAccountLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" + ] + }, + "delete": { + "description": "Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account in order to delete the link.", + "flatPath": "v1alpha/organizations/{organizationsId}/analyticsAccountLinks/{analyticsAccountLinksId}", + "httpMethod": "DELETE", + "id": "marketingplatformadmin.organizations.analyticsAccountLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}", + "location": "path", + "pattern": "^organizations/[^/]+/analyticsAccountLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" + ] + }, + "list": { + "description": "Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.", + "flatPath": "v1alpha/organizations/{organizationsId}/analyticsAccountLinks", + "httpMethod": "GET", + "id": "marketingplatformadmin.organizations.analyticsAccountLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of Analytics account links to return in one call. The service may return fewer than this value. If unspecified, at most 50 Analytics account links will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous ListAnalyticsAccountLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnalyticsAccountLinks` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id}", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/analyticsAccountLinks", + "response": { + "$ref": "ListAnalyticsAccountLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" + ] + }, + "setPropertyServiceLevel": { + "description": "Updates the service level for an Analytics property.", + "flatPath": "v1alpha/organizations/{organizationsId}/analyticsAccountLinks/{analyticsAccountLinksId}:setPropertyServiceLevel", + "httpMethod": "POST", + "id": "marketingplatformadmin.organizations.analyticsAccountLinks.setPropertyServiceLevel", + "parameterOrder": [ + "analyticsAccountLink" + ], + "parameters": { + "analyticsAccountLink": { + "description": "Required. The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}", + "location": "path", + "pattern": "^organizations/[^/]+/analyticsAccountLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+analyticsAccountLink}:setPropertyServiceLevel", + "request": { + "$ref": "SetPropertyServiceLevelRequest" + }, + "response": { + "$ref": "SetPropertyServiceLevelResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" + ] + } + } + } + } + } + }, + "revision": "20240313", + "rootUrl": "https://marketingplatformadmin.googleapis.com/", + "schemas": { + "AnalyticsAccountLink": { + "description": "A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.", + "id": "AnalyticsAccountLink", + "properties": { + "analyticsAccount": { + "description": "Required. Immutable. The resource name of the AnalyticsAdmin API account. The account ID will be used as the ID of this AnalyticsAccountLink resource, which will become the final component of the resource name. Format: analyticsadmin.googleapis.com/accounts/{account_id}", + "type": "string" + }, + "displayName": { + "description": "Output only. The human-readable name for the Analytics account.", + "readOnly": true, + "type": "string" + }, + "linkVerificationState": { + "description": "Output only. The verification state of the link between the Analytics account and the parent organization.", + "enum": [ + "LINK_VERIFICATION_STATE_UNSPECIFIED", + "LINK_VERIFICATION_STATE_VERIFIED", + "LINK_VERIFICATION_STATE_NOT_VERIFIED" + ], + "enumDescriptions": [ + "The link state is unknown.", + "The link is established.", + "The link is requested, but hasn't been approved by the product account admin." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. Resource name of this AnalyticsAccountLink. Note the resource ID is the same as the ID of the Analtyics account. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} Example: \"organizations/xyz/analyticsAccountLinks/1234\"", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ListAnalyticsAccountLinksResponse": { + "description": "Response message for ListAnalyticsAccountLinks RPC.", + "id": "ListAnalyticsAccountLinksResponse", + "properties": { + "analyticsAccountLinks": { + "description": "Analytics account links in this organization.", + "items": { + "$ref": "AnalyticsAccountLink" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "SetPropertyServiceLevelRequest": { + "description": "Request message for SetPropertyServiceLevel RPC.", + "id": "SetPropertyServiceLevelRequest", + "properties": { + "analyticsProperty": { + "description": "Required. The Analytics property to change the ServiceLevel setting. This field is the name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id}", + "type": "string" + }, + "serviceLevel": { + "description": "Required. The service level to set for this property.", + "enum": [ + "ANALYTICS_SERVICE_LEVEL_UNSPECIFIED", + "ANALYTICS_SERVICE_LEVEL_STANDARD", + "ANALYTICS_SERVICE_LEVEL_360" + ], + "enumDescriptions": [ + "Service level unspecified.", + "The standard version of Google Analytics.", + "The premium version of Google Analytics." + ], + "type": "string" + } + }, + "type": "object" + }, + "SetPropertyServiceLevelResponse": { + "description": "Response message for SetPropertyServiceLevel RPC.", + "id": "SetPropertyServiceLevelResponse", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "Google Marketing Platform Admin API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file diff --git a/src/apis/marketingplatformadmin/README.md b/src/apis/marketingplatformadmin/README.md new file mode 100644 index 00000000000..49afcda7679 --- /dev/null +++ b/src/apis/marketingplatformadmin/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# marketingplatformadmin + +> marketingplatformadmin.googleapis.com API. + +## Installation + +```sh +$ npm install @googleapis/marketingplatformadmin +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/marketingplatformadmin/classes/Marketingplatformadmin.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/main/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/main/.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/marketingplatformadmin/index.ts b/src/apis/marketingplatformadmin/index.ts new file mode 100644 index 00000000000..0990d661fe6 --- /dev/null +++ b/src/apis/marketingplatformadmin/index.ts @@ -0,0 +1,50 @@ +// 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 {marketingplatformadmin_v1alpha} from './v1alpha'; + +export const VERSIONS = { + v1alpha: marketingplatformadmin_v1alpha.Marketingplatformadmin, +}; + +export function marketingplatformadmin( + version: 'v1alpha' +): marketingplatformadmin_v1alpha.Marketingplatformadmin; +export function marketingplatformadmin( + options: marketingplatformadmin_v1alpha.Options +): marketingplatformadmin_v1alpha.Marketingplatformadmin; +export function marketingplatformadmin< + T = marketingplatformadmin_v1alpha.Marketingplatformadmin, +>( + this: GoogleConfigurable, + versionOrOptions: 'v1alpha' | marketingplatformadmin_v1alpha.Options +) { + return getAPI('marketingplatformadmin', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {marketingplatformadmin_v1alpha}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/marketingplatformadmin/package.json b/src/apis/marketingplatformadmin/package.json new file mode 100644 index 00000000000..6efe3a7fca1 --- /dev/null +++ b/src/apis/marketingplatformadmin/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/marketingplatformadmin", + "version": "0.1.0", + "description": "marketingplatformadmin", + "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": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/marketingplatformadmin/tsconfig.json b/src/apis/marketingplatformadmin/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/marketingplatformadmin/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/marketingplatformadmin/v1alpha.ts b/src/apis/marketingplatformadmin/v1alpha.ts new file mode 100644 index 00000000000..5d29cce7555 --- /dev/null +++ b/src/apis/marketingplatformadmin/v1alpha.ts @@ -0,0 +1,621 @@ +// 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/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, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace marketingplatformadmin_v1alpha { + export interface Options extends GlobalOptions { + version: 'v1alpha'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * 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; + } + + /** + * Google Marketing Platform Admin API + * + * The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, set the service level of your GA4 properties. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const marketingplatformadmin = google.marketingplatformadmin('v1alpha'); + * ``` + */ + export class Marketingplatformadmin { + context: APIRequestContext; + organizations: Resource$Organizations; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.organizations = new Resource$Organizations(this.context); + } + } + + /** + * A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization. + */ + export interface Schema$AnalyticsAccountLink { + /** + * Required. Immutable. The resource name of the AnalyticsAdmin API account. The account ID will be used as the ID of this AnalyticsAccountLink resource, which will become the final component of the resource name. Format: analyticsadmin.googleapis.com/accounts/{account_id\} + */ + analyticsAccount?: string | null; + /** + * Output only. The human-readable name for the Analytics account. + */ + displayName?: string | null; + /** + * Output only. The verification state of the link between the Analytics account and the parent organization. + */ + linkVerificationState?: string | null; + /** + * Identifier. Resource name of this AnalyticsAccountLink. Note the resource ID is the same as the ID of the Analtyics account. Format: organizations/{org_id\}/analyticsAccountLinks/{analytics_account_link_id\} Example: "organizations/xyz/analyticsAccountLinks/1234" + */ + name?: string | null; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * Response message for ListAnalyticsAccountLinks RPC. + */ + export interface Schema$ListAnalyticsAccountLinksResponse { + /** + * Analytics account links in this organization. + */ + analyticsAccountLinks?: Schema$AnalyticsAccountLink[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Request message for SetPropertyServiceLevel RPC. + */ + export interface Schema$SetPropertyServiceLevelRequest { + /** + * Required. The Analytics property to change the ServiceLevel setting. This field is the name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id\} + */ + analyticsProperty?: string | null; + /** + * Required. The service level to set for this property. + */ + serviceLevel?: string | null; + } + /** + * Response message for SetPropertyServiceLevel RPC. + */ + export interface Schema$SetPropertyServiceLevelResponse {} + + export class Resource$Organizations { + context: APIRequestContext; + analyticsAccountLinks: Resource$Organizations$Analyticsaccountlinks; + constructor(context: APIRequestContext) { + this.context = context; + this.analyticsAccountLinks = + new Resource$Organizations$Analyticsaccountlinks(this.context); + } + } + + export class Resource$Organizations$Analyticsaccountlinks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates the link between the Analytics account and the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Organizations$Analyticsaccountlinks$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Organizations$Analyticsaccountlinks$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Analyticsaccountlinks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Analyticsaccountlinks$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Analyticsaccountlinks$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Analyticsaccountlinks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Analyticsaccountlinks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Analyticsaccountlinks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://marketingplatformadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/analyticsAccountLinks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account in order to delete the link. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Organizations$Analyticsaccountlinks$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Organizations$Analyticsaccountlinks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Analyticsaccountlinks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Analyticsaccountlinks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Analyticsaccountlinks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Analyticsaccountlinks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Analyticsaccountlinks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Analyticsaccountlinks$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://marketingplatformadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the Google Analytics accounts link to the specified Google Marketing Platform organization. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Organizations$Analyticsaccountlinks$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Analyticsaccountlinks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Analyticsaccountlinks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Analyticsaccountlinks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Analyticsaccountlinks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Analyticsaccountlinks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Analyticsaccountlinks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Analyticsaccountlinks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://marketingplatformadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/analyticsAccountLinks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the service level for an Analytics property. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setPropertyServiceLevel( + params: Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel, + options: StreamMethodOptions + ): GaxiosPromise; + setPropertyServiceLevel( + params?: Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel, + options?: MethodOptions + ): GaxiosPromise; + setPropertyServiceLevel( + params: Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPropertyServiceLevel( + params: Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPropertyServiceLevel( + params: Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel, + callback: BodyResponseCallback + ): void; + setPropertyServiceLevel( + callback: BodyResponseCallback + ): void; + setPropertyServiceLevel( + paramsOrCallback?: + | Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://marketingplatformadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1alpha/{+analyticsAccountLink}:setPropertyServiceLevel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['analyticsAccountLink'], + pathParams: ['analyticsAccountLink'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Organizations$Analyticsaccountlinks$Create + extends StandardParameters { + /** + * Required. The parent resource where this Analytics account link will be created. Format: organizations/{org_id\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AnalyticsAccountLink; + } + export interface Params$Resource$Organizations$Analyticsaccountlinks$Delete + extends StandardParameters { + /** + * Required. The name of the Analytics account link to delete. Format: organizations/{org_id\}/analyticsAccountLinks/{analytics_account_link_id\} + */ + name?: string; + } + export interface Params$Resource$Organizations$Analyticsaccountlinks$List + extends StandardParameters { + /** + * Optional. The maximum number of Analytics account links to return in one call. The service may return fewer than this value. If unspecified, at most 50 Analytics account links will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous ListAnalyticsAccountLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnalyticsAccountLinks` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id\} + */ + parent?: string; + } + export interface Params$Resource$Organizations$Analyticsaccountlinks$Setpropertyservicelevel + extends StandardParameters { + /** + * Required. The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id\}/analyticsAccountLinks/{analytics_account_link_id\} + */ + analyticsAccountLink?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetPropertyServiceLevelRequest; + } +} diff --git a/src/apis/marketingplatformadmin/webpack.config.js b/src/apis/marketingplatformadmin/webpack.config.js new file mode 100644 index 00000000000..42cde2d594d --- /dev/null +++ b/src/apis/marketingplatformadmin/webpack.config.js @@ -0,0 +1,79 @@ +// 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'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Marketingplatformadmin', + filename: 'marketingplatformadmin.min.js', + path: path.resolve(__dirname, 'dist'), + }, + 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: [], +}; From 805d5a3647fb25248b13d108522edeebafacb998 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 51/78] feat(metastore): update the API #### metastore:v1alpha The following keys were added: - schemas.LatestBackup.description - schemas.LatestBackup.id - schemas.LatestBackup.properties.backupId.description - schemas.LatestBackup.properties.backupId.readOnly - schemas.LatestBackup.properties.backupId.type - schemas.LatestBackup.properties.duration.description - schemas.LatestBackup.properties.duration.format - schemas.LatestBackup.properties.duration.readOnly - schemas.LatestBackup.properties.duration.type - schemas.LatestBackup.properties.startTime.description - schemas.LatestBackup.properties.startTime.format - schemas.LatestBackup.properties.startTime.readOnly - schemas.LatestBackup.properties.startTime.type - schemas.LatestBackup.properties.state.description - schemas.LatestBackup.properties.state.enum - schemas.LatestBackup.properties.state.enumDescriptions - schemas.LatestBackup.properties.state.readOnly - schemas.LatestBackup.properties.state.type - schemas.LatestBackup.type - schemas.Restore.properties.backupLocation.description - schemas.Restore.properties.backupLocation.type - schemas.RestoreServiceRequest.properties.backupLocation.description - schemas.RestoreServiceRequest.properties.backupLocation.type - schemas.ScheduledBackup.description - schemas.ScheduledBackup.id - schemas.ScheduledBackup.properties.backupLocation.description - schemas.ScheduledBackup.properties.backupLocation.type - schemas.ScheduledBackup.properties.cronSchedule.description - schemas.ScheduledBackup.properties.cronSchedule.type - schemas.ScheduledBackup.properties.enabled.description - schemas.ScheduledBackup.properties.enabled.type - schemas.ScheduledBackup.properties.latestBackup.$ref - schemas.ScheduledBackup.properties.latestBackup.description - schemas.ScheduledBackup.properties.latestBackup.readOnly - schemas.ScheduledBackup.properties.nextScheduledTime.description - schemas.ScheduledBackup.properties.nextScheduledTime.format - schemas.ScheduledBackup.properties.nextScheduledTime.readOnly - schemas.ScheduledBackup.properties.nextScheduledTime.type - schemas.ScheduledBackup.properties.timeZone.description - schemas.ScheduledBackup.properties.timeZone.type - schemas.ScheduledBackup.type - schemas.Service.properties.scheduledBackup.$ref - schemas.Service.properties.scheduledBackup.description #### metastore:v1beta The following keys were added: - schemas.LatestBackup.description - schemas.LatestBackup.id - schemas.LatestBackup.properties.backupId.description - schemas.LatestBackup.properties.backupId.readOnly - schemas.LatestBackup.properties.backupId.type - schemas.LatestBackup.properties.duration.description - schemas.LatestBackup.properties.duration.format - schemas.LatestBackup.properties.duration.readOnly - schemas.LatestBackup.properties.duration.type - schemas.LatestBackup.properties.startTime.description - schemas.LatestBackup.properties.startTime.format - schemas.LatestBackup.properties.startTime.readOnly - schemas.LatestBackup.properties.startTime.type - schemas.LatestBackup.properties.state.description - schemas.LatestBackup.properties.state.enum - schemas.LatestBackup.properties.state.enumDescriptions - schemas.LatestBackup.properties.state.readOnly - schemas.LatestBackup.properties.state.type - schemas.LatestBackup.type - schemas.Restore.properties.backupLocation.description - schemas.Restore.properties.backupLocation.type - schemas.RestoreServiceRequest.properties.backupLocation.description - schemas.RestoreServiceRequest.properties.backupLocation.type - schemas.ScheduledBackup.description - schemas.ScheduledBackup.id - schemas.ScheduledBackup.properties.backupLocation.description - schemas.ScheduledBackup.properties.backupLocation.type - schemas.ScheduledBackup.properties.cronSchedule.description - schemas.ScheduledBackup.properties.cronSchedule.type - schemas.ScheduledBackup.properties.enabled.description - schemas.ScheduledBackup.properties.enabled.type - schemas.ScheduledBackup.properties.latestBackup.$ref - schemas.ScheduledBackup.properties.latestBackup.description - schemas.ScheduledBackup.properties.latestBackup.readOnly - schemas.ScheduledBackup.properties.nextScheduledTime.description - schemas.ScheduledBackup.properties.nextScheduledTime.format - schemas.ScheduledBackup.properties.nextScheduledTime.readOnly - schemas.ScheduledBackup.properties.nextScheduledTime.type - schemas.ScheduledBackup.properties.timeZone.description - schemas.ScheduledBackup.properties.timeZone.type - schemas.ScheduledBackup.type - schemas.Service.properties.scheduledBackup.$ref - schemas.Service.properties.scheduledBackup.description #### metastore:v1 The following keys were added: - schemas.LatestBackup.description - schemas.LatestBackup.id - schemas.LatestBackup.properties.backupId.description - schemas.LatestBackup.properties.backupId.readOnly - schemas.LatestBackup.properties.backupId.type - schemas.LatestBackup.properties.duration.description - schemas.LatestBackup.properties.duration.format - schemas.LatestBackup.properties.duration.readOnly - schemas.LatestBackup.properties.duration.type - schemas.LatestBackup.properties.startTime.description - schemas.LatestBackup.properties.startTime.format - schemas.LatestBackup.properties.startTime.readOnly - schemas.LatestBackup.properties.startTime.type - schemas.LatestBackup.properties.state.description - schemas.LatestBackup.properties.state.enum - schemas.LatestBackup.properties.state.enumDescriptions - schemas.LatestBackup.properties.state.readOnly - schemas.LatestBackup.properties.state.type - schemas.LatestBackup.type - schemas.Restore.properties.backupLocation.description - schemas.Restore.properties.backupLocation.type - schemas.RestoreServiceRequest.properties.backupLocation.description - schemas.RestoreServiceRequest.properties.backupLocation.type - schemas.ScheduledBackup.description - schemas.ScheduledBackup.id - schemas.ScheduledBackup.properties.backupLocation.description - schemas.ScheduledBackup.properties.backupLocation.type - schemas.ScheduledBackup.properties.cronSchedule.description - schemas.ScheduledBackup.properties.cronSchedule.type - schemas.ScheduledBackup.properties.enabled.description - schemas.ScheduledBackup.properties.enabled.type - schemas.ScheduledBackup.properties.latestBackup.$ref - schemas.ScheduledBackup.properties.latestBackup.description - schemas.ScheduledBackup.properties.latestBackup.readOnly - schemas.ScheduledBackup.properties.nextScheduledTime.description - schemas.ScheduledBackup.properties.nextScheduledTime.format - schemas.ScheduledBackup.properties.nextScheduledTime.readOnly - schemas.ScheduledBackup.properties.nextScheduledTime.type - schemas.ScheduledBackup.properties.timeZone.description - schemas.ScheduledBackup.properties.timeZone.type - schemas.ScheduledBackup.type - schemas.Service.properties.scheduledBackup.$ref - schemas.Service.properties.scheduledBackup.description --- discovery/metastore-v1.json | 89 +++++++++++++++++++++++++++++++- discovery/metastore-v1alpha.json | 89 +++++++++++++++++++++++++++++++- discovery/metastore-v1beta.json | 89 +++++++++++++++++++++++++++++++- src/apis/metastore/v1.ts | 62 ++++++++++++++++++++++ src/apis/metastore/v1alpha.ts | 62 ++++++++++++++++++++++ src/apis/metastore/v1beta.ts | 62 ++++++++++++++++++++++ 6 files changed, 450 insertions(+), 3 deletions(-) diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index b36375d2c2c..296d293a02c 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -1401,7 +1401,7 @@ } } }, - "revision": "20240218", + "revision": "20240305", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -1945,6 +1945,47 @@ }, "type": "object" }, + "LatestBackup": { + "description": "The details of the latest scheduled backup.", + "id": "LatestBackup", + "properties": { + "backupId": { + "description": "Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.", + "readOnly": true, + "type": "string" + }, + "duration": { + "description": "Output only. The duration of the backup completion.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. The time when the backup was started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the backup.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state of the backup is unknown.", + "The backup is in progress.", + "The backup completed.", + "The backup failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ListBackupsResponse": { "description": "Response message for DataprocMetastore.ListBackups.", "id": "ListBackupsResponse", @@ -2511,6 +2552,10 @@ "readOnly": true, "type": "string" }, + "backupLocation": { + "description": "Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.", + "type": "string" + }, "details": { "description": "Output only. The restore details containing the revision of the service to be restored to, in format of JSON.", "readOnly": true, @@ -2573,6 +2618,10 @@ "description": "Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. Mutually exclusive with backup_location, and exactly one of the two must be set.", "type": "string" }, + "backupLocation": { + "description": "Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under \"avro/\", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set.", + "type": "string" + }, "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string" @@ -2626,6 +2675,40 @@ }, "type": "object" }, + "ScheduledBackup": { + "description": "This specifies the configuration of scheduled backup.", + "id": "ScheduledBackup", + "properties": { + "backupLocation": { + "description": "Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.", + "type": "string" + }, + "cronSchedule": { + "description": "Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.", + "type": "string" + }, + "enabled": { + "description": "Optional. Defines whether the scheduled backup is enabled. The default value is false.", + "type": "boolean" + }, + "latestBackup": { + "$ref": "LatestBackup", + "description": "Output only. The details of the latest scheduled backup.", + "readOnly": true + }, + "nextScheduledTime": { + "description": "Output only. The time when the next backups execution is scheduled to start.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "timeZone": { + "description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.", + "type": "string" + } + }, + "type": "object" + }, "Secret": { "description": "A securely stored value.", "id": "Secret", @@ -2734,6 +2817,10 @@ "$ref": "ScalingConfig", "description": "Scaling configuration of the metastore service." }, + "scheduledBackup": { + "$ref": "ScheduledBackup", + "description": "Optional. The configuration of scheduled backup for the metastore service." + }, "state": { "description": "Output only. The current state of the metastore service.", "enum": [ diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index 8c38b5316fb..ab72e8cbf91 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -1641,7 +1641,7 @@ } } }, - "revision": "20240218", + "revision": "20240305", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2212,6 +2212,47 @@ }, "type": "object" }, + "LatestBackup": { + "description": "The details of the latest scheduled backup.", + "id": "LatestBackup", + "properties": { + "backupId": { + "description": "Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.", + "readOnly": true, + "type": "string" + }, + "duration": { + "description": "Output only. The duration of the backup completion.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. The time when the backup was started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the backup.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state of the backup is unknown.", + "The backup is in progress.", + "The backup completed.", + "The backup failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ListBackupsResponse": { "description": "Response message for DataprocMetastore.ListBackups.", "id": "ListBackupsResponse", @@ -2808,6 +2849,10 @@ "readOnly": true, "type": "string" }, + "backupLocation": { + "description": "Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.", + "type": "string" + }, "details": { "description": "Output only. The restore details containing the revision of the service to be restored to, in format of JSON.", "readOnly": true, @@ -2870,6 +2915,10 @@ "description": "Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. Mutually exclusive with backup_location, and exactly one of the two must be set.", "type": "string" }, + "backupLocation": { + "description": "Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under \"avro/\", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set.", + "type": "string" + }, "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string" @@ -2923,6 +2972,40 @@ }, "type": "object" }, + "ScheduledBackup": { + "description": "This specifies the configuration of scheduled backup.", + "id": "ScheduledBackup", + "properties": { + "backupLocation": { + "description": "Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.", + "type": "string" + }, + "cronSchedule": { + "description": "Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.", + "type": "string" + }, + "enabled": { + "description": "Optional. Defines whether the scheduled backup is enabled. The default value is false.", + "type": "boolean" + }, + "latestBackup": { + "$ref": "LatestBackup", + "description": "Output only. The details of the latest scheduled backup.", + "readOnly": true + }, + "nextScheduledTime": { + "description": "Output only. The time when the next backups execution is scheduled to start.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "timeZone": { + "description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.", + "type": "string" + } + }, + "type": "object" + }, "Secret": { "description": "A securely stored value.", "id": "Secret", @@ -3031,6 +3114,10 @@ "$ref": "ScalingConfig", "description": "Scaling configuration of the metastore service." }, + "scheduledBackup": { + "$ref": "ScheduledBackup", + "description": "Optional. The configuration of scheduled backup for the metastore service." + }, "state": { "description": "Output only. The current state of the metastore service.", "enum": [ diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index 981e00b14be..138c467580d 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -1641,7 +1641,7 @@ } } }, - "revision": "20240218", + "revision": "20240305", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2212,6 +2212,47 @@ }, "type": "object" }, + "LatestBackup": { + "description": "The details of the latest scheduled backup.", + "id": "LatestBackup", + "properties": { + "backupId": { + "description": "Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.", + "readOnly": true, + "type": "string" + }, + "duration": { + "description": "Output only. The duration of the backup completion.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. The time when the backup was started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the backup.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state of the backup is unknown.", + "The backup is in progress.", + "The backup completed.", + "The backup failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ListBackupsResponse": { "description": "Response message for DataprocMetastore.ListBackups.", "id": "ListBackupsResponse", @@ -2808,6 +2849,10 @@ "readOnly": true, "type": "string" }, + "backupLocation": { + "description": "Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.", + "type": "string" + }, "details": { "description": "Output only. The restore details containing the revision of the service to be restored to, in format of JSON.", "readOnly": true, @@ -2870,6 +2915,10 @@ "description": "Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. Mutually exclusive with backup_location, and exactly one of the two must be set.", "type": "string" }, + "backupLocation": { + "description": "Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under \"avro/\", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set.", + "type": "string" + }, "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string" @@ -2923,6 +2972,40 @@ }, "type": "object" }, + "ScheduledBackup": { + "description": "This specifies the configuration of scheduled backup.", + "id": "ScheduledBackup", + "properties": { + "backupLocation": { + "description": "Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.", + "type": "string" + }, + "cronSchedule": { + "description": "Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.", + "type": "string" + }, + "enabled": { + "description": "Optional. Defines whether the scheduled backup is enabled. The default value is false.", + "type": "boolean" + }, + "latestBackup": { + "$ref": "LatestBackup", + "description": "Output only. The details of the latest scheduled backup.", + "readOnly": true + }, + "nextScheduledTime": { + "description": "Output only. The time when the next backups execution is scheduled to start.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "timeZone": { + "description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.", + "type": "string" + } + }, + "type": "object" + }, "Secret": { "description": "A securely stored value.", "id": "Secret", @@ -3031,6 +3114,10 @@ "$ref": "ScalingConfig", "description": "Scaling configuration of the metastore service." }, + "scheduledBackup": { + "$ref": "ScheduledBackup", + "description": "Optional. The configuration of scheduled backup for the metastore service." + }, "state": { "description": "Output only. The current state of the metastore service.", "enum": [ diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index 210d270a233..a399dc76fdd 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -475,6 +475,27 @@ export namespace metastore_v1 { */ principal?: string | null; } + /** + * The details of the latest scheduled backup. + */ + export interface Schema$LatestBackup { + /** + * Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress. + */ + backupId?: string | null; + /** + * Output only. The duration of the backup completion. + */ + duration?: string | null; + /** + * Output only. The time when the backup was started. + */ + startTime?: string | null; + /** + * Output only. The current state of the backup. + */ + state?: string | null; + } /** * Response message for DataprocMetastore.ListBackups. */ @@ -844,6 +865,10 @@ export namespace metastore_v1 { * Output only. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id\}/locations/{location_id\}/services/{service_id\}/backups/{backup_id\}. */ backup?: string | null; + /** + * Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///. + */ + backupLocation?: string | null; /** * Output only. The restore details containing the revision of the service to be restored to, in format of JSON. */ @@ -873,6 +898,10 @@ export namespace metastore_v1 { * Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id\}/locations/{location_id\}/services/{service_id\}/backups/{backup_id\}. Mutually exclusive with backup_location, and exactly one of the two must be set. */ backup?: string | null; + /** + * Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under "avro/", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set. + */ + backupLocation?: string | null; /** * Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. */ @@ -895,6 +924,35 @@ export namespace metastore_v1 { */ scalingFactor?: number | null; } + /** + * This specifies the configuration of scheduled backup. + */ + export interface Schema$ScheduledBackup { + /** + * Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it. + */ + backupLocation?: string | null; + /** + * Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups. + */ + cronSchedule?: string | null; + /** + * Optional. Defines whether the scheduled backup is enabled. The default value is false. + */ + enabled?: boolean | null; + /** + * Output only. The details of the latest scheduled backup. + */ + latestBackup?: Schema$LatestBackup; + /** + * Output only. The time when the next backups execution is scheduled to start. + */ + nextScheduledTime?: string | null; + /** + * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC. + */ + timeZone?: string | null; + } /** * A securely stored value. */ @@ -972,6 +1030,10 @@ export namespace metastore_v1 { * Scaling configuration of the metastore service. */ scalingConfig?: Schema$ScalingConfig; + /** + * Optional. The configuration of scheduled backup for the metastore service. + */ + scheduledBackup?: Schema$ScheduledBackup; /** * Output only. The current state of the metastore service. */ diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index e6ec5690953..9ddd3f1f71a 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -493,6 +493,27 @@ export namespace metastore_v1alpha { */ name?: string | null; } + /** + * The details of the latest scheduled backup. + */ + export interface Schema$LatestBackup { + /** + * Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress. + */ + backupId?: string | null; + /** + * Output only. The duration of the backup completion. + */ + duration?: string | null; + /** + * Output only. The time when the backup was started. + */ + startTime?: string | null; + /** + * Output only. The current state of the backup. + */ + state?: string | null; + } /** * Response message for DataprocMetastore.ListBackups. */ @@ -888,6 +909,10 @@ export namespace metastore_v1alpha { * Output only. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id\}/locations/{location_id\}/services/{service_id\}/backups/{backup_id\}. */ backup?: string | null; + /** + * Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///. + */ + backupLocation?: string | null; /** * Output only. The restore details containing the revision of the service to be restored to, in format of JSON. */ @@ -917,6 +942,10 @@ export namespace metastore_v1alpha { * Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id\}/locations/{location_id\}/services/{service_id\}/backups/{backup_id\}. Mutually exclusive with backup_location, and exactly one of the two must be set. */ backup?: string | null; + /** + * Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under "avro/", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set. + */ + backupLocation?: string | null; /** * Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. */ @@ -939,6 +968,35 @@ export namespace metastore_v1alpha { */ scalingFactor?: number | null; } + /** + * This specifies the configuration of scheduled backup. + */ + export interface Schema$ScheduledBackup { + /** + * Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it. + */ + backupLocation?: string | null; + /** + * Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups. + */ + cronSchedule?: string | null; + /** + * Optional. Defines whether the scheduled backup is enabled. The default value is false. + */ + enabled?: boolean | null; + /** + * Output only. The details of the latest scheduled backup. + */ + latestBackup?: Schema$LatestBackup; + /** + * Output only. The time when the next backups execution is scheduled to start. + */ + nextScheduledTime?: string | null; + /** + * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC. + */ + timeZone?: string | null; + } /** * A securely stored value. */ @@ -1016,6 +1074,10 @@ export namespace metastore_v1alpha { * Scaling configuration of the metastore service. */ scalingConfig?: Schema$ScalingConfig; + /** + * Optional. The configuration of scheduled backup for the metastore service. + */ + scheduledBackup?: Schema$ScheduledBackup; /** * Output only. The current state of the metastore service. */ diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index bacc6b61a77..e7ba2d3bf46 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -493,6 +493,27 @@ export namespace metastore_v1beta { */ name?: string | null; } + /** + * The details of the latest scheduled backup. + */ + export interface Schema$LatestBackup { + /** + * Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress. + */ + backupId?: string | null; + /** + * Output only. The duration of the backup completion. + */ + duration?: string | null; + /** + * Output only. The time when the backup was started. + */ + startTime?: string | null; + /** + * Output only. The current state of the backup. + */ + state?: string | null; + } /** * Response message for DataprocMetastore.ListBackups. */ @@ -888,6 +909,10 @@ export namespace metastore_v1beta { * Output only. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id\}/locations/{location_id\}/services/{service_id\}/backups/{backup_id\}. */ backup?: string | null; + /** + * Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///. + */ + backupLocation?: string | null; /** * Output only. The restore details containing the revision of the service to be restored to, in format of JSON. */ @@ -917,6 +942,10 @@ export namespace metastore_v1beta { * Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id\}/locations/{location_id\}/services/{service_id\}/backups/{backup_id\}. Mutually exclusive with backup_location, and exactly one of the two must be set. */ backup?: string | null; + /** + * Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under "avro/", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set. + */ + backupLocation?: string | null; /** * Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. */ @@ -939,6 +968,35 @@ export namespace metastore_v1beta { */ scalingFactor?: number | null; } + /** + * This specifies the configuration of scheduled backup. + */ + export interface Schema$ScheduledBackup { + /** + * Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it. + */ + backupLocation?: string | null; + /** + * Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups. + */ + cronSchedule?: string | null; + /** + * Optional. Defines whether the scheduled backup is enabled. The default value is false. + */ + enabled?: boolean | null; + /** + * Output only. The details of the latest scheduled backup. + */ + latestBackup?: Schema$LatestBackup; + /** + * Output only. The time when the next backups execution is scheduled to start. + */ + nextScheduledTime?: string | null; + /** + * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC. + */ + timeZone?: string | null; + } /** * A securely stored value. */ @@ -1016,6 +1074,10 @@ export namespace metastore_v1beta { * Scaling configuration of the metastore service. */ scalingConfig?: Schema$ScalingConfig; + /** + * Optional. The configuration of scheduled backup for the metastore service. + */ + scheduledBackup?: Schema$ScheduledBackup; /** * Output only. The current state of the metastore service. */ From dceb089463ac4c373df64a1c0f99e00f9a031855 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 52/78] fix(migrationcenter): update the API #### migrationcenter:v1alpha1 The following keys were changed: - schemas.ComputeEnginePreferences.properties.licenseType.description - schemas.SoleTenancyPreferences.properties.commitmentPlan.enumDescriptions - schemas.VirtualMachinePreferences.properties.commitmentPlan.enumDescriptions --- discovery/migrationcenter-v1alpha1.json | 12 ++++++------ src/apis/migrationcenter/v1alpha1.ts | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index e7185543a5a..711468c82ed 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -2107,7 +2107,7 @@ } } }, - "revision": "20240122", + "revision": "20240307", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2600,7 +2600,7 @@ "id": "ComputeEnginePreferences", "properties": { "licenseType": { - "description": "License type to consider when calculating costs for virtual machine insights and recommendations. If unspecified, costs are calculated based on the default licensing plan.", + "description": "Overridden by os_pricing_preferences if specified. License type to consider when calculating costs for virtual machine insights and recommendations. If unspecified, costs are calculated based on the default licensing plan.", "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_TYPE_DEFAULT", @@ -5404,8 +5404,8 @@ "enumDescriptions": [ "Unspecified commitment plan.", "No commitment plan (on-demand usage).", - "1 year commitment.", - "3 years commitment." + "1-year regular committed use discount.", + "3-year regular committed use discount." ], "type": "string" }, @@ -5871,8 +5871,8 @@ "enumDescriptions": [ "Unspecified commitment plan.", "No commitment plan.", - "1 year commitment.", - "3 years commitment." + "1-year regular committed use discount.", + "3-year regular committed use discount." ], "type": "string" }, diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 590c362e505..77bee2a0874 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -475,7 +475,7 @@ export namespace migrationcenter_v1alpha1 { */ export interface Schema$ComputeEnginePreferences { /** - * License type to consider when calculating costs for virtual machine insights and recommendations. If unspecified, costs are calculated based on the default licensing plan. + * Overridden by os_pricing_preferences if specified. License type to consider when calculating costs for virtual machine insights and recommendations. If unspecified, costs are calculated based on the default licensing plan. */ licenseType?: string | null; /** From 98f0bb02dde248158d63e8d26a7b467ed04ce9f6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 53/78] fix(monitoring): update the API #### monitoring:v3 The following keys were changed: - resources.services.methods.patch.parameters.name.description - resources.services.resources.serviceLevelObjectives.methods.patch.parameters.name.description - schemas.Service.properties.name.description - schemas.ServiceLevelObjective.properties.name.description --- discovery/monitoring-v3.json | 10 +++++----- src/apis/monitoring/v3.ts | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index d5d5fce145e..3b2a4060594 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -2452,7 +2452,7 @@ ], "parameters": { "name": { - "description": "Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] ", + "description": "Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] ", "location": "path", "pattern": "^[^/]+/[^/]+/services/[^/]+$", "required": true, @@ -2651,7 +2651,7 @@ ], "parameters": { "name": { - "description": "Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] ", + "description": "Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] ", "location": "path", "pattern": "^[^/]+/[^/]+/services/[^/]+/serviceLevelObjectives/[^/]+$", "required": true, @@ -2714,7 +2714,7 @@ } } }, - "revision": "20240128", + "revision": "20240303", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -5367,7 +5367,7 @@ "description": "Type used for Istio services scoped to an Istio mesh." }, "name": { - "description": "Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] ", + "description": "Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] ", "type": "string" }, "telemetry": { @@ -5441,7 +5441,7 @@ "type": "number" }, "name": { - "description": "Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] ", + "description": "Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] ", "type": "string" }, "rollingPeriod": { diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index a3f75f2df68..14605b4dca3 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -1892,7 +1892,7 @@ export namespace monitoring_v3 { */ meshIstio?: Schema$MeshIstio; /** - * Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] + * Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */ name?: string | null; /** @@ -1938,7 +1938,7 @@ export namespace monitoring_v3 { */ goal?: number | null; /** - * Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] + * Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */ name?: string | null; /** @@ -7535,7 +7535,7 @@ export namespace monitoring_v3 { } export interface Params$Resource$Services$Patch extends StandardParameters { /** - * Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] + * Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */ name?: string; /** @@ -8066,7 +8066,7 @@ export namespace monitoring_v3 { export interface Params$Resource$Services$Servicelevelobjectives$Patch extends StandardParameters { /** - * Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] + * Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */ name?: string; /** From 069adea86ff672b9ba18330e77873c9f09dc1953 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 54/78] fix(networkconnectivity): update the API #### networkconnectivity:v1 The following keys were changed: - schemas.Route.properties.location.description --- discovery/networkconnectivity-v1.json | 4 ++-- src/apis/networkconnectivity/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index 06d743eb52b..abff5134dfb 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -2630,7 +2630,7 @@ } } }, - "revision": "20240221", + "revision": "20240228", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -4086,7 +4086,7 @@ "type": "object" }, "location": { - "description": "Output only. The location of the route. Uses the following form: \"projects/{project}/locations/{location}\" Example: projects/1234/locations/us-central1", + "description": "Output only. The origin location of the route. Uses the following form: \"projects/{project}/locations/{location}\" Example: projects/1234/locations/us-central1", "readOnly": true, "type": "string" }, diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index f832c7e2dbd..ea18e1965ff 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -1083,7 +1083,7 @@ export namespace networkconnectivity_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. The location of the route. Uses the following form: "projects/{project\}/locations/{location\}" Example: projects/1234/locations/us-central1 + * Output only. The origin location of the route. Uses the following form: "projects/{project\}/locations/{location\}" Example: projects/1234/locations/us-central1 */ location?: string | null; /** From c98987cb96ccd2093d146436fcc6edda3c6cb81c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 55/78] feat(networkmanagement): update the API #### networkmanagement:v1beta1 The following keys were added: - schemas.AbortInfo.properties.cause.enumDeprecated - schemas.AbortInfo.properties.ipAddress.description - schemas.AbortInfo.properties.ipAddress.type - schemas.DeliverInfo.properties.ipAddress.description - schemas.DeliverInfo.properties.ipAddress.type - schemas.ForwardInfo.properties.ipAddress.description - schemas.ForwardInfo.properties.ipAddress.type The following keys were changed: - schemas.AbortInfo.properties.cause.enum - schemas.AbortInfo.properties.cause.enumDescriptions - schemas.AbortInfo.properties.projectsMissingPermission.description - schemas.DropInfo.properties.cause.enum - schemas.DropInfo.properties.cause.enumDescriptions #### networkmanagement:v1 The following keys were added: - schemas.AbortInfo.properties.cause.enumDeprecated - schemas.AbortInfo.properties.ipAddress.description - schemas.AbortInfo.properties.ipAddress.type - schemas.DeliverInfo.properties.ipAddress.description - schemas.DeliverInfo.properties.ipAddress.type - schemas.ForwardInfo.properties.ipAddress.description - schemas.ForwardInfo.properties.ipAddress.type The following keys were changed: - schemas.AbortInfo.properties.cause.enum - schemas.AbortInfo.properties.cause.enumDescriptions - schemas.AbortInfo.properties.projectsMissingPermission.description - schemas.DropInfo.properties.cause.enum - schemas.DropInfo.properties.cause.enumDescriptions --- discovery/networkmanagement-v1.json | 102 ++++++++++++++++++----- discovery/networkmanagement-v1beta1.json | 102 ++++++++++++++++++----- src/apis/networkmanagement/v1.ts | 14 +++- src/apis/networkmanagement/v1beta1.ts | 14 +++- 4 files changed, 188 insertions(+), 44 deletions(-) diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index 12f4408c4b3..caf9102392b 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240207", + "revision": "20240228", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -603,48 +603,94 @@ "enum": [ "CAUSE_UNSPECIFIED", "UNKNOWN_NETWORK", - "UNKNOWN_IP", "UNKNOWN_PROJECT", - "PERMISSION_DENIED", - "NO_SOURCE_LOCATION", - "INVALID_ARGUMENT", "NO_EXTERNAL_IP", "UNINTENDED_DESTINATION", - "TRACE_TOO_LONG", - "INTERNAL_ERROR", "SOURCE_ENDPOINT_NOT_FOUND", "MISMATCHED_SOURCE_NETWORK", "DESTINATION_ENDPOINT_NOT_FOUND", "MISMATCHED_DESTINATION_NETWORK", + "UNKNOWN_IP", + "SOURCE_IP_ADDRESS_NOT_IN_SOURCE_NETWORK", + "PERMISSION_DENIED", + "PERMISSION_DENIED_NO_CLOUD_NAT_CONFIGS", + "PERMISSION_DENIED_NO_NEG_ENDPOINT_CONFIGS", + "NO_SOURCE_LOCATION", + "INVALID_ARGUMENT", + "TRACE_TOO_LONG", + "INTERNAL_ERROR", "UNSUPPORTED", "MISMATCHED_IP_VERSION", "GKE_KONNECTIVITY_PROXY_UNSUPPORTED", "RESOURCE_CONFIG_NOT_FOUND", + "VM_INSTANCE_CONFIG_NOT_FOUND", + "NETWORK_CONFIG_NOT_FOUND", + "FIREWALL_CONFIG_NOT_FOUND", + "ROUTE_CONFIG_NOT_FOUND", "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT", "SOURCE_PSC_CLOUD_SQL_UNSUPPORTED", "SOURCE_FORWARDING_RULE_UNSUPPORTED", "NON_ROUTABLE_IP_ADDRESS" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Cause is unspecified.", - "Aborted due to unknown network. The reachability analysis cannot proceed because the user does not have access to the host project's network configurations, including firewall rules and routes. This happens when the project is a service project and the endpoints being traced are in the host project's network.", - "Aborted because the IP address(es) are unknown.", - "Aborted because no project information can be derived from the test input.", - "Aborted because the user lacks the permission to access all or part of the network configurations required to run the test.", - "Aborted because no valid source endpoint is derived from the input test request.", - "Aborted because the source and/or destination endpoint specified in the test are invalid. The possible reasons that an endpoint is invalid include: malformed IP address; nonexistent instance or network URI; IP address not in the range of specified network URI; and instance not owning the network interface in the specified network.", - "Aborted because traffic is sent from a public IP to an instance without an external IP.", - "Aborted because none of the traces matches destination information specified in the input test request.", - "Aborted because the number of steps in the trace exceeding a certain limit which may be caused by routing loop.", + "Aborted due to unknown network. Deprecated, not used in the new tests.", + "Aborted because no project information can be derived from the test input. Deprecated, not used in the new tests.", + "Aborted because traffic is sent from a public IP to an instance without an external IP. Deprecated, not used in the new tests.", + "Aborted because none of the traces matches destination information specified in the input test request. Deprecated, not used in the new tests.", + "Aborted because the source endpoint could not be found. Deprecated, not used in the new tests.", + "Aborted because the source network does not match the source endpoint. Deprecated, not used in the new tests.", + "Aborted because the destination endpoint could not be found. Deprecated, not used in the new tests.", + "Aborted because the destination network does not match the destination endpoint. Deprecated, not used in the new tests.", + "Aborted because no endpoint with the packet's destination IP address is found.", + "Aborted because the source IP address doesn't belong to any of the subnets of the source VPC network.", + "Aborted because user lacks permission to access all or part of the network configurations required to run the test.", + "Aborted because user lacks permission to access Cloud NAT configs required to run the test.", + "Aborted because user lacks permission to access Network endpoint group endpoint configs required to run the test.", + "Aborted because no valid source or destination endpoint is derived from the input test request.", + "Aborted because the source or destination endpoint specified in the request is invalid. Some examples: - The request might contain malformed resource URI, project ID, or IP address. - The request might contain inconsistent information (for example, the request might include both the instance and the network, but the instance might not have a NIC in that network).", + "Aborted because the number of steps in the trace exceeds a certain limit. It might be caused by a routing loop.", "Aborted due to internal server error.", - "Aborted because the source endpoint could not be found.", - "Aborted because the source network does not match the source endpoint.", - "Aborted because the destination endpoint could not be found.", - "Aborted because the destination network does not match the destination endpoint.", "Aborted because the test scenario is not supported.", "Aborted because the source and destination resources have no common IP version.", "Aborted because the connection between the control plane and the node of the source cluster is initiated by the node and managed by the Konnectivity proxy.", "Aborted because expected resource configuration was missing.", + "Aborted because expected VM instance configuration was missing.", + "Aborted because expected network configuration was missing.", + "Aborted because expected firewall configuration was missing.", + "Aborted because expected route configuration was missing.", "Aborted because a PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input).", "Aborted because tests with a PSC-based Cloud SQL instance as a source are not supported.", "Aborted because tests with a forwarding rule as a source are not supported.", @@ -652,8 +698,12 @@ ], "type": "string" }, + "ipAddress": { + "description": "IP address that caused the abort.", + "type": "string" + }, "projectsMissingPermission": { - "description": "List of project IDs that the user has specified in the request but does not have permission to access network configs. Analysis is aborted in this case with the PERMISSION_DENIED cause.", + "description": "List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause.", "items": { "type": "string" }, @@ -948,6 +998,10 @@ "description": "Details of the final state \"deliver\" and associated resource.", "id": "DeliverInfo", "properties": { + "ipAddress": { + "description": "IP address of the target (if applicable).", + "type": "string" + }, "resourceUri": { "description": "URI of the resource that the packet is delivered to.", "type": "string" @@ -1051,6 +1105,7 @@ "PSC_ENDPOINT_ACCESSED_FROM_PEERED_NETWORK", "PSC_NEG_PRODUCER_ENDPOINT_NO_GLOBAL_ACCESS", "PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS", + "NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT", "HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED", "HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED", "CLOUD_RUN_REVISION_NOT_READY", @@ -1110,6 +1165,7 @@ "The packet is sent to the Private Service Connect endpoint over the peering, but [it's not supported](https://cloud.google.com/vpc/docs/configure-private-service-connect-services#on-premises).", "The packet is sent to the Private Service Connect backend (network endpoint group), but the producer PSC forwarding rule does not have global access enabled.", "The packet is sent to the Private Service Connect backend (network endpoint group), but the producer PSC forwarding rule has multiple ports specified.", + "No NAT subnets are defined for the PSC service attachment.", "The packet sent from the hybrid NEG proxy matches a non-dynamic route, but such a configuration is not supported.", "The packet sent from the hybrid NEG proxy matches a dynamic route with a next hop in a different region, but such a configuration is not supported.", "Packet sent from a Cloud Run revision that is not ready.", @@ -1420,6 +1476,10 @@ "description": "Details of the final state \"forward\" and associated resource.", "id": "ForwardInfo", "properties": { + "ipAddress": { + "description": "IP address of the target (if applicable).", + "type": "string" + }, "resourceUri": { "description": "URI of the resource that the packet is forwarded to.", "type": "string" diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index 074a34bb0b3..b4a4e41268e 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240207", + "revision": "20240228", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -603,48 +603,94 @@ "enum": [ "CAUSE_UNSPECIFIED", "UNKNOWN_NETWORK", - "UNKNOWN_IP", "UNKNOWN_PROJECT", - "PERMISSION_DENIED", - "NO_SOURCE_LOCATION", - "INVALID_ARGUMENT", "NO_EXTERNAL_IP", "UNINTENDED_DESTINATION", - "TRACE_TOO_LONG", - "INTERNAL_ERROR", "SOURCE_ENDPOINT_NOT_FOUND", "MISMATCHED_SOURCE_NETWORK", "DESTINATION_ENDPOINT_NOT_FOUND", "MISMATCHED_DESTINATION_NETWORK", + "UNKNOWN_IP", + "SOURCE_IP_ADDRESS_NOT_IN_SOURCE_NETWORK", + "PERMISSION_DENIED", + "PERMISSION_DENIED_NO_CLOUD_NAT_CONFIGS", + "PERMISSION_DENIED_NO_NEG_ENDPOINT_CONFIGS", + "NO_SOURCE_LOCATION", + "INVALID_ARGUMENT", + "TRACE_TOO_LONG", + "INTERNAL_ERROR", "UNSUPPORTED", "MISMATCHED_IP_VERSION", "GKE_KONNECTIVITY_PROXY_UNSUPPORTED", "RESOURCE_CONFIG_NOT_FOUND", + "VM_INSTANCE_CONFIG_NOT_FOUND", + "NETWORK_CONFIG_NOT_FOUND", + "FIREWALL_CONFIG_NOT_FOUND", + "ROUTE_CONFIG_NOT_FOUND", "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT", "SOURCE_PSC_CLOUD_SQL_UNSUPPORTED", "SOURCE_FORWARDING_RULE_UNSUPPORTED", "NON_ROUTABLE_IP_ADDRESS" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Cause is unspecified.", - "Aborted due to unknown network. The reachability analysis cannot proceed because the user does not have access to the host project's network configurations, including firewall rules and routes. This happens when the project is a service project and the endpoints being traced are in the host project's network.", - "Aborted because the IP address(es) are unknown.", - "Aborted because no project information can be derived from the test input.", - "Aborted because the user lacks the permission to access all or part of the network configurations required to run the test.", - "Aborted because no valid source endpoint is derived from the input test request.", - "Aborted because the source and/or destination endpoint specified in the test are invalid. The possible reasons that an endpoint is invalid include: malformed IP address; nonexistent instance or network URI; IP address not in the range of specified network URI; and instance not owning the network interface in the specified network.", - "Aborted because traffic is sent from a public IP to an instance without an external IP.", - "Aborted because none of the traces matches destination information specified in the input test request.", - "Aborted because the number of steps in the trace exceeding a certain limit which may be caused by routing loop.", + "Aborted due to unknown network. Deprecated, not used in the new tests.", + "Aborted because no project information can be derived from the test input. Deprecated, not used in the new tests.", + "Aborted because traffic is sent from a public IP to an instance without an external IP. Deprecated, not used in the new tests.", + "Aborted because none of the traces matches destination information specified in the input test request. Deprecated, not used in the new tests.", + "Aborted because the source endpoint could not be found. Deprecated, not used in the new tests.", + "Aborted because the source network does not match the source endpoint. Deprecated, not used in the new tests.", + "Aborted because the destination endpoint could not be found. Deprecated, not used in the new tests.", + "Aborted because the destination network does not match the destination endpoint. Deprecated, not used in the new tests.", + "Aborted because no endpoint with the packet's destination IP address is found.", + "Aborted because the source IP address doesn't belong to any of the subnets of the source VPC network.", + "Aborted because user lacks permission to access all or part of the network configurations required to run the test.", + "Aborted because user lacks permission to access Cloud NAT configs required to run the test.", + "Aborted because user lacks permission to access Network endpoint group endpoint configs required to run the test.", + "Aborted because no valid source or destination endpoint is derived from the input test request.", + "Aborted because the source or destination endpoint specified in the request is invalid. Some examples: - The request might contain malformed resource URI, project ID, or IP address. - The request might contain inconsistent information (for example, the request might include both the instance and the network, but the instance might not have a NIC in that network).", + "Aborted because the number of steps in the trace exceeds a certain limit. It might be caused by a routing loop.", "Aborted due to internal server error.", - "Aborted because the source endpoint could not be found.", - "Aborted because the source network does not match the source endpoint.", - "Aborted because the destination endpoint could not be found.", - "Aborted because the destination network does not match the destination endpoint.", "Aborted because the test scenario is not supported.", "Aborted because the source and destination resources have no common IP version.", "Aborted because the connection between the control plane and the node of the source cluster is initiated by the node and managed by the Konnectivity proxy.", "Aborted because expected resource configuration was missing.", + "Aborted because expected VM instance configuration was missing.", + "Aborted because expected network configuration was missing.", + "Aborted because expected firewall configuration was missing.", + "Aborted because expected route configuration was missing.", "Aborted because a PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input).", "Aborted because tests with a PSC-based Cloud SQL instance as a source are not supported.", "Aborted because tests with a forwarding rule as a source are not supported.", @@ -652,8 +698,12 @@ ], "type": "string" }, + "ipAddress": { + "description": "IP address that caused the abort.", + "type": "string" + }, "projectsMissingPermission": { - "description": "List of project IDs that the user has specified in the request but does not have permission to access network configs. Analysis is aborted in this case with the PERMISSION_DENIED cause.", + "description": "List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause.", "items": { "type": "string" }, @@ -953,6 +1003,10 @@ "description": "Details of the final state \"deliver\" and associated resource.", "id": "DeliverInfo", "properties": { + "ipAddress": { + "description": "IP address of the target (if applicable).", + "type": "string" + }, "resourceUri": { "description": "URI of the resource that the packet is delivered to.", "type": "string" @@ -1056,6 +1110,7 @@ "PSC_ENDPOINT_ACCESSED_FROM_PEERED_NETWORK", "PSC_NEG_PRODUCER_ENDPOINT_NO_GLOBAL_ACCESS", "PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS", + "NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT", "HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED", "HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED", "CLOUD_RUN_REVISION_NOT_READY", @@ -1115,6 +1170,7 @@ "The packet is sent to the Private Service Connect endpoint over the peering, but [it's not supported](https://cloud.google.com/vpc/docs/configure-private-service-connect-services#on-premises).", "The packet is sent to the Private Service Connect backend (network endpoint group), but the producer PSC forwarding rule does not have global access enabled.", "The packet is sent to the Private Service Connect backend (network endpoint group), but the producer PSC forwarding rule has multiple ports specified.", + "No NAT subnets are defined for the PSC service attachment.", "The packet sent from the hybrid NEG proxy matches a non-dynamic route, but such a configuration is not supported.", "The packet sent from the hybrid NEG proxy matches a dynamic route with a next hop in a different region, but such a configuration is not supported.", "Packet sent from a Cloud Run revision that is not ready.", @@ -1425,6 +1481,10 @@ "description": "Details of the final state \"forward\" and associated resource.", "id": "ForwardInfo", "properties": { + "ipAddress": { + "description": "IP address of the target (if applicable).", + "type": "string" + }, "resourceUri": { "description": "URI of the resource that the packet is forwarded to.", "type": "string" diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index f0a8abd921a..d8c46f55d39 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -133,7 +133,11 @@ export namespace networkmanagement_v1 { */ cause?: string | null; /** - * List of project IDs that the user has specified in the request but does not have permission to access network configs. Analysis is aborted in this case with the PERMISSION_DENIED cause. + * IP address that caused the abort. + */ + ipAddress?: string | null; + /** + * List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. */ projectsMissingPermission?: string[] | null; /** @@ -364,6 +368,10 @@ export namespace networkmanagement_v1 { * Details of the final state "deliver" and associated resource. */ export interface Schema$DeliverInfo { + /** + * IP address of the target (if applicable). + */ + ipAddress?: string | null; /** * URI of the resource that the packet is delivered to. */ @@ -583,6 +591,10 @@ export namespace networkmanagement_v1 { * Details of the final state "forward" and associated resource. */ export interface Schema$ForwardInfo { + /** + * IP address of the target (if applicable). + */ + ipAddress?: string | null; /** * URI of the resource that the packet is forwarded to. */ diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index 1a89f80875c..6e14c74c52a 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -133,7 +133,11 @@ export namespace networkmanagement_v1beta1 { */ cause?: string | null; /** - * List of project IDs that the user has specified in the request but does not have permission to access network configs. Analysis is aborted in this case with the PERMISSION_DENIED cause. + * IP address that caused the abort. + */ + ipAddress?: string | null; + /** + * List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. */ projectsMissingPermission?: string[] | null; /** @@ -368,6 +372,10 @@ export namespace networkmanagement_v1beta1 { * Details of the final state "deliver" and associated resource. */ export interface Schema$DeliverInfo { + /** + * IP address of the target (if applicable). + */ + ipAddress?: string | null; /** * URI of the resource that the packet is delivered to. */ @@ -587,6 +595,10 @@ export namespace networkmanagement_v1beta1 { * Details of the final state "forward" and associated resource. */ export interface Schema$ForwardInfo { + /** + * IP address of the target (if applicable). + */ + ipAddress?: string | null; /** * URI of the resource that the packet is forwarded to. */ From 41879162adf36dd08beeaf94ec0a6e3369e55585 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:52 +0000 Subject: [PATCH 56/78] feat(networksecurity): update the API #### networksecurity:v1beta1 The following keys were added: - schemas.FirewallEndpointAssociation.properties.disabled.description - schemas.FirewallEndpointAssociation.properties.disabled.type #### networksecurity:v1 The following keys were added: - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.flatPath - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.httpMethod - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.id - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameterOrder - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.firewallEndpointId.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.firewallEndpointId.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.firewallEndpointId.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.parent.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.parent.pattern - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.parent.required - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.parent.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.requestId.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.requestId.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.parameters.requestId.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.path - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.request.$ref - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.response.$ref - resources.organizations.resources.locations.resources.firewallEndpoints.methods.create.scopes - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.flatPath - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.httpMethod - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.id - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameterOrder - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameters.name.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameters.name.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameters.name.pattern - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameters.name.required - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameters.name.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameters.requestId.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameters.requestId.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.parameters.requestId.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.path - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.response.$ref - resources.organizations.resources.locations.resources.firewallEndpoints.methods.delete.scopes - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.flatPath - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.httpMethod - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.id - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.parameterOrder - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.parameters.name.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.parameters.name.pattern - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.parameters.name.required - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.parameters.name.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.path - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.response.$ref - resources.organizations.resources.locations.resources.firewallEndpoints.methods.get.scopes - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.flatPath - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.httpMethod - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.id - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameterOrder - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.filter.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.filter.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.filter.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.orderBy.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.orderBy.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.orderBy.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.pageSize.format - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.pageSize.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.pageSize.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.pageToken.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.pageToken.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.parent.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.parent.pattern - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.parent.required - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.parameters.parent.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.path - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.response.$ref - resources.organizations.resources.locations.resources.firewallEndpoints.methods.list.scopes - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.flatPath - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.httpMethod - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.id - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameterOrder - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.name.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.name.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.name.pattern - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.name.required - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.name.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.requestId.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.requestId.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.requestId.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.updateMask.description - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.updateMask.format - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.updateMask.location - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.parameters.updateMask.type - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.path - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.request.$ref - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.response.$ref - resources.organizations.resources.locations.resources.firewallEndpoints.methods.patch.scopes - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.flatPath - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.httpMethod - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.id - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameterOrder - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameters.parent.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameters.parent.pattern - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameters.parent.required - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameters.parent.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameters.securityProfileGroupId.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameters.securityProfileGroupId.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.parameters.securityProfileGroupId.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.path - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.request.$ref - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.response.$ref - resources.organizations.resources.locations.resources.securityProfileGroups.methods.create.scopes - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.flatPath - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.httpMethod - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.id - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameterOrder - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameters.etag.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameters.etag.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameters.etag.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameters.name.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameters.name.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameters.name.pattern - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameters.name.required - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.parameters.name.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.path - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.response.$ref - resources.organizations.resources.locations.resources.securityProfileGroups.methods.delete.scopes - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.flatPath - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.httpMethod - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.id - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.parameterOrder - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.parameters.name.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.parameters.name.pattern - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.parameters.name.required - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.parameters.name.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.path - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.response.$ref - resources.organizations.resources.locations.resources.securityProfileGroups.methods.get.scopes - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.flatPath - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.httpMethod - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.id - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameterOrder - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.pageSize.format - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.pageSize.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.pageSize.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.pageToken.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.pageToken.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.parent.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.parent.pattern - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.parent.required - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.parameters.parent.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.path - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.response.$ref - resources.organizations.resources.locations.resources.securityProfileGroups.methods.list.scopes - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.flatPath - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.httpMethod - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.id - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameterOrder - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.name.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.name.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.name.pattern - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.name.required - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.name.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.updateMask.description - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.updateMask.format - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.updateMask.location - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.updateMask.type - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.path - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.request.$ref - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.response.$ref - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.scopes - resources.organizations.resources.locations.resources.securityProfiles.methods.create.description - resources.organizations.resources.locations.resources.securityProfiles.methods.create.flatPath - resources.organizations.resources.locations.resources.securityProfiles.methods.create.httpMethod - resources.organizations.resources.locations.resources.securityProfiles.methods.create.id - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameterOrder - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameters.parent.location - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameters.parent.pattern - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameters.parent.required - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameters.parent.type - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameters.securityProfileId.description - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameters.securityProfileId.location - resources.organizations.resources.locations.resources.securityProfiles.methods.create.parameters.securityProfileId.type - resources.organizations.resources.locations.resources.securityProfiles.methods.create.path - resources.organizations.resources.locations.resources.securityProfiles.methods.create.request.$ref - resources.organizations.resources.locations.resources.securityProfiles.methods.create.response.$ref - resources.organizations.resources.locations.resources.securityProfiles.methods.create.scopes - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.description - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.flatPath - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.httpMethod - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.id - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameterOrder - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameters.etag.description - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameters.etag.location - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameters.etag.type - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameters.name.description - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameters.name.location - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameters.name.pattern - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameters.name.required - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.parameters.name.type - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.path - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.response.$ref - resources.organizations.resources.locations.resources.securityProfiles.methods.delete.scopes - resources.organizations.resources.locations.resources.securityProfiles.methods.get.description - resources.organizations.resources.locations.resources.securityProfiles.methods.get.flatPath - resources.organizations.resources.locations.resources.securityProfiles.methods.get.httpMethod - resources.organizations.resources.locations.resources.securityProfiles.methods.get.id - resources.organizations.resources.locations.resources.securityProfiles.methods.get.parameterOrder - resources.organizations.resources.locations.resources.securityProfiles.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.securityProfiles.methods.get.parameters.name.location - resources.organizations.resources.locations.resources.securityProfiles.methods.get.parameters.name.pattern - resources.organizations.resources.locations.resources.securityProfiles.methods.get.parameters.name.required - resources.organizations.resources.locations.resources.securityProfiles.methods.get.parameters.name.type - resources.organizations.resources.locations.resources.securityProfiles.methods.get.path - resources.organizations.resources.locations.resources.securityProfiles.methods.get.response.$ref - resources.organizations.resources.locations.resources.securityProfiles.methods.get.scopes - resources.organizations.resources.locations.resources.securityProfiles.methods.list.description - resources.organizations.resources.locations.resources.securityProfiles.methods.list.flatPath - resources.organizations.resources.locations.resources.securityProfiles.methods.list.httpMethod - resources.organizations.resources.locations.resources.securityProfiles.methods.list.id - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameterOrder - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.pageSize.format - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.pageSize.location - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.pageSize.type - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.pageToken.location - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.pageToken.type - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.parent.location - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.parent.pattern - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.parent.required - resources.organizations.resources.locations.resources.securityProfiles.methods.list.parameters.parent.type - resources.organizations.resources.locations.resources.securityProfiles.methods.list.path - resources.organizations.resources.locations.resources.securityProfiles.methods.list.response.$ref - resources.organizations.resources.locations.resources.securityProfiles.methods.list.scopes - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.description - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.flatPath - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.httpMethod - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.id - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameterOrder - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.name.description - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.name.location - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.name.pattern - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.name.required - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.name.type - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.updateMask.description - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.updateMask.format - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.updateMask.location - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.updateMask.type - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.path - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.request.$ref - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.response.$ref - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.scopes - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.flatPath - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.httpMethod - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.id - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameterOrder - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.firewallEndpointAssociationId.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.firewallEndpointAssociationId.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.firewallEndpointAssociationId.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.path - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.request.$ref - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.response.$ref - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.create.scopes - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.flatPath - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.httpMethod - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.id - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.path - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.response.$ref - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.delete.scopes - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.flatPath - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.httpMethod - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.id - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.parameterOrder - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.path - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.response.$ref - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.get.scopes - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.flatPath - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.httpMethod - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.id - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameterOrder - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.path - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.response.$ref - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.list.scopes - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.flatPath - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.httpMethod - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.id - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameterOrder - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.path - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.request.$ref - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.response.$ref - resources.projects.resources.locations.resources.firewallEndpointAssociations.methods.patch.scopes - schemas.FirewallEndpoint.description - schemas.FirewallEndpoint.id - schemas.FirewallEndpoint.properties.associatedNetworks.deprecated - schemas.FirewallEndpoint.properties.associatedNetworks.description - schemas.FirewallEndpoint.properties.associatedNetworks.items.type - schemas.FirewallEndpoint.properties.associatedNetworks.readOnly - schemas.FirewallEndpoint.properties.associatedNetworks.type - schemas.FirewallEndpoint.properties.associations.description - schemas.FirewallEndpoint.properties.associations.items.$ref - schemas.FirewallEndpoint.properties.associations.readOnly - schemas.FirewallEndpoint.properties.associations.type - schemas.FirewallEndpoint.properties.billingProjectId.description - schemas.FirewallEndpoint.properties.billingProjectId.type - schemas.FirewallEndpoint.properties.createTime.description - schemas.FirewallEndpoint.properties.createTime.format - schemas.FirewallEndpoint.properties.createTime.readOnly - schemas.FirewallEndpoint.properties.createTime.type - schemas.FirewallEndpoint.properties.description.description - schemas.FirewallEndpoint.properties.description.type - schemas.FirewallEndpoint.properties.labels.additionalProperties.type - schemas.FirewallEndpoint.properties.labels.description - schemas.FirewallEndpoint.properties.labels.type - schemas.FirewallEndpoint.properties.name.description - schemas.FirewallEndpoint.properties.name.type - schemas.FirewallEndpoint.properties.reconciling.description - schemas.FirewallEndpoint.properties.reconciling.readOnly - schemas.FirewallEndpoint.properties.reconciling.type - schemas.FirewallEndpoint.properties.state.description - schemas.FirewallEndpoint.properties.state.enum - schemas.FirewallEndpoint.properties.state.enumDescriptions - schemas.FirewallEndpoint.properties.state.readOnly - schemas.FirewallEndpoint.properties.state.type - schemas.FirewallEndpoint.properties.updateTime.description - schemas.FirewallEndpoint.properties.updateTime.format - schemas.FirewallEndpoint.properties.updateTime.readOnly - schemas.FirewallEndpoint.properties.updateTime.type - schemas.FirewallEndpoint.type - schemas.FirewallEndpointAssociation.description - schemas.FirewallEndpointAssociation.id - schemas.FirewallEndpointAssociation.properties.createTime.description - schemas.FirewallEndpointAssociation.properties.createTime.format - schemas.FirewallEndpointAssociation.properties.createTime.readOnly - schemas.FirewallEndpointAssociation.properties.createTime.type - schemas.FirewallEndpointAssociation.properties.disabled.description - schemas.FirewallEndpointAssociation.properties.disabled.type - schemas.FirewallEndpointAssociation.properties.firewallEndpoint.description - schemas.FirewallEndpointAssociation.properties.firewallEndpoint.type - schemas.FirewallEndpointAssociation.properties.labels.additionalProperties.type - schemas.FirewallEndpointAssociation.properties.labels.description - schemas.FirewallEndpointAssociation.properties.labels.type - schemas.FirewallEndpointAssociation.properties.name.description - schemas.FirewallEndpointAssociation.properties.name.type - schemas.FirewallEndpointAssociation.properties.network.description - schemas.FirewallEndpointAssociation.properties.network.type - schemas.FirewallEndpointAssociation.properties.reconciling.description - schemas.FirewallEndpointAssociation.properties.reconciling.readOnly - schemas.FirewallEndpointAssociation.properties.reconciling.type - schemas.FirewallEndpointAssociation.properties.state.description - schemas.FirewallEndpointAssociation.properties.state.enum - schemas.FirewallEndpointAssociation.properties.state.enumDescriptions - schemas.FirewallEndpointAssociation.properties.state.readOnly - schemas.FirewallEndpointAssociation.properties.state.type - schemas.FirewallEndpointAssociation.properties.tlsInspectionPolicy.description - schemas.FirewallEndpointAssociation.properties.tlsInspectionPolicy.type - schemas.FirewallEndpointAssociation.properties.updateTime.description - schemas.FirewallEndpointAssociation.properties.updateTime.format - schemas.FirewallEndpointAssociation.properties.updateTime.readOnly - schemas.FirewallEndpointAssociation.properties.updateTime.type - schemas.FirewallEndpointAssociation.type - schemas.FirewallEndpointAssociationReference.description - schemas.FirewallEndpointAssociationReference.id - schemas.FirewallEndpointAssociationReference.properties.name.description - schemas.FirewallEndpointAssociationReference.properties.name.readOnly - schemas.FirewallEndpointAssociationReference.properties.name.type - schemas.FirewallEndpointAssociationReference.properties.network.description - schemas.FirewallEndpointAssociationReference.properties.network.readOnly - schemas.FirewallEndpointAssociationReference.properties.network.type - schemas.FirewallEndpointAssociationReference.type - schemas.ListFirewallEndpointAssociationsResponse.description - schemas.ListFirewallEndpointAssociationsResponse.id - schemas.ListFirewallEndpointAssociationsResponse.properties.firewallEndpointAssociations.description - schemas.ListFirewallEndpointAssociationsResponse.properties.firewallEndpointAssociations.items.$ref - schemas.ListFirewallEndpointAssociationsResponse.properties.firewallEndpointAssociations.type - schemas.ListFirewallEndpointAssociationsResponse.properties.nextPageToken.description - schemas.ListFirewallEndpointAssociationsResponse.properties.nextPageToken.type - schemas.ListFirewallEndpointAssociationsResponse.properties.unreachable.description - schemas.ListFirewallEndpointAssociationsResponse.properties.unreachable.items.type - schemas.ListFirewallEndpointAssociationsResponse.properties.unreachable.type - schemas.ListFirewallEndpointAssociationsResponse.type - schemas.ListFirewallEndpointsResponse.description - schemas.ListFirewallEndpointsResponse.id - schemas.ListFirewallEndpointsResponse.properties.firewallEndpoints.description - schemas.ListFirewallEndpointsResponse.properties.firewallEndpoints.items.$ref - schemas.ListFirewallEndpointsResponse.properties.firewallEndpoints.type - schemas.ListFirewallEndpointsResponse.properties.nextPageToken.description - schemas.ListFirewallEndpointsResponse.properties.nextPageToken.type - schemas.ListFirewallEndpointsResponse.properties.unreachable.description - schemas.ListFirewallEndpointsResponse.properties.unreachable.items.type - schemas.ListFirewallEndpointsResponse.properties.unreachable.type - schemas.ListFirewallEndpointsResponse.type - schemas.ListSecurityProfileGroupsResponse.description - schemas.ListSecurityProfileGroupsResponse.id - schemas.ListSecurityProfileGroupsResponse.properties.nextPageToken.description - schemas.ListSecurityProfileGroupsResponse.properties.nextPageToken.type - schemas.ListSecurityProfileGroupsResponse.properties.securityProfileGroups.description - schemas.ListSecurityProfileGroupsResponse.properties.securityProfileGroups.items.$ref - schemas.ListSecurityProfileGroupsResponse.properties.securityProfileGroups.type - schemas.ListSecurityProfileGroupsResponse.type - schemas.ListSecurityProfilesResponse.description - schemas.ListSecurityProfilesResponse.id - schemas.ListSecurityProfilesResponse.properties.nextPageToken.description - schemas.ListSecurityProfilesResponse.properties.nextPageToken.type - schemas.ListSecurityProfilesResponse.properties.securityProfiles.description - schemas.ListSecurityProfilesResponse.properties.securityProfiles.items.$ref - schemas.ListSecurityProfilesResponse.properties.securityProfiles.type - schemas.ListSecurityProfilesResponse.type - schemas.SecurityProfile.description - schemas.SecurityProfile.id - schemas.SecurityProfile.properties.createTime.description - schemas.SecurityProfile.properties.createTime.format - schemas.SecurityProfile.properties.createTime.readOnly - schemas.SecurityProfile.properties.createTime.type - schemas.SecurityProfile.properties.description.description - schemas.SecurityProfile.properties.description.type - schemas.SecurityProfile.properties.etag.description - schemas.SecurityProfile.properties.etag.readOnly - schemas.SecurityProfile.properties.etag.type - schemas.SecurityProfile.properties.labels.additionalProperties.type - schemas.SecurityProfile.properties.labels.description - schemas.SecurityProfile.properties.labels.type - schemas.SecurityProfile.properties.name.description - schemas.SecurityProfile.properties.name.type - schemas.SecurityProfile.properties.threatPreventionProfile.$ref - schemas.SecurityProfile.properties.threatPreventionProfile.description - schemas.SecurityProfile.properties.type.description - schemas.SecurityProfile.properties.type.enum - schemas.SecurityProfile.properties.type.enumDescriptions - schemas.SecurityProfile.properties.type.type - schemas.SecurityProfile.properties.updateTime.description - schemas.SecurityProfile.properties.updateTime.format - schemas.SecurityProfile.properties.updateTime.readOnly - schemas.SecurityProfile.properties.updateTime.type - schemas.SecurityProfile.type - schemas.SecurityProfileGroup.description - schemas.SecurityProfileGroup.id - schemas.SecurityProfileGroup.properties.createTime.description - schemas.SecurityProfileGroup.properties.createTime.format - schemas.SecurityProfileGroup.properties.createTime.readOnly - schemas.SecurityProfileGroup.properties.createTime.type - schemas.SecurityProfileGroup.properties.description.description - schemas.SecurityProfileGroup.properties.description.type - schemas.SecurityProfileGroup.properties.etag.description - schemas.SecurityProfileGroup.properties.etag.readOnly - schemas.SecurityProfileGroup.properties.etag.type - schemas.SecurityProfileGroup.properties.labels.additionalProperties.type - schemas.SecurityProfileGroup.properties.labels.description - schemas.SecurityProfileGroup.properties.labels.type - schemas.SecurityProfileGroup.properties.name.description - schemas.SecurityProfileGroup.properties.name.type - schemas.SecurityProfileGroup.properties.threatPreventionProfile.description - schemas.SecurityProfileGroup.properties.threatPreventionProfile.type - schemas.SecurityProfileGroup.properties.updateTime.description - schemas.SecurityProfileGroup.properties.updateTime.format - schemas.SecurityProfileGroup.properties.updateTime.readOnly - schemas.SecurityProfileGroup.properties.updateTime.type - schemas.SecurityProfileGroup.type - schemas.SeverityOverride.description - schemas.SeverityOverride.id - schemas.SeverityOverride.properties.action.description - schemas.SeverityOverride.properties.action.enum - schemas.SeverityOverride.properties.action.enumDescriptions - schemas.SeverityOverride.properties.action.type - schemas.SeverityOverride.properties.severity.description - schemas.SeverityOverride.properties.severity.enum - schemas.SeverityOverride.properties.severity.enumDescriptions - schemas.SeverityOverride.properties.severity.type - schemas.SeverityOverride.type - schemas.ThreatOverride.description - schemas.ThreatOverride.id - schemas.ThreatOverride.properties.action.description - schemas.ThreatOverride.properties.action.enum - schemas.ThreatOverride.properties.action.enumDescriptions - schemas.ThreatOverride.properties.action.type - schemas.ThreatOverride.properties.threatId.description - schemas.ThreatOverride.properties.threatId.type - schemas.ThreatOverride.properties.type.description - schemas.ThreatOverride.properties.type.enum - schemas.ThreatOverride.properties.type.enumDescriptions - schemas.ThreatOverride.properties.type.readOnly - schemas.ThreatOverride.properties.type.type - schemas.ThreatOverride.type - schemas.ThreatPreventionProfile.description - schemas.ThreatPreventionProfile.id - schemas.ThreatPreventionProfile.properties.severityOverrides.description - schemas.ThreatPreventionProfile.properties.severityOverrides.items.$ref - schemas.ThreatPreventionProfile.properties.severityOverrides.type - schemas.ThreatPreventionProfile.properties.threatOverrides.description - schemas.ThreatPreventionProfile.properties.threatOverrides.items.$ref - schemas.ThreatPreventionProfile.properties.threatOverrides.type - schemas.ThreatPreventionProfile.type --- discovery/networksecurity-v1.json | 1504 ++++++- discovery/networksecurity-v1beta1.json | 6 +- src/apis/networksecurity/v1.ts | 5200 +++++++++++++++++------- src/apis/networksecurity/v1beta1.ts | 4 + 4 files changed, 5141 insertions(+), 1573 deletions(-) diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index 24a51fcecbb..d19da056836 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -401,6 +401,188 @@ } } }, + "firewallEndpoints": { + "methods": { + "create": { + "description": "Creates a new FirewallEndpoint in a given project and location.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints", + "httpMethod": "POST", + "id": "networksecurity.organizations.locations.firewallEndpoints.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "firewallEndpointId": { + "description": "Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/firewallEndpoints", + "request": { + "$ref": "FirewallEndpoint" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Endpoint.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", + "httpMethod": "DELETE", + "id": "networksecurity.organizations.locations.firewallEndpoints.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Endpoint.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", + "httpMethod": "GET", + "id": "networksecurity.organizations.locations.firewallEndpoints.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "FirewallEndpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FirewallEndpoints in a given project and location.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints", + "httpMethod": "GET", + "id": "networksecurity.organizations.locations.firewallEndpoints.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Hint for how to order the results", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListEndpointsRequest", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/firewallEndpoints", + "response": { + "$ref": "ListFirewallEndpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a single Endpoint.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", + "httpMethod": "PATCH", + "id": "networksecurity.organizations.locations.firewallEndpoints.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. name of resource", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "FirewallEndpoint" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -468,55 +650,379 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "networksecurity.organizations.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "securityProfileGroups": { + "methods": { + "create": { + "description": "Creates a new SecurityProfileGroup in a given organization and location.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups", + "httpMethod": "POST", + "id": "networksecurity.organizations.locations.securityProfileGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the SecurityProfileGroup. Must be in the format `projects|organizations/*/locations/{location}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "securityProfileGroupId": { + "description": "Required. Short name of the SecurityProfileGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"security_profile_group1\".", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/securityProfileGroups", + "request": { + "$ref": "SecurityProfileGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single SecurityProfileGroup.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups/{securityProfileGroupsId}", + "httpMethod": "DELETE", + "id": "networksecurity.organizations.locations.securityProfileGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If client provided etag is out of date, delete will return FAILED_PRECONDITION error.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. A name of the SecurityProfileGroup to delete. Must be in the format `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/securityProfileGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single SecurityProfileGroup.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups/{securityProfileGroupsId}", + "httpMethod": "GET", + "id": "networksecurity.organizations.locations.securityProfileGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the SecurityProfileGroup to get. Must be in the format `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/securityProfileGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SecurityProfileGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SecurityProfileGroups in a given organization and location.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups", + "httpMethod": "GET", + "id": "networksecurity.organizations.locations.securityProfileGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of SecurityProfileGroups to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListSecurityProfileGroupsResponse` Indicates that this is a continuation of a prior `ListSecurityProfileGroups` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project or organization and location from which the SecurityProfileGroups should be listed, specified in the format `projects|organizations/*/locations/{location}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/securityProfileGroups", + "response": { + "$ref": "ListSecurityProfileGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single SecurityProfileGroup.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups/{securityProfileGroupsId}", + "httpMethod": "PATCH", + "id": "networksecurity.organizations.locations.securityProfileGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/securityProfileGroups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the SecurityProfileGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "SecurityProfileGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "securityProfiles": { + "methods": { + "create": { + "description": "Creates a new SecurityProfile in a given organization and location.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles", + "httpMethod": "POST", + "id": "networksecurity.organizations.locations.securityProfiles.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the SecurityProfile. Must be in the format `projects|organizations/*/locations/{location}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "securityProfileId": { + "description": "Required. Short name of the SecurityProfile resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"security_profile1\".", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/securityProfiles", + "request": { + "$ref": "SecurityProfile" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single SecurityProfile.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles/{securityProfilesId}", + "httpMethod": "DELETE", + "id": "networksecurity.organizations.locations.securityProfiles.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If client provided etag is out of date, delete will return FAILED_PRECONDITION error.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. A name of the SecurityProfile to delete. Must be in the format `projects|organizations/*/locations/{location}/securityProfiles/{security_profile_id}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/securityProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single SecurityProfile.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles/{securityProfilesId}", + "httpMethod": "GET", + "id": "networksecurity.organizations.locations.securityProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the SecurityProfile to get. Must be in the format `projects|organizations/*/locations/{location}/securityProfiles/{security_profile_id}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/securityProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SecurityProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SecurityProfiles in a given organization and location.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles", + "httpMethod": "GET", + "id": "networksecurity.organizations.locations.securityProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of SecurityProfiles to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListSecurityProfilesResponse` Indicates that this is a continuation of a prior `ListSecurityProfiles` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project or organization and location from which the SecurityProfiles should be listed, specified in the format `projects|organizations/*/locations/{location}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+parent}/securityProfiles", "response": { - "$ref": "Operation" + "$ref": "ListSecurityProfilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", - "httpMethod": "GET", - "id": "networksecurity.organizations.locations.operations.list", + "patch": { + "description": "Updates the parameters of a single SecurityProfile.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles/{securityProfilesId}", + "httpMethod": "PATCH", + "id": "networksecurity.organizations.locations.securityProfiles.patch", "parameterOrder": [ "name" ], "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "name": { - "description": "The name of the operation's parent resource.", + "description": "Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.", "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", + "pattern": "^organizations/[^/]+/locations/[^/]+/securityProfiles/[^/]+$", "required": true, "type": "string" }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the SecurityProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1/{+name}/operations", + "path": "v1/{+name}", + "request": { + "$ref": "SecurityProfile" + }, "response": { - "$ref": "ListOperationsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1275,7 +1781,231 @@ "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ClientTlsPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.clientTlsPolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the ClientTlsPolicy to get. Must be in the format `projects/*/locations/{location}/clientTlsPolicies/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ClientTlsPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:getIamPolicy", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.clientTlsPolicies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ClientTlsPolicies in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.clientTlsPolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of ClientTlsPolicies to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListClientTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListClientTlsPolicies` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the ClientTlsPolicies should be listed, specified in the format `projects/*/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/clientTlsPolicies", + "response": { + "$ref": "ListClientTlsPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single ClientTlsPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.clientTlsPolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ClientTlsPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:setIamPolicy", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.clientTlsPolicies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:testIamPermissions", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.clientTlsPolicies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "firewallEndpointAssociations": { + "methods": { + "create": { + "description": "Creates a new FirewallEndpointAssociation in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.firewallEndpointAssociations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "firewallEndpointAssociationId": { + "description": "Optional. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_association_id from the method_signature of Create RPC.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/firewallEndpointAssociations", + "request": { + "$ref": "FirewallEndpointAssociation" + }, "response": { "$ref": "Operation" }, @@ -1283,116 +2013,130 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets details of a single ClientTlsPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}", - "httpMethod": "GET", - "id": "networksecurity.projects.locations.clientTlsPolicies.get", + "delete": { + "description": "Deletes a single FirewallEndpointAssociation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.firewallEndpointAssociations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the ClientTlsPolicy to get. Must be in the format `projects/*/locations/{location}/clientTlsPolicies/*`.", + "description": "Required. Name of the resource", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpointAssociations/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "ClientTlsPolicy" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:getIamPolicy", + "get": { + "description": "Gets details of a single FirewallEndpointAssociation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}", "httpMethod": "GET", - "id": "networksecurity.projects.locations.clientTlsPolicies.getIamPolicy", + "id": "networksecurity.projects.locations.firewallEndpointAssociations.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. Name of the resource", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpointAssociations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:getIamPolicy", + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "FirewallEndpointAssociation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists ClientTlsPolicies in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies", + "description": "Lists Associations in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations", "httpMethod": "GET", - "id": "networksecurity.projects.locations.clientTlsPolicies.list", + "id": "networksecurity.projects.locations.firewallEndpointAssociations.list", "parameterOrder": [ "parent" ], "parameters": { + "filter": { + "description": "Optional. Filtering results", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Hint for how to order the results", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "Maximum number of ClientTlsPolicies to return per call.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListClientTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListClientTlsPolicies` call, and that the system should return the next page of data.", + "description": "A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The project and location from which the ClientTlsPolicies should be listed, specified in the format `projects/*/locations/{location}`.", + "description": "Required. Parent value for ListAssociationsRequest", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/clientTlsPolicies", + "path": "v1/{+parent}/firewallEndpointAssociations", "response": { - "$ref": "ListClientTlsPoliciesResponse" + "$ref": "ListFirewallEndpointAssociationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single ClientTlsPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}", + "description": "Update a single FirewallEndpointAssociation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}", "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.clientTlsPolicies.patch", + "id": "networksecurity.projects.locations.firewallEndpointAssociations.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`", + "description": "Immutable. Identifier. name of resource", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpointAssociations/[^/]+$", "required": true, "type": "string" }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "description": "Required. Field mask is used to specify the fields to be overwritten in the Association resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1400,7 +2144,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "ClientTlsPolicy" + "$ref": "FirewallEndpointAssociation" }, "response": { "$ref": "Operation" @@ -1408,62 +2152,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networksecurity.projects.locations.clientTlsPolicies.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networksecurity.projects.locations.clientTlsPolicies.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2474,7 +3162,7 @@ } } }, - "revision": "20240130", + "revision": "20240306", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -2689,70 +3377,236 @@ "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, - "sourceAddressGroup": { - "description": "Required. Source address group to clone items from.", + "sourceAddressGroup": { + "description": "Required. Source address group to clone items from.", + "type": "string" + } + }, + "type": "object" + }, + "Destination": { + "description": "Specification of traffic destination attributes.", + "id": "Destination", + "properties": { + "hosts": { + "description": "Required. List of host names to match. Matched against the \":authority\" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example \"mydomain.*\") or a suffix match (example \"*.myorg.com\") or a presence (any) match \"*\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "httpHeaderMatch": { + "$ref": "HttpHeaderMatch", + "description": "Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy." + }, + "methods": { + "description": "Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ports": { + "description": "Required. List of destination ports to match. At least one port should match.", + "items": { + "format": "uint32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Expr": { + "description": "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.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, 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 its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, + "FirewallEndpoint": { + "description": "Message describing Endpoint object", + "id": "FirewallEndpoint", + "properties": { + "associatedNetworks": { + "deprecated": true, + "description": "Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "associations": { + "description": "Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.", + "items": { + "$ref": "FirewallEndpointAssociationReference" + }, + "readOnly": true, + "type": "array" + }, + "billingProjectId": { + "description": "Required. Project to bill on endpoint uptime usage.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the firewall endpoint. Max length 2048 characters.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Immutable. Identifier. name of resource", + "type": "string" + }, + "reconciling": { + "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. Current state of the endpoint.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "INACTIVE" + ], + "enumDescriptions": [ + "Not set.", + "Being created.", + "Processing configuration updates.", + "Being deleted.", + "Down or in an error state." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FirewallEndpointAssociation": { + "description": "Message describing Association object", + "id": "FirewallEndpointAssociation", + "properties": { + "createTime": { + "description": "Output only. Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "disabled": { + "description": "Optional. Whether the association is disabled. True indicates that traffic won't be intercepted", + "type": "boolean" + }, + "firewallEndpoint": { + "description": "Required. The URL of the FirewallEndpoint that is being associated.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Immutable. Identifier. name of resource", + "type": "string" + }, + "network": { + "description": "Required. The URL of the network that is being associated.", "type": "string" - } - }, - "type": "object" - }, - "Destination": { - "description": "Specification of traffic destination attributes.", - "id": "Destination", - "properties": { - "hosts": { - "description": "Required. List of host names to match. Matched against the \":authority\" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example \"mydomain.*\") or a suffix match (example \"*.myorg.com\") or a presence (any) match \"*\".", - "items": { - "type": "string" - }, - "type": "array" }, - "httpHeaderMatch": { - "$ref": "HttpHeaderMatch", - "description": "Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy." + "reconciling": { + "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" }, - "methods": { - "description": "Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.", - "items": { - "type": "string" - }, - "type": "array" + "state": { + "description": "Output only. Current state of the association.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "INACTIVE" + ], + "enumDescriptions": [ + "Not set.", + "Being created.", + "Active and ready for traffic.", + "Being deleted.", + "Down or in an error state." + ], + "readOnly": true, + "type": "string" }, - "ports": { - "description": "Required. List of destination ports to match. At least one port should match.", - "items": { - "format": "uint32", - "type": "integer" - }, - "type": "array" + "tlsInspectionPolicy": { + "description": "Optional. The URL of the TlsInspectionPolicy that is being associated.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Expr": { - "description": "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.", - "id": "Expr", + "FirewallEndpointAssociationReference": { + "description": "This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.", + "id": "FirewallEndpointAssociationReference", "properties": { - "description": { - "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" - }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "name": { + "description": "Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}", + "readOnly": true, "type": "string" }, - "title": { - "description": "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.", + "network": { + "description": "Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.", + "readOnly": true, "type": "string" } }, @@ -3129,6 +3983,56 @@ }, "type": "object" }, + "ListFirewallEndpointAssociationsResponse": { + "description": "Message for response to listing Associations", + "id": "ListFirewallEndpointAssociationsResponse", + "properties": { + "firewallEndpointAssociations": { + "description": "The list of Association", + "items": { + "$ref": "FirewallEndpointAssociation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListFirewallEndpointsResponse": { + "description": "Message for response to listing Endpoints", + "id": "ListFirewallEndpointsResponse", + "properties": { + "firewallEndpoints": { + "description": "The list of Endpoint", + "items": { + "$ref": "FirewallEndpoint" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListGatewaySecurityPoliciesResponse": { "description": "Response returned by the ListGatewaySecurityPolicies method.", "id": "ListGatewaySecurityPoliciesResponse", @@ -3215,6 +4119,42 @@ }, "type": "object" }, + "ListSecurityProfileGroupsResponse": { + "description": "Response returned by the ListSecurityProfileGroups method.", + "id": "ListSecurityProfileGroupsResponse", + "properties": { + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "type": "string" + }, + "securityProfileGroups": { + "description": "List of SecurityProfileGroups resources.", + "items": { + "$ref": "SecurityProfileGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSecurityProfilesResponse": { + "description": "Response returned by the ListSecurityProfiles method.", + "id": "ListSecurityProfilesResponse", + "properties": { + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "type": "string" + }, + "securityProfiles": { + "description": "List of SecurityProfile resources.", + "items": { + "$ref": "SecurityProfile" + }, + "type": "array" + } + }, + "type": "object" + }, "ListServerTlsPoliciesResponse": { "description": "Response returned by the ListServerTlsPolicies method.", "id": "ListServerTlsPoliciesResponse", @@ -3467,6 +4407,104 @@ }, "type": "object" }, + "SecurityProfile": { + "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 9", + "id": "SecurityProfile", + "properties": { + "createTime": { + "description": "Output only. Resource creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. An optional description of the profile. Max length 512 characters.", + "type": "string" + }, + "etag": { + "description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.", + "type": "string" + }, + "threatPreventionProfile": { + "$ref": "ThreatPreventionProfile", + "description": "The threat prevention configuration for the SecurityProfile." + }, + "type": { + "description": "Immutable. The single ProfileType that the SecurityProfile resource configures.", + "enum": [ + "PROFILE_TYPE_UNSPECIFIED", + "THREAT_PREVENTION" + ], + "enumDescriptions": [ + "Profile type not specified.", + "Profile type for threat prevention." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Last resource update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SecurityProfileGroup": { + "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 8", + "id": "SecurityProfileGroup", + "properties": { + "createTime": { + "description": "Output only. Resource creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. An optional description of the profile group. Max length 2048 characters.", + "type": "string" + }, + "etag": { + "description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.", + "type": "string" + }, + "threatPreventionProfile": { + "description": "Optional. Reference to a SecurityProfile with the threat prevention configuration for the SecurityProfileGroup.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Last resource update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ServerTlsPolicy": { "description": "ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme.", "id": "ServerTlsPolicy", @@ -3513,6 +4551,51 @@ }, "type": "object" }, + "SeverityOverride": { + "description": "Defines what action to take for a specific severity match.", + "id": "SeverityOverride", + "properties": { + "action": { + "description": "Required. Threat action override.", + "enum": [ + "THREAT_ACTION_UNSPECIFIED", + "DEFAULT_ACTION", + "ALLOW", + "ALERT", + "DENY" + ], + "enumDescriptions": [ + "Threat action not specified.", + "The default action (as specified by the vendor) is taken.", + "The packet matching this rule will be allowed to transmit.", + "The packet matching this rule will be allowed to transmit, but a threat_log entry will be sent to the consumer project.", + "The packet matching this rule will be dropped, and a threat_log entry will be sent to the consumer project." + ], + "type": "string" + }, + "severity": { + "description": "Required. Severity level to match.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "INFORMATIONAL", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ], + "enumDescriptions": [ + "Severity level not specified.", + "Suspicious events that do not pose an immediate threat, but that are reported to call attention to deeper problems that could possibly exist.", + "Warning-level threats that have very little impact on an organization's infrastructure. They usually require local or physical system access and may often result in victim privacy issues and information leakage.", + "Minor threats in which impact is minimized, that do not compromise the target or exploits that require an attacker to reside on the same local network as the victim, affect only non-standard configurations or obscure applications, or provide very limited access.", + "Threats that have the ability to become critical but have mitigating factors; for example, they may be difficult to exploit, do not result in elevated privileges, or do not have a large victim pool.", + "Serious threats, such as those that affect default installations of widely deployed software, result in root compromise of servers, and the exploit code is widely available to attackers. The attacker usually does not need any special authentication credentials or knowledge about the individual victims and the target does not need to be manipulated into performing any special functions." + ], + "type": "string" + } + }, + "type": "object" + }, "Source": { "description": "Specification of traffic source attributes.", "id": "Source", @@ -3561,6 +4644,77 @@ }, "type": "object" }, + "ThreatOverride": { + "description": "Defines what action to take for a specific threat_id match.", + "id": "ThreatOverride", + "properties": { + "action": { + "description": "Required. Threat action override. For some threat types, only a subset of actions applies.", + "enum": [ + "THREAT_ACTION_UNSPECIFIED", + "DEFAULT_ACTION", + "ALLOW", + "ALERT", + "DENY" + ], + "enumDescriptions": [ + "Threat action not specified.", + "The default action (as specified by the vendor) is taken.", + "The packet matching this rule will be allowed to transmit.", + "The packet matching this rule will be allowed to transmit, but a threat_log entry will be sent to the consumer project.", + "The packet matching this rule will be dropped, and a threat_log entry will be sent to the consumer project." + ], + "type": "string" + }, + "threatId": { + "description": "Required. Vendor-specific ID of a threat to override.", + "type": "string" + }, + "type": { + "description": "Output only. Type of the threat (read only).", + "enum": [ + "THREAT_TYPE_UNSPECIFIED", + "UNKNOWN", + "VULNERABILITY", + "ANTIVIRUS", + "SPYWARE", + "DNS" + ], + "enumDescriptions": [ + "Type of threat not specified.", + "Type of threat is not derivable from threat ID. An override will be created for all types. Firewall will ignore overridden signature ID's that don't exist in the specific type.", + "Threats related to system flaws that an attacker might otherwise attempt to exploit.", + "Threats related to viruses and malware found in executables and file types.", + "Threats related to command-and-control (C2) activity, where spyware on an infected client is collecting data without the user's consent and/or communicating with a remote attacker.", + "Threats related to DNS." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ThreatPreventionProfile": { + "description": "ThreatPreventionProfile defines an action for specific threat signatures or severity levels.", + "id": "ThreatPreventionProfile", + "properties": { + "severityOverrides": { + "description": "Optional. Configuration for overriding threats actions by severity match.", + "items": { + "$ref": "SeverityOverride" + }, + "type": "array" + }, + "threatOverrides": { + "description": "Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.", + "items": { + "$ref": "ThreatOverride" + }, + "type": "array" + } + }, + "type": "object" + }, "TlsInspectionPolicy": { "description": "The TlsInspectionPolicy resource contains references to CA pools in Certificate Authority Service and associated metadata.", "id": "TlsInspectionPolicy", diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index de435754629..42bcb68baa6 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -3162,7 +3162,7 @@ } } }, - "revision": "20240208", + "revision": "20240229", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3535,6 +3535,10 @@ "readOnly": true, "type": "string" }, + "disabled": { + "description": "Optional. Whether the association is disabled. True indicates that traffic won't be intercepted", + "type": "boolean" + }, "firewallEndpoint": { "description": "Required. The URL of the FirewallEndpoint that is being associated.", "type": "string" diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index b124194c81a..867da139b89 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -322,6 +322,109 @@ export namespace networksecurity_v1 { */ title?: string | null; } + /** + * Message describing Endpoint object + */ + export interface Schema$FirewallEndpoint { + /** + * Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project\}/global/networks/{name\}. + */ + associatedNetworks?: string[] | null; + /** + * Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. + */ + associations?: Schema$FirewallEndpointAssociationReference[]; + /** + * Required. Project to bill on endpoint uptime usage. + */ + billingProjectId?: string | null; + /** + * Output only. Create time stamp + */ + createTime?: string | null; + /** + * Optional. Description of the firewall endpoint. Max length 2048 characters. + */ + description?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Immutable. Identifier. name of resource + */ + name?: string | null; + /** + * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. Current state of the endpoint. + */ + state?: string | null; + /** + * Output only. Update time stamp + */ + updateTime?: string | null; + } + /** + * Message describing Association object + */ + export interface Schema$FirewallEndpointAssociation { + /** + * Output only. Create time stamp + */ + createTime?: string | null; + /** + * Optional. Whether the association is disabled. True indicates that traffic won't be intercepted + */ + disabled?: boolean | null; + /** + * Required. The URL of the FirewallEndpoint that is being associated. + */ + firewallEndpoint?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Immutable. Identifier. name of resource + */ + name?: string | null; + /** + * Required. The URL of the network that is being associated. + */ + network?: string | null; + /** + * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. Current state of the association. + */ + state?: string | null; + /** + * Optional. The URL of the TlsInspectionPolicy that is being associated. + */ + tlsInspectionPolicy?: string | null; + /** + * Output only. Update time stamp + */ + updateTime?: string | null; + } + /** + * This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer. + */ + export interface Schema$FirewallEndpointAssociationReference { + /** + * Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project\}/locations/{location\}/firewallEndpointAssociations/{id\} + */ + name?: string | null; + /** + * Output only. The VPC network associated. Format: projects/{project\}/global/networks/{name\}. + */ + network?: string | null; + } /** * The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata. */ @@ -591,6 +694,40 @@ export namespace networksecurity_v1 { */ nextPageToken?: string | null; } + /** + * Message for response to listing Associations + */ + export interface Schema$ListFirewallEndpointAssociationsResponse { + /** + * The list of Association + */ + firewallEndpointAssociations?: Schema$FirewallEndpointAssociation[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing Endpoints + */ + export interface Schema$ListFirewallEndpointsResponse { + /** + * The list of Endpoint + */ + firewallEndpoints?: Schema$FirewallEndpoint[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response returned by the ListGatewaySecurityPolicies method. */ @@ -651,6 +788,32 @@ export namespace networksecurity_v1 { */ operations?: Schema$Operation[]; } + /** + * Response returned by the ListSecurityProfileGroups method. + */ + export interface Schema$ListSecurityProfileGroupsResponse { + /** + * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. + */ + nextPageToken?: string | null; + /** + * List of SecurityProfileGroups resources. + */ + securityProfileGroups?: Schema$SecurityProfileGroup[]; + } + /** + * Response returned by the ListSecurityProfiles method. + */ + export interface Schema$ListSecurityProfilesResponse { + /** + * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. + */ + nextPageToken?: string | null; + /** + * List of SecurityProfile resources. + */ + securityProfiles?: Schema$SecurityProfile[]; + } /** * Response returned by the ListServerTlsPolicies method. */ @@ -824,6 +987,76 @@ export namespace networksecurity_v1 { */ sources?: Schema$Source[]; } + /** + * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 9 + */ + export interface Schema$SecurityProfile { + /** + * Output only. Resource creation timestamp. + */ + createTime?: string | null; + /** + * Optional. An optional description of the profile. Max length 512 characters. + */ + description?: string | null; + /** + * Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + */ + etag?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfiles/{security_profile\}`. + */ + name?: string | null; + /** + * The threat prevention configuration for the SecurityProfile. + */ + threatPreventionProfile?: Schema$ThreatPreventionProfile; + /** + * Immutable. The single ProfileType that the SecurityProfile resource configures. + */ + type?: string | null; + /** + * Output only. Last resource update timestamp. + */ + updateTime?: string | null; + } + /** + * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 8 + */ + export interface Schema$SecurityProfileGroup { + /** + * Output only. Resource creation timestamp. + */ + createTime?: string | null; + /** + * Optional. An optional description of the profile group. Max length 2048 characters. + */ + description?: string | null; + /** + * Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + */ + etag?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfileGroups/{security_profile_group\}`. + */ + name?: string | null; + /** + * Optional. Reference to a SecurityProfile with the threat prevention configuration for the SecurityProfileGroup. + */ + threatPreventionProfile?: string | null; + /** + * Output only. Last resource update timestamp. + */ + updateTime?: string | null; + } /** * ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme. */ @@ -861,6 +1094,19 @@ export namespace networksecurity_v1 { */ updateTime?: string | null; } + /** + * Defines what action to take for a specific severity match. + */ + export interface Schema$SeverityOverride { + /** + * Required. Threat action override. + */ + action?: string | null; + /** + * Required. Severity level to match. + */ + severity?: string | null; + } /** * Specification of traffic source attributes. */ @@ -891,6 +1137,36 @@ export namespace networksecurity_v1 { */ message?: string | null; } + /** + * Defines what action to take for a specific threat_id match. + */ + export interface Schema$ThreatOverride { + /** + * Required. Threat action override. For some threat types, only a subset of actions applies. + */ + action?: string | null; + /** + * Required. Vendor-specific ID of a threat to override. + */ + threatId?: string | null; + /** + * Output only. Type of the threat (read only). + */ + type?: string | null; + } + /** + * ThreatPreventionProfile defines an action for specific threat signatures or severity levels. + */ + export interface Schema$ThreatPreventionProfile { + /** + * Optional. Configuration for overriding threats actions by severity match. + */ + severityOverrides?: Schema$SeverityOverride[]; + /** + * Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied. + */ + threatOverrides?: Schema$ThreatOverride[]; + } /** * The TlsInspectionPolicy resource contains references to CA pools in Certificate Authority Service and associated metadata. */ @@ -987,15 +1263,26 @@ export namespace networksecurity_v1 { export class Resource$Organizations$Locations { context: APIRequestContext; addressGroups: Resource$Organizations$Locations$Addressgroups; + firewallEndpoints: Resource$Organizations$Locations$Firewallendpoints; operations: Resource$Organizations$Locations$Operations; + securityProfileGroups: Resource$Organizations$Locations$Securityprofilegroups; + securityProfiles: Resource$Organizations$Locations$Securityprofiles; constructor(context: APIRequestContext) { this.context = context; this.addressGroups = new Resource$Organizations$Locations$Addressgroups( this.context ); + this.firewallEndpoints = + new Resource$Organizations$Locations$Firewallendpoints(this.context); this.operations = new Resource$Organizations$Locations$Operations( this.context ); + this.securityProfileGroups = + new Resource$Organizations$Locations$Securityprofilegroups( + this.context + ); + this.securityProfiles = + new Resource$Organizations$Locations$Securityprofiles(this.context); } } @@ -1939,65 +2226,65 @@ export namespace networksecurity_v1 { requestBody?: Schema$RemoveAddressGroupItemsRequest; } - export class Resource$Organizations$Locations$Operations { + export class Resource$Organizations$Locations$Firewallendpoints { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Creates a new FirewallEndpoint in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Organizations$Locations$Operations$Cancel, + create( + params: Params$Resource$Organizations$Locations$Firewallendpoints$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Organizations$Locations$Operations$Cancel, + create( + params?: Params$Resource$Organizations$Locations$Firewallendpoints$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Organizations$Locations$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Firewallendpoints$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Organizations$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Firewallendpoints$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Organizations$Locations$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Firewallendpoints$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Firewallendpoints$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Operations$Cancel; + {}) as Params$Resource$Organizations$Locations$Firewallendpoints$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Operations$Cancel; + {} as Params$Resource$Organizations$Locations$Firewallendpoints$Create; options = {}; } @@ -2011,28 +2298,31 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/firewallEndpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a single Endpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2040,50 +2330,50 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Organizations$Locations$Operations$Delete, + params: Params$Resource$Organizations$Locations$Firewallendpoints$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Organizations$Locations$Operations$Delete, + params?: Params$Resource$Organizations$Locations$Firewallendpoints$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Organizations$Locations$Operations$Delete, + params: Params$Resource$Organizations$Locations$Firewallendpoints$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Organizations$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Firewallendpoints$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Organizations$Locations$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Firewallendpoints$Delete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Firewallendpoints$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Operations$Delete; + {}) as Params$Resource$Organizations$Locations$Firewallendpoints$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Operations$Delete; + {} as Params$Resource$Organizations$Locations$Firewallendpoints$Delete; options = {}; } @@ -2108,17 +2398,17 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets details of a single Endpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2126,49 +2416,50 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Organizations$Locations$Operations$Get, + params: Params$Resource$Organizations$Locations$Firewallendpoints$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Organizations$Locations$Operations$Get, + params?: Params$Resource$Organizations$Locations$Firewallendpoints$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Organizations$Locations$Operations$Get, + params: Params$Resource$Organizations$Locations$Firewallendpoints$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Firewallendpoints$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Locations$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Firewallendpoints$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Firewallendpoints$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Operations$Get; + {}) as Params$Resource$Organizations$Locations$Firewallendpoints$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Operations$Get; + params = + {} as Params$Resource$Organizations$Locations$Firewallendpoints$Get; options = {}; } @@ -2193,17 +2484,17 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists FirewallEndpoints in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2211,54 +2502,57 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Organizations$Locations$Operations$List, + params: Params$Resource$Organizations$Locations$Firewallendpoints$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Organizations$Locations$Operations$List, + params?: Params$Resource$Organizations$Locations$Firewallendpoints$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Organizations$Locations$Operations$List, + params: Params$Resource$Organizations$Locations$Firewallendpoints$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Locations$Operations$List, + params: Params$Resource$Organizations$Locations$Firewallendpoints$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Locations$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Firewallendpoints$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Firewallendpoints$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Operations$List; + {}) as Params$Resource$Organizations$Locations$Firewallendpoints$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Operations$List; + params = + {} as Params$Resource$Organizations$Locations$Firewallendpoints$List; options = {}; } @@ -2272,7 +2566,7 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/firewallEndpoints').replace( /([^:]\/)\/+/g, '$1' ), @@ -2281,159 +2575,250 @@ export namespace networksecurity_v1 { options ), params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update a single Endpoint. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Organizations$Locations$Firewallendpoints$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Organizations$Locations$Firewallendpoints$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Locations$Firewallendpoints$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Firewallendpoints$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Firewallendpoints$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Firewallendpoints$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Firewallendpoints$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Firewallendpoints$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, requiredParams: ['name'], pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Organizations$Locations$Operations$Cancel + export interface Params$Resource$Organizations$Locations$Firewallendpoints$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC. */ - name?: string; + firewallEndpointId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$CancelOperationRequest; + requestBody?: Schema$FirewallEndpoint; } - export interface Params$Resource$Organizations$Locations$Operations$Delete + export interface Params$Resource$Organizations$Locations$Firewallendpoints$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. Name of the resource */ name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Organizations$Locations$Operations$Get + export interface Params$Resource$Organizations$Locations$Firewallendpoints$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. Name of the resource */ name?: string; } - export interface Params$Resource$Organizations$Locations$Operations$List + export interface Params$Resource$Organizations$Locations$Firewallendpoints$List extends StandardParameters { /** - * The standard list filter. + * Optional. Filtering results */ filter?: string; /** - * The name of the operation's parent resource. + * Hint for how to order the results */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * The standard list page token. + * A token identifying a page of results the server should return. */ pageToken?: string; + /** + * Required. Parent value for ListEndpointsRequest + */ + parent?: string; } + export interface Params$Resource$Organizations$Locations$Firewallendpoints$Patch + extends StandardParameters { + /** + * Immutable. Identifier. name of resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } + /** + * Request body metadata + */ + requestBody?: Schema$FirewallEndpoint; } - export class Resource$Projects$Locations { + export class Resource$Organizations$Locations$Operations { context: APIRequestContext; - addressGroups: Resource$Projects$Locations$Addressgroups; - authorizationPolicies: Resource$Projects$Locations$Authorizationpolicies; - clientTlsPolicies: Resource$Projects$Locations$Clienttlspolicies; - gatewaySecurityPolicies: Resource$Projects$Locations$Gatewaysecuritypolicies; - operations: Resource$Projects$Locations$Operations; - serverTlsPolicies: Resource$Projects$Locations$Servertlspolicies; - tlsInspectionPolicies: Resource$Projects$Locations$Tlsinspectionpolicies; - urlLists: Resource$Projects$Locations$Urllists; constructor(context: APIRequestContext) { this.context = context; - this.addressGroups = new Resource$Projects$Locations$Addressgroups( - this.context - ); - this.authorizationPolicies = - new Resource$Projects$Locations$Authorizationpolicies(this.context); - this.clientTlsPolicies = - new Resource$Projects$Locations$Clienttlspolicies(this.context); - this.gatewaySecurityPolicies = - new Resource$Projects$Locations$Gatewaysecuritypolicies(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.serverTlsPolicies = - new Resource$Projects$Locations$Servertlspolicies(this.context); - this.tlsInspectionPolicies = - new Resource$Projects$Locations$Tlsinspectionpolicies(this.context); - this.urlLists = new Resource$Projects$Locations$Urllists(this.context); } /** - * Gets information about a location. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Get, + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Get, + cancel( + params?: Params$Resource$Organizations$Locations$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, + ): GaxiosPromise; + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Organizations$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = + {} as Params$Resource$Organizations$Locations$Operations$Cancel; options = {}; } @@ -2447,8 +2832,8 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -2458,72 +2843,68 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$List, + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$List, + delete( + params?: Params$Resource$Organizations$Locations$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Organizations$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = + {} as Params$Resource$Organizations$Locations$Operations$Delete; options = {}; } @@ -2537,11 +2918,8 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), @@ -2551,83 +2929,49 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { - /** - * Resource name for the location. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { - /** - * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The maximum number of results to return. If not set, the service selects a default. - */ - pageSize?: number; - /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Addressgroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Adds items to an address group. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addItems( - params: Params$Resource$Projects$Locations$Addressgroups$Additems, + get( + params: Params$Resource$Organizations$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - addItems( - params?: Params$Resource$Projects$Locations$Addressgroups$Additems, + get( + params?: Params$Resource$Organizations$Locations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - addItems( - params: Params$Resource$Projects$Locations$Addressgroups$Additems, + get( + params: Params$Resource$Organizations$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addItems( - params: Params$Resource$Projects$Locations$Addressgroups$Additems, + get( + params: Params$Resource$Organizations$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addItems( - params: Params$Resource$Projects$Locations$Addressgroups$Additems, + get( + params: Params$Resource$Organizations$Locations$Operations$Get, callback: BodyResponseCallback ): void; - addItems(callback: BodyResponseCallback): void; - addItems( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Additems + | Params$Resource$Organizations$Locations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2640,13 +2984,12 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Additems; + {}) as Params$Resource$Organizations$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Addressgroups$Additems; + params = {} as Params$Resource$Organizations$Locations$Operations$Get; options = {}; } @@ -2660,17 +3003,14 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+addressGroup}:addItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['addressGroup'], - pathParams: ['addressGroup'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -2684,58 +3024,62 @@ export namespace networksecurity_v1 { } /** - * Clones items from one address group to another. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cloneItems( - params: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, + list( + params: Params$Resource$Organizations$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - cloneItems( - params?: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, + list( + params?: Params$Resource$Organizations$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - cloneItems( - params: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cloneItems( - params: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cloneItems( - params: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Operations$List, + callback: BodyResponseCallback ): void; - cloneItems(callback: BodyResponseCallback): void; - cloneItems( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Cloneitems - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Cloneitems; + {}) as Params$Resource$Organizations$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Addressgroups$Cloneitems; + params = {} as Params$Resource$Organizations$Locations$Operations$List; options = {}; } @@ -2749,64 +3093,117 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+addressGroup}:cloneItems').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['addressGroup'], - pathParams: ['addressGroup'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Organizations$Locations$Operations$Cancel + extends StandardParameters { /** - * Creates a new address group in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The name of the operation resource to be cancelled. */ - create( - params: Params$Resource$Projects$Locations$Addressgroups$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Addressgroups$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Addressgroups$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Addressgroups$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Addressgroups$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Create - | BodyResponseCallback + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Organizations$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Organizations$Locations$Securityprofilegroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new SecurityProfileGroup in a given organization and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Organizations$Locations$Securityprofilegroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Securityprofilegroups$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -2818,12 +3215,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Create; + {}) as Params$Resource$Organizations$Locations$Securityprofilegroups$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Addressgroups$Create; + params = + {} as Params$Resource$Organizations$Locations$Securityprofilegroups$Create; options = {}; } @@ -2837,7 +3235,7 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/addressGroups').replace( + url: (rootUrl + '/v1/{+parent}/securityProfileGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -2861,7 +3259,7 @@ export namespace networksecurity_v1 { } /** - * Deletes a single address group. + * Deletes a single SecurityProfileGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2869,31 +3267,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Addressgroups$Delete, + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Addressgroups$Delete, + params?: Params$Resource$Organizations$Locations$Securityprofilegroups$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Addressgroups$Delete, + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Addressgroups$Delete, + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Addressgroups$Delete, + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Delete + | Params$Resource$Organizations$Locations$Securityprofilegroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2906,12 +3304,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Delete; + {}) as Params$Resource$Organizations$Locations$Securityprofilegroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Addressgroups$Delete; + params = + {} as Params$Resource$Organizations$Locations$Securityprofilegroups$Delete; options = {}; } @@ -2946,7 +3345,7 @@ export namespace networksecurity_v1 { } /** - * Gets details of a single address group. + * Gets details of a single SecurityProfileGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2954,49 +3353,55 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Addressgroups$Get, + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Addressgroups$Get, + params?: Params$Resource$Organizations$Locations$Securityprofilegroups$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Addressgroups$Get, + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Addressgroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Addressgroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Securityprofilegroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Get; + {}) as Params$Resource$Organizations$Locations$Securityprofilegroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Addressgroups$Get; + params = + {} as Params$Resource$Organizations$Locations$Securityprofilegroups$Get; options = {}; } @@ -3021,73 +3426,75 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists SecurityProfileGroups in a given organization and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, + list( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, + list( + params?: Params$Resource$Organizations$Locations$Securityprofilegroups$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$List, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Getiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Securityprofilegroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Getiampolicy; + {}) as Params$Resource$Organizations$Locations$Securityprofilegroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Addressgroups$Getiampolicy; + {} as Params$Resource$Organizations$Locations$Securityprofilegroups$List; options = {}; } @@ -3101,7 +3508,7 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/securityProfileGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -3110,79 +3517,75 @@ export namespace networksecurity_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists address groups in a given project and location. + * Updates the parameters of a single SecurityProfileGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Addressgroups$List, + patch( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Addressgroups$List, + patch( + params?: Params$Resource$Organizations$Locations$Securityprofilegroups$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Addressgroups$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Addressgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Addressgroups$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Locations$Securityprofilegroups$Patch, + callback: BodyResponseCallback ): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Securityprofilegroups$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$List; + {}) as Params$Resource$Organizations$Locations$Securityprofilegroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Addressgroups$List; + params = + {} as Params$Resource$Organizations$Locations$Securityprofilegroups$Patch; options = {}; } @@ -3196,161 +3599,133 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/addressGroups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Organizations$Locations$Securityprofilegroups$Create + extends StandardParameters { /** - * Lists references of an address group. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The parent resource of the SecurityProfileGroup. Must be in the format `projects|organizations/x/locations/{location\}`. */ - listReferences( - params: Params$Resource$Projects$Locations$Addressgroups$Listreferences, - options: StreamMethodOptions - ): GaxiosPromise; - listReferences( - params?: Params$Resource$Projects$Locations$Addressgroups$Listreferences, - options?: MethodOptions - ): GaxiosPromise; - listReferences( - params: Params$Resource$Projects$Locations$Addressgroups$Listreferences, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listReferences( - params: Params$Resource$Projects$Locations$Addressgroups$Listreferences, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listReferences( - params: Params$Resource$Projects$Locations$Addressgroups$Listreferences, - callback: BodyResponseCallback - ): void; - listReferences( - callback: BodyResponseCallback - ): void; - listReferences( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Listreferences - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Listreferences; - let options = (optionsOrCallback || {}) as MethodOptions; + parent?: string; + /** + * Required. Short name of the SecurityProfileGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile_group1". + */ + securityProfileGroupId?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Addressgroups$Listreferences; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$SecurityProfileGroup; + } + export interface Params$Resource$Organizations$Locations$Securityprofilegroups$Delete + extends StandardParameters { + /** + * Optional. If client provided etag is out of date, delete will return FAILED_PRECONDITION error. + */ + etag?: string; + /** + * Required. A name of the SecurityProfileGroup to delete. Must be in the format `projects|organizations/x/locations/{location\}/securityProfileGroups/{security_profile_group\}`. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Securityprofilegroups$Get + extends StandardParameters { + /** + * Required. A name of the SecurityProfileGroup to get. Must be in the format `projects|organizations/x/locations/{location\}/securityProfileGroups/{security_profile_group\}`. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Securityprofilegroups$List + extends StandardParameters { + /** + * Maximum number of SecurityProfileGroups to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListSecurityProfileGroupsResponse` Indicates that this is a continuation of a prior `ListSecurityProfileGroups` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project or organization and location from which the SecurityProfileGroups should be listed, specified in the format `projects|organizations/x/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Organizations$Locations$Securityprofilegroups$Patch + extends StandardParameters { + /** + * Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfileGroups/{security_profile_group\}`. + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the SecurityProfileGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. + */ + updateMask?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$SecurityProfileGroup; + } - const rootUrl = - options.rootUrl || 'https://networksecurity.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+addressGroup}:listReferences').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['addressGroup'], - pathParams: ['addressGroup'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + export class Resource$Organizations$Locations$Securityprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Updates the parameters of a single address group. + * Creates a new SecurityProfile in a given organization and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Addressgroups$Patch, + create( + params: Params$Resource$Organizations$Locations$Securityprofiles$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Addressgroups$Patch, + create( + params?: Params$Resource$Organizations$Locations$Securityprofiles$Create, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Addressgroups$Patch, + create( + params: Params$Resource$Organizations$Locations$Securityprofiles$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Addressgroups$Patch, + create( + params: Params$Resource$Organizations$Locations$Securityprofiles$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Addressgroups$Patch, + create( + params: Params$Resource$Organizations$Locations$Securityprofiles$Create, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Patch + | Params$Resource$Organizations$Locations$Securityprofiles$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3363,12 +3738,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Patch; + {}) as Params$Resource$Organizations$Locations$Securityprofiles$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Addressgroups$Patch; + params = + {} as Params$Resource$Organizations$Locations$Securityprofiles$Create; options = {}; } @@ -3382,14 +3758,17 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/securityProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -3403,39 +3782,39 @@ export namespace networksecurity_v1 { } /** - * Removes items from an address group. + * Deletes a single SecurityProfile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeItems( - params: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + delete( + params: Params$Resource$Organizations$Locations$Securityprofiles$Delete, options: StreamMethodOptions ): GaxiosPromise; - removeItems( - params?: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + delete( + params?: Params$Resource$Organizations$Locations$Securityprofiles$Delete, options?: MethodOptions ): GaxiosPromise; - removeItems( - params: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + delete( + params: Params$Resource$Organizations$Locations$Securityprofiles$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeItems( - params: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + delete( + params: Params$Resource$Organizations$Locations$Securityprofiles$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeItems( - params: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + delete( + params: Params$Resource$Organizations$Locations$Securityprofiles$Delete, callback: BodyResponseCallback ): void; - removeItems(callback: BodyResponseCallback): void; - removeItems( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Removeitems + | Params$Resource$Organizations$Locations$Securityprofiles$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3448,13 +3827,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Removeitems; + {}) as Params$Resource$Organizations$Locations$Securityprofiles$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Addressgroups$Removeitems; + {} as Params$Resource$Organizations$Locations$Securityprofiles$Delete; options = {}; } @@ -3468,17 +3847,14 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+addressGroup}:removeItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['addressGroup'], - pathParams: ['addressGroup'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -3492,63 +3868,58 @@ export namespace networksecurity_v1 { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets details of a single SecurityProfile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, + get( + params: Params$Resource$Organizations$Locations$Securityprofiles$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, + get( + params?: Params$Resource$Organizations$Locations$Securityprofiles$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Securityprofiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Securityprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Securityprofiles$Get, + callback: BodyResponseCallback ): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Setiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Securityprofiles$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Setiampolicy; + {}) as Params$Resource$Organizations$Locations$Securityprofiles$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Addressgroups$Setiampolicy; + {} as Params$Resource$Organizations$Locations$Securityprofiles$Get; options = {}; } @@ -3562,89 +3933,86 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Lists SecurityProfiles in a given organization and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + list( + params: Params$Resource$Organizations$Locations$Securityprofiles$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + list( + params?: Params$Resource$Organizations$Locations$Securityprofiles$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Securityprofiles$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + list( + params: Params$Resource$Organizations$Locations$Securityprofiles$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Securityprofiles$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Addressgroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Securityprofiles$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Addressgroups$Testiampermissions; + {}) as Params$Resource$Organizations$Locations$Securityprofiles$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Addressgroups$Testiampermissions; + {} as Params$Resource$Organizations$Locations$Securityprofiles$List; options = {}; } @@ -3658,232 +4026,2187 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/securityProfiles').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Addressgroups$Additems - extends StandardParameters { /** - * Required. A name of the AddressGroup to add items to. Must be in the format `projects|organization/x/locations/{location\}/addressGroups/x`. + * Updates the parameters of a single SecurityProfile. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - addressGroup?: string; + patch( + params: Params$Resource$Organizations$Locations$Securityprofiles$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Organizations$Locations$Securityprofiles$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Locations$Securityprofiles$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Securityprofiles$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Securityprofiles$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Securityprofiles$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Securityprofiles$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$AddAddressGroupItemsRequest; - } - export interface Params$Resource$Projects$Locations$Addressgroups$Cloneitems - extends StandardParameters { - /** - * Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/x/locations/{location\}/addressGroups/x`. - */ - addressGroup?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Securityprofiles$Patch; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$CloneAddressGroupItemsRequest; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Projects$Locations$Addressgroups$Create + + export interface Params$Resource$Organizations$Locations$Securityprofiles$Create extends StandardParameters { /** - * Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy". - */ - addressGroupId?: string; - /** - * Required. The parent resource of the AddressGroup. Must be in the format `projects/x/locations/{location\}`. + * Required. The parent resource of the SecurityProfile. Must be in the format `projects|organizations/x/locations/{location\}`. */ parent?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Required. Short name of the SecurityProfile resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile1". */ - requestId?: string; + securityProfileId?: string; /** * Request body metadata */ - requestBody?: Schema$AddressGroup; + requestBody?: Schema$SecurityProfile; } - export interface Params$Resource$Projects$Locations$Addressgroups$Delete + export interface Params$Resource$Organizations$Locations$Securityprofiles$Delete extends StandardParameters { /** - * Required. A name of the AddressGroup to delete. Must be in the format `projects/x/locations/{location\}/addressGroups/x`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. If client provided etag is out of date, delete will return FAILED_PRECONDITION error. */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Addressgroups$Get - extends StandardParameters { + etag?: string; /** - * Required. A name of the AddressGroup to get. Must be in the format `projects/x/locations/{location\}/addressGroups/x`. + * Required. A name of the SecurityProfile to delete. Must be in the format `projects|organizations/x/locations/{location\}/securityProfiles/{security_profile_id\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Addressgroups$Getiampolicy + export interface Params$Resource$Organizations$Locations$Securityprofiles$Get extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Required. A name of the SecurityProfile to get. Must be in the format `projects|organizations/x/locations/{location\}/securityProfiles/{security_profile_id\}`. */ - resource?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Addressgroups$List + export interface Params$Resource$Organizations$Locations$Securityprofiles$List extends StandardParameters { /** - * Maximum number of AddressGroups to return per call. + * Maximum number of SecurityProfiles to return per call. */ pageSize?: number; /** - * The value returned by the last `ListAddressGroupsResponse` Indicates that this is a continuation of a prior `ListAddressGroups` call, and that the system should return the next page of data. + * The value returned by the last `ListSecurityProfilesResponse` Indicates that this is a continuation of a prior `ListSecurityProfiles` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/x/locations/{location\}`. + * Required. The project or organization and location from which the SecurityProfiles should be listed, specified in the format `projects|organizations/x/locations/{location\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Addressgroups$Listreferences - extends StandardParameters { - /** - * Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/x/locations/{location\}/addressGroups/x`. - */ - addressGroup?: string; - /** - * The maximum number of references 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 AddressGroupUsers left to be queried. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous List request, if any. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Addressgroups$Patch + export interface Params$Resource$Organizations$Locations$Securityprofiles$Patch extends StandardParameters { /** - * Required. Name of the AddressGroup resource. It matches pattern `projects/x/locations/{location\}/addressGroups/`. + * Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfiles/{security_profile\}`. */ name?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the AddressGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * Required. Field mask is used to specify the fields to be overwritten in the SecurityProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$AddressGroup; - } - export interface Params$Resource$Projects$Locations$Addressgroups$Removeitems - extends StandardParameters { - /** - * Required. A name of the AddressGroup to remove items from. Must be in the format `projects|organization/x/locations/{location\}/addressGroups/x`. - */ - addressGroup?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemoveAddressGroupItemsRequest; - } - export interface Params$Resource$Projects$Locations$Addressgroups$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + requestBody?: Schema$SecurityProfile; } - export interface Params$Resource$Projects$Locations$Addressgroups$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } } - export class Resource$Projects$Locations$Authorizationpolicies { + export class Resource$Projects$Locations { context: APIRequestContext; + addressGroups: Resource$Projects$Locations$Addressgroups; + authorizationPolicies: Resource$Projects$Locations$Authorizationpolicies; + clientTlsPolicies: Resource$Projects$Locations$Clienttlspolicies; + firewallEndpointAssociations: Resource$Projects$Locations$Firewallendpointassociations; + gatewaySecurityPolicies: Resource$Projects$Locations$Gatewaysecuritypolicies; + operations: Resource$Projects$Locations$Operations; + serverTlsPolicies: Resource$Projects$Locations$Servertlspolicies; + tlsInspectionPolicies: Resource$Projects$Locations$Tlsinspectionpolicies; + urlLists: Resource$Projects$Locations$Urllists; constructor(context: APIRequestContext) { this.context = context; + this.addressGroups = new Resource$Projects$Locations$Addressgroups( + this.context + ); + this.authorizationPolicies = + new Resource$Projects$Locations$Authorizationpolicies(this.context); + this.clientTlsPolicies = + new Resource$Projects$Locations$Clienttlspolicies(this.context); + this.firewallEndpointAssociations = + new Resource$Projects$Locations$Firewallendpointassociations( + this.context + ); + this.gatewaySecurityPolicies = + new Resource$Projects$Locations$Gatewaysecuritypolicies(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.serverTlsPolicies = + new Resource$Projects$Locations$Servertlspolicies(this.context); + this.tlsInspectionPolicies = + new Resource$Projects$Locations$Tlsinspectionpolicies(this.context); + this.urlLists = new Resource$Projects$Locations$Urllists(this.context); } /** - * Creates a new AuthorizationPolicy in a given project and location. + * Gets information about a location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + get( + params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Addressgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Adds items to an address group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addItems( + params: Params$Resource$Projects$Locations$Addressgroups$Additems, + options: StreamMethodOptions + ): GaxiosPromise; + addItems( + params?: Params$Resource$Projects$Locations$Addressgroups$Additems, + options?: MethodOptions + ): GaxiosPromise; + addItems( + params: Params$Resource$Projects$Locations$Addressgroups$Additems, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addItems( + params: Params$Resource$Projects$Locations$Addressgroups$Additems, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addItems( + params: Params$Resource$Projects$Locations$Addressgroups$Additems, + callback: BodyResponseCallback + ): void; + addItems(callback: BodyResponseCallback): void; + addItems( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Additems + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Additems; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Addressgroups$Additems; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+addressGroup}:addItems').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['addressGroup'], + pathParams: ['addressGroup'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Clones items from one address group to another. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cloneItems( + params: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, + options: StreamMethodOptions + ): GaxiosPromise; + cloneItems( + params?: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, + options?: MethodOptions + ): GaxiosPromise; + cloneItems( + params: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cloneItems( + params: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cloneItems( + params: Params$Resource$Projects$Locations$Addressgroups$Cloneitems, + callback: BodyResponseCallback + ): void; + cloneItems(callback: BodyResponseCallback): void; + cloneItems( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Cloneitems + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Cloneitems; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Addressgroups$Cloneitems; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+addressGroup}:cloneItems').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['addressGroup'], + pathParams: ['addressGroup'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new address group in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Addressgroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Addressgroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Addressgroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Addressgroups$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Addressgroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Addressgroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/addressGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single address group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Addressgroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Addressgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Addressgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Addressgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Addressgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Addressgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single address group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Addressgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Addressgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Addressgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Addressgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Addressgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Addressgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Addressgroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Addressgroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists address groups in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Addressgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Addressgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Addressgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Addressgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Addressgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Addressgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/addressGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists references of an address group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listReferences( + params: Params$Resource$Projects$Locations$Addressgroups$Listreferences, + options: StreamMethodOptions + ): GaxiosPromise; + listReferences( + params?: Params$Resource$Projects$Locations$Addressgroups$Listreferences, + options?: MethodOptions + ): GaxiosPromise; + listReferences( + params: Params$Resource$Projects$Locations$Addressgroups$Listreferences, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listReferences( + params: Params$Resource$Projects$Locations$Addressgroups$Listreferences, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listReferences( + params: Params$Resource$Projects$Locations$Addressgroups$Listreferences, + callback: BodyResponseCallback + ): void; + listReferences( + callback: BodyResponseCallback + ): void; + listReferences( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Listreferences + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Listreferences; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Addressgroups$Listreferences; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+addressGroup}:listReferences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['addressGroup'], + pathParams: ['addressGroup'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single address group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Addressgroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Addressgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Addressgroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Addressgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Addressgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Addressgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Removes items from an address group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeItems( + params: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + options: StreamMethodOptions + ): GaxiosPromise; + removeItems( + params?: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + options?: MethodOptions + ): GaxiosPromise; + removeItems( + params: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeItems( + params: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeItems( + params: Params$Resource$Projects$Locations$Addressgroups$Removeitems, + callback: BodyResponseCallback + ): void; + removeItems(callback: BodyResponseCallback): void; + removeItems( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Removeitems + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Removeitems; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Addressgroups$Removeitems; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+addressGroup}:removeItems').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['addressGroup'], + pathParams: ['addressGroup'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Addressgroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Addressgroups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Addressgroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Addressgroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Addressgroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Addressgroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Addressgroups$Additems + extends StandardParameters { + /** + * Required. A name of the AddressGroup to add items to. Must be in the format `projects|organization/x/locations/{location\}/addressGroups/x`. + */ + addressGroup?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddAddressGroupItemsRequest; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Cloneitems + extends StandardParameters { + /** + * Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/x/locations/{location\}/addressGroups/x`. + */ + addressGroup?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloneAddressGroupItemsRequest; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Create + extends StandardParameters { + /** + * Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy". + */ + addressGroupId?: string; + /** + * Required. The parent resource of the AddressGroup. Must be in the format `projects/x/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddressGroup; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Delete + extends StandardParameters { + /** + * Required. A name of the AddressGroup to delete. Must be in the format `projects/x/locations/{location\}/addressGroups/x`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Get + extends StandardParameters { + /** + * Required. A name of the AddressGroup to get. Must be in the format `projects/x/locations/{location\}/addressGroups/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Addressgroups$List + extends StandardParameters { + /** + * Maximum number of AddressGroups to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListAddressGroupsResponse` Indicates that this is a continuation of a prior `ListAddressGroups` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/x/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Listreferences + extends StandardParameters { + /** + * Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/x/locations/{location\}/addressGroups/x`. + */ + addressGroup?: string; + /** + * The maximum number of references 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 AddressGroupUsers left to be queried. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Patch + extends StandardParameters { + /** + * Required. Name of the AddressGroup resource. It matches pattern `projects/x/locations/{location\}/addressGroups/`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the AddressGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddressGroup; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Removeitems + extends StandardParameters { + /** + * Required. A name of the AddressGroup to remove items from. Must be in the format `projects|organization/x/locations/{location\}/addressGroups/x`. + */ + addressGroup?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveAddressGroupItemsRequest; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Addressgroups$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Authorizationpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new AuthorizationPolicy in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizationpolicies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizationpolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/authorizationPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single AuthorizationPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizationpolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizationpolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single AuthorizationPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Authorizationpolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizationpolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizationpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists AuthorizationPolicies in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Authorizationpolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Authorizationpolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizationpolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizationpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizationpolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizationpolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizationpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizationpolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/authorizationPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single AuthorizationPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizationpolicies$Create + | Params$Resource$Projects$Locations$Authorizationpolicies$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3896,13 +6219,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Create; + {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizationpolicies$Create; + {} as Params$Resource$Projects$Locations$Authorizationpolicies$Patch; options = {}; } @@ -3916,17 +6239,14 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/authorizationPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -3940,58 +6260,63 @@ export namespace networksecurity_v1 { } /** - * Deletes a single AuthorizationPolicy. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizationpolicies$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Delete; + {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizationpolicies$Delete; + {} as Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy; options = {}; } @@ -4005,82 +6330,89 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single AuthorizationPolicy. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Authorizationpolicies$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Get, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizationpolicies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Get; + {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizationpolicies$Get; + {} as Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions; options = {}; } @@ -4094,84 +6426,188 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Authorizationpolicies$Create + extends StandardParameters { + /** + * Required. Short name of the AuthorizationPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy". + */ + authorizationPolicyId?: string; + /** + * Required. The parent resource of the AuthorizationPolicy. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AuthorizationPolicy; + } + export interface Params$Resource$Projects$Locations$Authorizationpolicies$Delete + extends StandardParameters { + /** + * Required. A name of the AuthorizationPolicy to delete. Must be in the format `projects/{project\}/locations/{location\}/authorizationPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizationpolicies$Get + extends StandardParameters { + /** + * Required. A name of the AuthorizationPolicy to get. Must be in the format `projects/{project\}/locations/{location\}/authorizationPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Authorizationpolicies$List + extends StandardParameters { + /** + * Maximum number of AuthorizationPolicies to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListAuthorizationPoliciesResponse` Indicates that this is a continuation of a prior `ListAuthorizationPolicies` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the AuthorizationPolicies should be listed, specified in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Authorizationpolicies$Patch + extends StandardParameters { + /** + * Required. Name of the AuthorizationPolicy resource. It matches pattern `projects/{project\}/locations/{location\}/authorizationPolicies/`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the AuthorizationPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AuthorizationPolicy; + } + export interface Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Clienttlspolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates a new ClientTlsPolicy in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clienttlspolicies$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy; + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Create; options = {}; } @@ -4185,89 +6621,82 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/clientTlsPolicies').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists AuthorizationPolicies in a given project and location. + * Deletes a single ClientTlsPolicy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Authorizationpolicies$List, + delete( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Authorizationpolicies$List, + delete( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Authorizationpolicies$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizationpolicies$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Authorizationpolicies$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizationpolicies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clienttlspolicies$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizationpolicies$List; + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizationpolicies$List; + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Delete; options = {}; } @@ -4281,84 +6710,78 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/authorizationPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single AuthorizationPolicy. + * Gets details of a single ClientTlsPolicy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, + get( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, + get( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizationpolicies$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clienttlspolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Patch; + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Authorizationpolicies$Patch; + params = {} as Params$Resource$Projects$Locations$Clienttlspolicies$Get; options = {}; } @@ -4373,7 +6796,7 @@ export namespace networksecurity_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', }, options ), @@ -4383,51 +6806,51 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, options?: MethodOptions ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy + | Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4443,13 +6866,13 @@ export namespace networksecurity_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy; + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy; options = {}; } @@ -4463,11 +6886,11 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -4487,65 +6910,65 @@ export namespace networksecurity_v1 { } /** - * 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. + * Lists ClientTlsPolicies in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Clienttlspolicies$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Clienttlspolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Clienttlspolicies$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Clienttlspolicies$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clienttlspolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions; + {} as Params$Resource$Projects$Locations$Clienttlspolicies$List; options = {}; } @@ -4559,169 +6982,65 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/clientTlsPolicies').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Authorizationpolicies$Create - extends StandardParameters { - /** - * Required. Short name of the AuthorizationPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy". - */ - authorizationPolicyId?: string; - /** - * Required. The parent resource of the AuthorizationPolicy. Must be in the format `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AuthorizationPolicy; - } - export interface Params$Resource$Projects$Locations$Authorizationpolicies$Delete - extends StandardParameters { - /** - * Required. A name of the AuthorizationPolicy to delete. Must be in the format `projects/{project\}/locations/{location\}/authorizationPolicies/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizationpolicies$Get - extends StandardParameters { - /** - * Required. A name of the AuthorizationPolicy to get. Must be in the format `projects/{project\}/locations/{location\}/authorizationPolicies/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizationpolicies$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Authorizationpolicies$List - extends StandardParameters { - /** - * Maximum number of AuthorizationPolicies to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListAuthorizationPoliciesResponse` Indicates that this is a continuation of a prior `ListAuthorizationPolicies` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the AuthorizationPolicies should be listed, specified in the format `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Authorizationpolicies$Patch - extends StandardParameters { - /** - * Required. Name of the AuthorizationPolicy resource. It matches pattern `projects/{project\}/locations/{location\}/authorizationPolicies/`. - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the AuthorizationPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AuthorizationPolicy; - } - export interface Params$Resource$Projects$Locations$Authorizationpolicies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Authorizationpolicies$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Clienttlspolicies { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new ClientTlsPolicy in a given project and location. + * Updates the parameters of a single ClientTlsPolicy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + patch( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + patch( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + patch( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + patch( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + patch( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Create + | Params$Resource$Projects$Locations$Clienttlspolicies$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4734,13 +7053,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Create; + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Create; + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Patch; options = {}; } @@ -4754,17 +7073,14 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/clientTlsPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -4778,58 +7094,63 @@ export namespace networksecurity_v1 { } /** - * Deletes a single ClientTlsPolicy. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Delete; + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Delete; + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy; options = {}; } @@ -4843,78 +7164,89 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single ClientTlsPolicy. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Get; + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Clienttlspolicies$Get; + params = + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions; options = {}; } @@ -4928,84 +7260,188 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Create + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Required. Short name of the ClientTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "client_mtls_policy". + */ + clientTlsPolicyId?: string; + /** + * Required. The parent resource of the ClientTlsPolicy. Must be in the format `projects/x/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ClientTlsPolicy; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Delete + extends StandardParameters { + /** + * Required. A name of the ClientTlsPolicy to delete. Must be in the format `projects/x/locations/{location\}/clientTlsPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Get + extends StandardParameters { + /** + * Required. A name of the ClientTlsPolicy to get. Must be in the format `projects/x/locations/{location\}/clientTlsPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$List + extends StandardParameters { + /** + * Maximum number of ClientTlsPolicies to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListClientTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListClientTlsPolicies` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the ClientTlsPolicies should be listed, specified in the format `projects/x/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Patch + extends StandardParameters { + /** + * Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/x/locations/{location\}/clientTlsPolicies/{client_tls_policy\}` + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ClientTlsPolicy; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Firewallendpointassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new FirewallEndpointAssociation in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Firewallendpointassociations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy; + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$Create; options = {}; } @@ -5019,89 +7455,81 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1/{+parent}/firewallEndpointAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ClientTlsPolicies in a given project and location. + * Deletes a single FirewallEndpointAssociation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Clienttlspolicies$List, + delete( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$List, + delete( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Clienttlspolicies$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Clienttlspolicies$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Clienttlspolicies$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Firewallendpointassociations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$List; + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$List; + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$Delete; options = {}; } @@ -5115,84 +7543,86 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/clientTlsPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single ClientTlsPolicy. + * Gets details of a single FirewallEndpointAssociation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + get( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + get( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Firewallendpointassociations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Patch; + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Patch; + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$Get; options = {}; } @@ -5207,7 +7637,7 @@ export namespace networksecurity_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', }, options ), @@ -5217,73 +7647,75 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists Associations in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Firewallendpointassociations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy; + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$List; options = {}; } @@ -5297,89 +7729,83 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1/{+parent}/firewallEndpointAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * Update a single FirewallEndpointAssociation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Firewallendpointassociations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions; + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$Patch; options = {}; } @@ -5393,127 +7819,107 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Create + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Create extends StandardParameters { /** - * Required. Short name of the ClientTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "client_mtls_policy". + * Optional. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_association_id from the method_signature of Create RPC. */ - clientTlsPolicyId?: string; + firewallEndpointAssociationId?: string; /** - * Required. The parent resource of the ClientTlsPolicy. Must be in the format `projects/x/locations/{location\}`. + * Required. Value for parent. */ parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$ClientTlsPolicy; + requestBody?: Schema$FirewallEndpointAssociation; } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Delete + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Delete extends StandardParameters { /** - * Required. A name of the ClientTlsPolicy to delete. Must be in the format `projects/x/locations/{location\}/clientTlsPolicies/x`. + * Required. Name of the resource */ name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Get + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Get extends StandardParameters { /** - * Required. A name of the ClientTlsPolicy to get. Must be in the format `projects/x/locations/{location\}/clientTlsPolicies/x`. + * Required. Name of the resource */ name?: string; } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$List extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. Filtering results */ - 'options.requestedPolicyVersion'?: number; + filter?: string; /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Hint for how to order the results */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of ClientTlsPolicies to return per call. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * The value returned by the last `ListClientTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListClientTlsPolicies` call, and that the system should return the next page of data. + * A token identifying a page of results the server should return. */ pageToken?: string; /** - * Required. The project and location from which the ClientTlsPolicies should be listed, specified in the format `projects/x/locations/{location\}`. + * Required. Parent value for ListAssociationsRequest */ parent?: string; } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Patch + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Patch extends StandardParameters { /** - * Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/x/locations/{location\}/clientTlsPolicies/{client_tls_policy\}` + * Immutable. Identifier. name of resource */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ClientTlsPolicy; - } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions - extends StandardParameters { + requestId?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Required. Field mask is used to specify the fields to be overwritten in the Association resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + requestBody?: Schema$FirewallEndpointAssociation; } export class Resource$Projects$Locations$Gatewaysecuritypolicies { diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index fb78dc5c12a..3fa776a7948 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -375,6 +375,10 @@ export namespace networksecurity_v1beta1 { * Output only. Create time stamp */ createTime?: string | null; + /** + * Optional. Whether the association is disabled. True indicates that traffic won't be intercepted + */ + disabled?: boolean | null; /** * Required. The URL of the FirewallEndpoint that is being associated. */ From 635493216451f719ea3ee2f5408c73b1737c857b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 57/78] fix(networkservices): update the API #### networkservices:v1beta1 The following keys were changed: - schemas.ExtensionChainExtension.properties.authority.description - schemas.ExtensionChainExtension.properties.failOpen.description - schemas.ExtensionChainExtension.properties.service.description - schemas.ExtensionChainExtension.properties.supportedEvents.items.enum - schemas.ExtensionChainExtension.properties.supportedEvents.items.enumDescriptions - schemas.ExtensionChainExtension.properties.timeout.description - schemas.ExtensionChainMatchCondition.properties.celExpression.description - schemas.LbRouteExtension.properties.labels.description - schemas.LbTrafficExtension.properties.labels.description --- discovery/networkservices-v1beta1.json | 24 ++++++++++++++---------- src/apis/networkservices/v1beta1.ts | 14 +++++++------- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index a19fefae0f5..14eeb46770b 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -2483,7 +2483,7 @@ } } }, - "revision": "20240207", + "revision": "20240228", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2697,11 +2697,11 @@ "id": "ExtensionChainExtension", "properties": { "authority": { - "description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service.", + "description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.", "type": "string" }, "failOpen": { - "description": "Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE`: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is `FALSE`.", + "description": "Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.", "type": "boolean" }, "forwardHeaders": { @@ -2716,7 +2716,7 @@ "type": "string" }, "service": { - "description": "Required. The reference to the service that runs the extension. Currently only Callout extensions are supported here. To configure a Callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.", + "description": "Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.", "type": "string" }, "supportedEvents": { @@ -2727,21 +2727,25 @@ "REQUEST_HEADERS", "REQUEST_BODY", "RESPONSE_HEADERS", - "RESPONSE_BODY" + "RESPONSE_BODY", + "REQUEST_TRAILERS", + "RESPONSE_TRAILERS" ], "enumDescriptions": [ "Unspecified value. Do not use.", "If included in `supported_events`, the extension is called when the HTTP request headers arrive.", "If included in `supported_events`, the extension is called when the HTTP request body arrives.", "If included in `supported_events`, the extension is called when the HTTP response headers arrive.", - "If included in `supported_events`, the extension is called when the HTTP response body arrives." + "If included in `supported_events`, the extension is called when the HTTP response body arrives.", + "If included in `supported_events`, the extension is called when the HTTP request trailers arrives.", + "If included in `supported_events`, the extension is called when the HTTP response trailers arrives." ], "type": "string" }, "type": "array" }, "timeout": { - "description": "Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds.", + "description": "Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions.", "format": "google-duration", "type": "string" } @@ -2753,7 +2757,7 @@ "id": "ExtensionChainMatchCondition", "properties": { "celExpression": { - "description": "Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).", + "description": "Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](/service-extensions/docs/cel-matcher-language-reference).", "type": "string" } }, @@ -3771,7 +3775,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", + "description": "Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.", "type": "object" }, "loadBalancingScheme": { @@ -3833,7 +3837,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", + "description": "Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.", "type": "object" }, "loadBalancingScheme": { diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 6503bff250a..882b396de85 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -276,11 +276,11 @@ export namespace networkservices_v1beta1 { */ export interface Schema$ExtensionChainExtension { /** - * Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. + * Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. */ authority?: string | null; /** - * Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE`: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is `FALSE`. + * Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. */ failOpen?: boolean | null; /** @@ -292,7 +292,7 @@ export namespace networkservices_v1beta1 { */ name?: string | null; /** - * Required. The reference to the service that runs the extension. Currently only Callout extensions are supported here. To configure a Callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/backendServices/{backendService\}` or `https://www.googleapis.com/compute/v1/projects/{project\}/global/backendServices/{backendService\}`. + * Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/backendServices/{backendService\}` or `https://www.googleapis.com/compute/v1/projects/{project\}/global/backendServices/{backendService\}`. */ service?: string | null; /** @@ -300,7 +300,7 @@ export namespace networkservices_v1beta1 { */ supportedEvents?: string[] | null; /** - * Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. + * Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. */ timeout?: string | null; } @@ -309,7 +309,7 @@ export namespace networkservices_v1beta1 { */ export interface Schema$ExtensionChainMatchCondition { /** - * Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference). + * Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](/service-extensions/docs/cel-matcher-language-reference). */ celExpression?: string | null; } @@ -1050,7 +1050,7 @@ export namespace networkservices_v1beta1 { */ forwardingRules?: string[] | null; /** - * Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). + * Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. */ labels?: {[key: string]: string} | null; /** @@ -1087,7 +1087,7 @@ export namespace networkservices_v1beta1 { */ forwardingRules?: string[] | null; /** - * Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). + * Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. */ labels?: {[key: string]: string} | null; /** From 4793392057a45dd548d0c64c4e8d51cfa2a43908 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 58/78] fix(notebooks): update the API #### notebooks:v1 The following keys were changed: - schemas.Binding.properties.role.description #### notebooks:v2 The following keys were changed: - schemas.Binding.properties.role.description --- discovery/notebooks-v1.json | 4 ++-- discovery/notebooks-v2.json | 4 ++-- src/apis/notebooks/v1.ts | 2 +- src/apis/notebooks/v2.ts | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/discovery/notebooks-v1.json b/discovery/notebooks-v1.json index 21332a841d8..dd259232e64 100644 --- a/discovery/notebooks-v1.json +++ b/discovery/notebooks-v1.json @@ -2008,7 +2008,7 @@ } } }, - "revision": "20240118", + "revision": "20231227", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2073,7 +2073,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", "type": "string" } }, diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index d80ced47f2e..b682b714efd 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -876,7 +876,7 @@ } } }, - "revision": "20240118", + "revision": "20231227", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -937,7 +937,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", "type": "string" } }, diff --git a/src/apis/notebooks/v1.ts b/src/apis/notebooks/v1.ts index c882d3665db..e8307f1dcb0 100644 --- a/src/apis/notebooks/v1.ts +++ b/src/apis/notebooks/v1.ts @@ -150,7 +150,7 @@ export namespace notebooks_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string | null; } diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index 4634ef758ac..0c4727dac3f 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -150,7 +150,7 @@ export namespace notebooks_v2 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string | null; } From 6eba24ad4915697dc035d8cb9ba64e2d5da495ff Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 59/78] feat(places): update the API #### places:v1 The following keys were added: - schemas.GoogleMapsPlacesV1SearchTextRequest.properties.evOptions.$ref - schemas.GoogleMapsPlacesV1SearchTextRequest.properties.evOptions.description - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.description - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.id - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.connectorTypes.description - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.connectorTypes.items.enum - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.connectorTypes.items.enumDescriptions - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.connectorTypes.items.type - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.connectorTypes.type - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.minimumChargingRateKw.description - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.minimumChargingRateKw.format - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.minimumChargingRateKw.type - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.type --- discovery/places-v1.json | 49 +++++++++++++++++++++++++++++++++++++++- src/apis/places/v1.ts | 17 ++++++++++++++ 2 files changed, 65 insertions(+), 1 deletion(-) diff --git a/discovery/places-v1.json b/discovery/places-v1.json index 4be41c4d9a7..be1edfc4dfb 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -276,7 +276,7 @@ } } }, - "revision": "20240221", + "revision": "20240312", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1458,6 +1458,10 @@ "description": "Request proto for SearchText. ", "id": "GoogleMapsPlacesV1SearchTextRequest", "properties": { + "evOptions": { + "$ref": "GoogleMapsPlacesV1SearchTextRequestEVOptions", + "description": "Optional. Set the searchable EV options of a place search request." + }, "includedType": { "description": "The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types. Only support one included type.", "type": "string" @@ -1540,6 +1544,49 @@ }, "type": "object" }, + "GoogleMapsPlacesV1SearchTextRequestEVOptions": { + "description": "Searchable EV options of a place search request.", + "id": "GoogleMapsPlacesV1SearchTextRequestEVOptions", + "properties": { + "connectorTypes": { + "description": "Optional. The list of preferred EV connector types. A place that does not support any of the listed connector types are filter out.", + "items": { + "enum": [ + "EV_CONNECTOR_TYPE_UNSPECIFIED", + "EV_CONNECTOR_TYPE_OTHER", + "EV_CONNECTOR_TYPE_J1772", + "EV_CONNECTOR_TYPE_TYPE_2", + "EV_CONNECTOR_TYPE_CHADEMO", + "EV_CONNECTOR_TYPE_CCS_COMBO_1", + "EV_CONNECTOR_TYPE_CCS_COMBO_2", + "EV_CONNECTOR_TYPE_TESLA", + "EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T", + "EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET" + ], + "enumDescriptions": [ + "Unspecified connector.", + "Other connector types.", + "J1772 type 1 connector.", + "IEC 62196 type 2 connector. Often referred to as MENNEKES.", + "CHAdeMO type connector.", + "Combined Charging System (AC and DC). Based on SAE. Type-1 J-1772 connector", + "Combined Charging System (AC and DC). Based on Type-2 Mennekes connector", + "The generic TESLA connector. This is NACS in the North America but can be non-NACS in other parts of the world (e.g. CCS Combo 2 (CCS2) or GB/T). This value is less representative of an actual connector type, and more represents the ability to charge a Tesla brand vehicle at a Tesla owned charging station.", + "GB/T type corresponds to the GB/T standard in China. This type covers all GB_T types.", + "Unspecified wall outlet." + ], + "type": "string" + }, + "type": "array" + }, + "minimumChargingRateKw": { + "description": "Optional. Filtering places by minimum charging rate. Any places with charging a rate less than the minimum charging rate are filtered out.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleMapsPlacesV1SearchTextRequestLocationBias": { "description": "The region to search. This location serves as a bias which means results around given location might be returned.", "id": "GoogleMapsPlacesV1SearchTextRequestLocationBias", diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index 9eb4ec1f84e..4dac8492fa6 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -999,6 +999,10 @@ export namespace places_v1 { * Request proto for SearchText. */ export interface Schema$GoogleMapsPlacesV1SearchTextRequest { + /** + * Optional. Set the searchable EV options of a place search request. + */ + evOptions?: Schema$GoogleMapsPlacesV1SearchTextRequestEVOptions; /** * The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types. Only support one included type. */ @@ -1048,6 +1052,19 @@ export namespace places_v1 { */ textQuery?: string | null; } + /** + * Searchable EV options of a place search request. + */ + export interface Schema$GoogleMapsPlacesV1SearchTextRequestEVOptions { + /** + * Optional. The list of preferred EV connector types. A place that does not support any of the listed connector types are filter out. + */ + connectorTypes?: string[] | null; + /** + * Optional. Filtering places by minimum charging rate. Any places with charging a rate less than the minimum charging rate are filtered out. + */ + minimumChargingRateKw?: number | null; + } /** * The region to search. This location serves as a bias which means results around given location might be returned. */ From 49b07d639a5cbda7ac5b2c3bf2264f8736a22cc9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 60/78] feat(playdeveloperreporting): update the API #### playdeveloperreporting:v1alpha1 The following keys were added: - resources.vitals.resources.errors.resources.issues.methods.search.parameters.sampleErrorReportLimit.description - resources.vitals.resources.errors.resources.issues.methods.search.parameters.sampleErrorReportLimit.format - resources.vitals.resources.errors.resources.issues.methods.search.parameters.sampleErrorReportLimit.location - resources.vitals.resources.errors.resources.issues.methods.search.parameters.sampleErrorReportLimit.type - schemas.GooglePlayDeveloperReportingV1alpha1ErrorIssue.properties.sampleErrorReports.description - schemas.GooglePlayDeveloperReportingV1alpha1ErrorIssue.properties.sampleErrorReports.items.type - schemas.GooglePlayDeveloperReportingV1alpha1ErrorIssue.properties.sampleErrorReports.readOnly - schemas.GooglePlayDeveloperReportingV1alpha1ErrorIssue.properties.sampleErrorReports.type The following keys were changed: - resources.vitals.resources.errors.resources.reports.methods.search.parameters.filter.description #### playdeveloperreporting:v1beta1 The following keys were added: - resources.vitals.resources.errors.resources.issues.methods.search.parameters.sampleErrorReportLimit.description - resources.vitals.resources.errors.resources.issues.methods.search.parameters.sampleErrorReportLimit.format - resources.vitals.resources.errors.resources.issues.methods.search.parameters.sampleErrorReportLimit.location - resources.vitals.resources.errors.resources.issues.methods.search.parameters.sampleErrorReportLimit.type - schemas.GooglePlayDeveloperReportingV1beta1ErrorIssue.properties.sampleErrorReports.description - schemas.GooglePlayDeveloperReportingV1beta1ErrorIssue.properties.sampleErrorReports.items.type - schemas.GooglePlayDeveloperReportingV1beta1ErrorIssue.properties.sampleErrorReports.readOnly - schemas.GooglePlayDeveloperReportingV1beta1ErrorIssue.properties.sampleErrorReports.type The following keys were changed: - resources.vitals.resources.errors.resources.reports.methods.search.parameters.filter.description --- discovery/playdeveloperreporting-v1alpha1.json | 18 ++++++++++++++++-- discovery/playdeveloperreporting-v1beta1.json | 18 ++++++++++++++++-- src/apis/playdeveloperreporting/v1alpha1.ts | 10 +++++++++- src/apis/playdeveloperreporting/v1beta1.ts | 10 +++++++++- 4 files changed, 50 insertions(+), 6 deletions(-) diff --git a/discovery/playdeveloperreporting-v1alpha1.json b/discovery/playdeveloperreporting-v1alpha1.json index c96a288adbd..3124e77c6a2 100644 --- a/discovery/playdeveloperreporting-v1alpha1.json +++ b/discovery/playdeveloperreporting-v1alpha1.json @@ -535,6 +535,12 @@ "pattern": "^apps/[^/]+$", "required": true, "type": "string" + }, + "sampleErrorReportLimit": { + "description": "Optional. Number of sample error reports to return per ErrorIssue. If unspecified, 0 will be used. *Note:* currently only 0 and 1 are supported.", + "format": "int32", + "location": "query", + "type": "integer" } }, "path": "v1alpha1/{+parent}/errorIssues:search", @@ -559,7 +565,7 @@ ], "parameters": { "filter": { - "description": "A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = \"google/walleye\" OR deviceModel = \"google/marlin\"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = \"Google\". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = \"PHONE\"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`", + "description": "A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = \"google/walleye\" OR deviceModel = \"google/marlin\"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = \"Google\". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = \"PHONE\"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`", "location": "query", "type": "string" }, @@ -941,7 +947,7 @@ } } }, - "revision": "20240205", + "revision": "20240312", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { @@ -1178,6 +1184,14 @@ "description": "Identifier. The resource name of the issue. Format: apps/{app}/{issue}", "type": "string" }, + "sampleErrorReports": { + "description": "Output only. Sample error reports which belong to this ErrorIssue. *Note:* currently a maximum of 1 per ErrorIssue is supported. Format: \"apps/{app}/{report}\"", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "type": { "description": "Type of the errors grouped in this issue.", "enum": [ diff --git a/discovery/playdeveloperreporting-v1beta1.json b/discovery/playdeveloperreporting-v1beta1.json index 9649390c56b..86ad107a53f 100644 --- a/discovery/playdeveloperreporting-v1beta1.json +++ b/discovery/playdeveloperreporting-v1beta1.json @@ -535,6 +535,12 @@ "pattern": "^apps/[^/]+$", "required": true, "type": "string" + }, + "sampleErrorReportLimit": { + "description": "Optional. Number of sample error reports to return per ErrorIssue. If unspecified, 0 will be used. *Note:* currently only 0 and 1 are supported.", + "format": "int32", + "location": "query", + "type": "integer" } }, "path": "v1beta1/{+parent}/errorIssues:search", @@ -559,7 +565,7 @@ ], "parameters": { "filter": { - "description": "A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = \"google/walleye\" OR deviceModel = \"google/marlin\"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = \"Google\". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = \"PHONE\"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`", + "description": "A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = \"google/walleye\" OR deviceModel = \"google/marlin\"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = \"Google\". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = \"PHONE\"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`", "location": "query", "type": "string" }, @@ -941,7 +947,7 @@ } } }, - "revision": "20240205", + "revision": "20240312", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { @@ -1178,6 +1184,14 @@ "description": "Identifier. The resource name of the issue. Format: apps/{app}/{issue}", "type": "string" }, + "sampleErrorReports": { + "description": "Output only. Sample error reports which belong to this ErrorIssue. *Note:* currently a maximum of 1 per ErrorIssue is supported. Format: \"apps/{app}/{report}\"", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "type": { "description": "Type of the errors grouped in this issue.", "enum": [ diff --git a/src/apis/playdeveloperreporting/v1alpha1.ts b/src/apis/playdeveloperreporting/v1alpha1.ts index 6c1940f211d..b8c0e73a3be 100644 --- a/src/apis/playdeveloperreporting/v1alpha1.ts +++ b/src/apis/playdeveloperreporting/v1alpha1.ts @@ -334,6 +334,10 @@ export namespace playdeveloperreporting_v1alpha1 { * Identifier. The resource name of the issue. Format: apps/{app\}/{issue\} */ name?: string | null; + /** + * Output only. Sample error reports which belong to this ErrorIssue. *Note:* currently a maximum of 1 per ErrorIssue is supported. Format: "apps/{app\}/{report\}" + */ + sampleErrorReports?: string[] | null; /** * Type of the errors grouped in this issue. */ @@ -2229,6 +2233,10 @@ export namespace playdeveloperreporting_v1alpha1 { * Required. Parent resource of the error issues, indicating the application for which they were received. Format: apps/{app\} */ parent?: string; + /** + * Optional. Number of sample error reports to return per ErrorIssue. If unspecified, 0 will be used. *Note:* currently only 0 and 1 are supported. + */ + sampleErrorReportLimit?: number; } export class Resource$Vitals$Errors$Reports { @@ -2338,7 +2346,7 @@ export namespace playdeveloperreporting_v1alpha1 { export interface Params$Resource$Vitals$Errors$Reports$Search extends StandardParameters { /** - * A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)` + * A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)` */ filter?: string; /** diff --git a/src/apis/playdeveloperreporting/v1beta1.ts b/src/apis/playdeveloperreporting/v1beta1.ts index 9b3ccaf6dde..ea994d65cf7 100644 --- a/src/apis/playdeveloperreporting/v1beta1.ts +++ b/src/apis/playdeveloperreporting/v1beta1.ts @@ -334,6 +334,10 @@ export namespace playdeveloperreporting_v1beta1 { * Identifier. The resource name of the issue. Format: apps/{app\}/{issue\} */ name?: string | null; + /** + * Output only. Sample error reports which belong to this ErrorIssue. *Note:* currently a maximum of 1 per ErrorIssue is supported. Format: "apps/{app\}/{report\}" + */ + sampleErrorReports?: string[] | null; /** * Type of the errors grouped in this issue. */ @@ -2229,6 +2233,10 @@ export namespace playdeveloperreporting_v1beta1 { * Required. Parent resource of the error issues, indicating the application for which they were received. Format: apps/{app\} */ parent?: string; + /** + * Optional. Number of sample error reports to return per ErrorIssue. If unspecified, 0 will be used. *Note:* currently only 0 and 1 are supported. + */ + sampleErrorReportLimit?: number; } export class Resource$Vitals$Errors$Reports { @@ -2338,7 +2346,7 @@ export namespace playdeveloperreporting_v1beta1 { export interface Params$Resource$Vitals$Errors$Reports$Search extends StandardParameters { /** - * A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)` + * A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)` */ filter?: string; /** From 3422f112fba0ff42d6166c38cbff19e0c380bb5d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 61/78] fix(pubsub): update the API #### pubsub:v1beta1a The following keys were changed: - endpoints #### pubsub:v1beta2 The following keys were changed: - endpoints #### pubsub:v1 The following keys were changed: - endpoints - schemas.Topic.properties.ingestionDataSourceSettings.description --- discovery/pubsub-v1.json | 14 ++++++++++++-- discovery/pubsub-v1beta1a.json | 12 +++++++++++- discovery/pubsub-v1beta2.json | 12 +++++++++++- src/apis/pubsub/v1.ts | 2 +- 4 files changed, 35 insertions(+), 5 deletions(-) diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index f28da245aaa..5e0f26b29d5 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -23,6 +23,16 @@ "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", + "location": "europe-west3", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", + "location": "europe-west9", + "description": "Regional Endpoint" } ], "icons": { @@ -1573,7 +1583,7 @@ } } }, - "revision": "20240220", + "revision": "20240227", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -2551,7 +2561,7 @@ "properties": { "ingestionDataSourceSettings": { "$ref": "IngestionDataSourceSettings", - "description": "Optional. Settings for managed ingestion from a data source into this topic." + "description": "Optional. Settings for ingestion from a data source into this topic." }, "kmsKeyName": { "description": "Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", diff --git a/discovery/pubsub-v1beta1a.json b/discovery/pubsub-v1beta1a.json index c0837c15425..6b85cbeeecd 100644 --- a/discovery/pubsub-v1beta1a.json +++ b/discovery/pubsub-v1beta1a.json @@ -23,6 +23,16 @@ "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", + "location": "europe-west3", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", + "location": "europe-west9", + "description": "Regional Endpoint" } ], "icons": { @@ -464,7 +474,7 @@ } } }, - "revision": "20240220", + "revision": "20240227", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/pubsub-v1beta2.json b/discovery/pubsub-v1beta2.json index c9f894ba24a..67d3b67d94d 100644 --- a/discovery/pubsub-v1beta2.json +++ b/discovery/pubsub-v1beta2.json @@ -23,6 +23,16 @@ "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", + "location": "europe-west3", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", + "location": "europe-west9", + "description": "Regional Endpoint" } ], "icons": { @@ -731,7 +741,7 @@ } } }, - "revision": "20240220", + "revision": "20240227", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index fe71c292362..67fc224f77e 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -835,7 +835,7 @@ export namespace pubsub_v1 { */ export interface Schema$Topic { /** - * Optional. Settings for managed ingestion from a data source into this topic. + * Optional. Settings for ingestion from a data source into this topic. */ ingestionDataSourceSettings?: Schema$IngestionDataSourceSettings; /** From 5163287f3fe037741cf0bc4d0ed6105b8100dbd9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 62/78] feat(redis): update the API #### redis:v1beta1 The following keys were added: - schemas.AvailabilityConfiguration.description - schemas.AvailabilityConfiguration.id - schemas.AvailabilityConfiguration.properties.availabilityType.description - schemas.AvailabilityConfiguration.properties.availabilityType.enum - schemas.AvailabilityConfiguration.properties.availabilityType.enumDescriptions - schemas.AvailabilityConfiguration.properties.availabilityType.type - schemas.AvailabilityConfiguration.properties.externalReplicaConfigured.type - schemas.AvailabilityConfiguration.properties.promotableReplicaConfigured.type - schemas.AvailabilityConfiguration.type - schemas.BackupConfiguration.description - schemas.BackupConfiguration.id - schemas.BackupConfiguration.properties.automatedBackupEnabled.description - schemas.BackupConfiguration.properties.automatedBackupEnabled.type - schemas.BackupConfiguration.properties.backupRetentionSettings.$ref - schemas.BackupConfiguration.properties.backupRetentionSettings.description - schemas.BackupConfiguration.properties.pointInTimeRecoveryEnabled.description - schemas.BackupConfiguration.properties.pointInTimeRecoveryEnabled.type - schemas.BackupConfiguration.type - schemas.BackupRun.description - schemas.BackupRun.id - schemas.BackupRun.properties.endTime.description - schemas.BackupRun.properties.endTime.format - schemas.BackupRun.properties.endTime.type - schemas.BackupRun.properties.error.$ref - schemas.BackupRun.properties.error.description - schemas.BackupRun.properties.startTime.description - schemas.BackupRun.properties.startTime.format - schemas.BackupRun.properties.startTime.type - schemas.BackupRun.properties.status.description - schemas.BackupRun.properties.status.enum - schemas.BackupRun.properties.status.enumDescriptions - schemas.BackupRun.properties.status.type - schemas.BackupRun.type - schemas.Compliance.description - schemas.Compliance.id - schemas.Compliance.properties.standard.description - schemas.Compliance.properties.standard.type - schemas.Compliance.properties.version.description - schemas.Compliance.properties.version.type - schemas.Compliance.type - schemas.CustomMetadataData.description - schemas.CustomMetadataData.id - schemas.CustomMetadataData.properties.databaseMetadata.items.$ref - schemas.CustomMetadataData.properties.databaseMetadata.type - schemas.CustomMetadataData.type - schemas.DatabaseMetadata.description - schemas.DatabaseMetadata.id - schemas.DatabaseMetadata.properties.backupConfiguration.$ref - schemas.DatabaseMetadata.properties.backupConfiguration.description - schemas.DatabaseMetadata.properties.backupRun.$ref - schemas.DatabaseMetadata.properties.backupRun.description - schemas.DatabaseMetadata.properties.product.$ref - schemas.DatabaseMetadata.properties.resourceId.$ref - schemas.DatabaseMetadata.properties.resourceName.description - schemas.DatabaseMetadata.properties.resourceName.type - schemas.DatabaseMetadata.type - schemas.DatabaseResourceFeed.description - schemas.DatabaseResourceFeed.id - schemas.DatabaseResourceFeed.properties.feedTimestamp.description - schemas.DatabaseResourceFeed.properties.feedTimestamp.format - schemas.DatabaseResourceFeed.properties.feedTimestamp.type - schemas.DatabaseResourceFeed.properties.feedType.description - schemas.DatabaseResourceFeed.properties.feedType.enum - schemas.DatabaseResourceFeed.properties.feedType.enumDescriptions - schemas.DatabaseResourceFeed.properties.feedType.type - schemas.DatabaseResourceFeed.properties.recommendationSignalData.$ref - schemas.DatabaseResourceFeed.properties.recommendationSignalData.description - schemas.DatabaseResourceFeed.properties.resourceHealthSignalData.$ref - schemas.DatabaseResourceFeed.properties.resourceId.$ref - schemas.DatabaseResourceFeed.properties.resourceId.deprecated - schemas.DatabaseResourceFeed.properties.resourceId.description - schemas.DatabaseResourceFeed.properties.resourceMetadata.$ref - schemas.DatabaseResourceFeed.type - schemas.DatabaseResourceHealthSignalData.description - schemas.DatabaseResourceHealthSignalData.id - schemas.DatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.description - schemas.DatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.type - schemas.DatabaseResourceHealthSignalData.properties.additionalMetadata.description - schemas.DatabaseResourceHealthSignalData.properties.additionalMetadata.type - schemas.DatabaseResourceHealthSignalData.properties.compliance.description - schemas.DatabaseResourceHealthSignalData.properties.compliance.items.$ref - schemas.DatabaseResourceHealthSignalData.properties.compliance.type - schemas.DatabaseResourceHealthSignalData.properties.description.description - schemas.DatabaseResourceHealthSignalData.properties.description.type - schemas.DatabaseResourceHealthSignalData.properties.eventTime.description - schemas.DatabaseResourceHealthSignalData.properties.eventTime.format - schemas.DatabaseResourceHealthSignalData.properties.eventTime.type - schemas.DatabaseResourceHealthSignalData.properties.externalUri.description - schemas.DatabaseResourceHealthSignalData.properties.externalUri.type - schemas.DatabaseResourceHealthSignalData.properties.name.description - schemas.DatabaseResourceHealthSignalData.properties.name.type - schemas.DatabaseResourceHealthSignalData.properties.provider.description - schemas.DatabaseResourceHealthSignalData.properties.provider.enum - schemas.DatabaseResourceHealthSignalData.properties.provider.enumDescriptions - schemas.DatabaseResourceHealthSignalData.properties.provider.type - schemas.DatabaseResourceHealthSignalData.properties.resourceContainer.description - schemas.DatabaseResourceHealthSignalData.properties.resourceContainer.type - schemas.DatabaseResourceHealthSignalData.properties.resourceName.description - schemas.DatabaseResourceHealthSignalData.properties.resourceName.type - schemas.DatabaseResourceHealthSignalData.properties.signalClass.description - schemas.DatabaseResourceHealthSignalData.properties.signalClass.enum - schemas.DatabaseResourceHealthSignalData.properties.signalClass.enumDescriptions - schemas.DatabaseResourceHealthSignalData.properties.signalClass.type - schemas.DatabaseResourceHealthSignalData.properties.signalId.description - schemas.DatabaseResourceHealthSignalData.properties.signalId.type - schemas.DatabaseResourceHealthSignalData.properties.signalType.description - schemas.DatabaseResourceHealthSignalData.properties.signalType.enum - schemas.DatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.DatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.DatabaseResourceHealthSignalData.properties.signalType.type - schemas.DatabaseResourceHealthSignalData.properties.state.enum - schemas.DatabaseResourceHealthSignalData.properties.state.enumDescriptions - schemas.DatabaseResourceHealthSignalData.properties.state.type - schemas.DatabaseResourceHealthSignalData.type - schemas.DatabaseResourceId.description - schemas.DatabaseResourceId.id - schemas.DatabaseResourceId.properties.provider.description - schemas.DatabaseResourceId.properties.provider.enum - schemas.DatabaseResourceId.properties.provider.enumDescriptions - schemas.DatabaseResourceId.properties.provider.type - schemas.DatabaseResourceId.properties.providerDescription.description - schemas.DatabaseResourceId.properties.providerDescription.type - schemas.DatabaseResourceId.properties.resourceType.description - schemas.DatabaseResourceId.properties.resourceType.type - schemas.DatabaseResourceId.properties.uniqueId.description - schemas.DatabaseResourceId.properties.uniqueId.type - schemas.DatabaseResourceId.type - schemas.DatabaseResourceMetadata.description - schemas.DatabaseResourceMetadata.id - schemas.DatabaseResourceMetadata.properties.availabilityConfiguration.$ref - schemas.DatabaseResourceMetadata.properties.availabilityConfiguration.description - schemas.DatabaseResourceMetadata.properties.backupConfiguration.$ref - schemas.DatabaseResourceMetadata.properties.backupConfiguration.description - schemas.DatabaseResourceMetadata.properties.backupRun.$ref - schemas.DatabaseResourceMetadata.properties.backupRun.description - schemas.DatabaseResourceMetadata.properties.creationTime.description - schemas.DatabaseResourceMetadata.properties.creationTime.format - schemas.DatabaseResourceMetadata.properties.creationTime.type - schemas.DatabaseResourceMetadata.properties.currentState.description - schemas.DatabaseResourceMetadata.properties.currentState.enum - schemas.DatabaseResourceMetadata.properties.currentState.enumDescriptions - schemas.DatabaseResourceMetadata.properties.currentState.type - schemas.DatabaseResourceMetadata.properties.customMetadata.$ref - schemas.DatabaseResourceMetadata.properties.customMetadata.description - schemas.DatabaseResourceMetadata.properties.entitlements.description - schemas.DatabaseResourceMetadata.properties.entitlements.items.$ref - schemas.DatabaseResourceMetadata.properties.entitlements.type - schemas.DatabaseResourceMetadata.properties.expectedState.description - schemas.DatabaseResourceMetadata.properties.expectedState.enum - schemas.DatabaseResourceMetadata.properties.expectedState.enumDescriptions - schemas.DatabaseResourceMetadata.properties.expectedState.type - schemas.DatabaseResourceMetadata.properties.id.$ref - schemas.DatabaseResourceMetadata.properties.id.description - schemas.DatabaseResourceMetadata.properties.instanceType.description - schemas.DatabaseResourceMetadata.properties.instanceType.enum - schemas.DatabaseResourceMetadata.properties.instanceType.enumDeprecated - schemas.DatabaseResourceMetadata.properties.instanceType.enumDescriptions - schemas.DatabaseResourceMetadata.properties.instanceType.type - schemas.DatabaseResourceMetadata.properties.location.description - schemas.DatabaseResourceMetadata.properties.location.type - schemas.DatabaseResourceMetadata.properties.primaryResourceId.$ref - schemas.DatabaseResourceMetadata.properties.primaryResourceId.description - schemas.DatabaseResourceMetadata.properties.product.$ref - schemas.DatabaseResourceMetadata.properties.product.description - schemas.DatabaseResourceMetadata.properties.resourceContainer.description - schemas.DatabaseResourceMetadata.properties.resourceContainer.type - schemas.DatabaseResourceMetadata.properties.resourceName.description - schemas.DatabaseResourceMetadata.properties.resourceName.type - schemas.DatabaseResourceMetadata.properties.updationTime.description - schemas.DatabaseResourceMetadata.properties.updationTime.format - schemas.DatabaseResourceMetadata.properties.updationTime.type - schemas.DatabaseResourceMetadata.properties.userLabelSet.$ref - schemas.DatabaseResourceMetadata.properties.userLabelSet.description - schemas.DatabaseResourceMetadata.properties.userLabels.additionalProperties.type - schemas.DatabaseResourceMetadata.properties.userLabels.deprecated - schemas.DatabaseResourceMetadata.properties.userLabels.description - schemas.DatabaseResourceMetadata.properties.userLabels.type - schemas.DatabaseResourceMetadata.type - schemas.DatabaseResourceRecommendationSignalData.description - schemas.DatabaseResourceRecommendationSignalData.id - schemas.DatabaseResourceRecommendationSignalData.properties.additionalMetadata.additionalProperties.description - schemas.DatabaseResourceRecommendationSignalData.properties.additionalMetadata.additionalProperties.type - schemas.DatabaseResourceRecommendationSignalData.properties.additionalMetadata.description - schemas.DatabaseResourceRecommendationSignalData.properties.additionalMetadata.type - schemas.DatabaseResourceRecommendationSignalData.properties.lastRefreshTime.description - schemas.DatabaseResourceRecommendationSignalData.properties.lastRefreshTime.format - schemas.DatabaseResourceRecommendationSignalData.properties.lastRefreshTime.type - schemas.DatabaseResourceRecommendationSignalData.properties.recommendationState.description - schemas.DatabaseResourceRecommendationSignalData.properties.recommendationState.enum - schemas.DatabaseResourceRecommendationSignalData.properties.recommendationState.enumDescriptions - schemas.DatabaseResourceRecommendationSignalData.properties.recommendationState.type - schemas.DatabaseResourceRecommendationSignalData.properties.recommender.description - schemas.DatabaseResourceRecommendationSignalData.properties.recommender.type - schemas.DatabaseResourceRecommendationSignalData.properties.recommenderId.description - schemas.DatabaseResourceRecommendationSignalData.properties.recommenderId.type - schemas.DatabaseResourceRecommendationSignalData.properties.recommenderSubtype.description - schemas.DatabaseResourceRecommendationSignalData.properties.recommenderSubtype.type - schemas.DatabaseResourceRecommendationSignalData.properties.resourceName.description - schemas.DatabaseResourceRecommendationSignalData.properties.resourceName.type - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.description - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.type - schemas.DatabaseResourceRecommendationSignalData.type - schemas.Entitlement.description - schemas.Entitlement.id - schemas.Entitlement.properties.entitlementState.description - schemas.Entitlement.properties.entitlementState.enum - schemas.Entitlement.properties.entitlementState.enumDescriptions - schemas.Entitlement.properties.entitlementState.type - schemas.Entitlement.properties.type.description - schemas.Entitlement.properties.type.enum - schemas.Entitlement.properties.type.enumDeprecated - schemas.Entitlement.properties.type.enumDescriptions - schemas.Entitlement.properties.type.type - schemas.Entitlement.type - schemas.OperationError.description - schemas.OperationError.id - schemas.OperationError.properties.code.description - schemas.OperationError.properties.code.type - schemas.OperationError.properties.errorType.enum - schemas.OperationError.properties.errorType.enumDescriptions - schemas.OperationError.properties.errorType.type - schemas.OperationError.properties.message.description - schemas.OperationError.properties.message.type - schemas.OperationError.type - schemas.Product.description - schemas.Product.id - schemas.Product.properties.engine.description - schemas.Product.properties.engine.enum - schemas.Product.properties.engine.enumDeprecated - schemas.Product.properties.engine.enumDescriptions - schemas.Product.properties.engine.type - schemas.Product.properties.type.description - schemas.Product.properties.type.enum - schemas.Product.properties.type.enumDeprecated - schemas.Product.properties.type.enumDescriptions - schemas.Product.properties.type.type - schemas.Product.properties.version.description - schemas.Product.properties.version.type - schemas.Product.type - schemas.RetentionSettings.id - schemas.RetentionSettings.properties.quantityBasedRetention.format - schemas.RetentionSettings.properties.quantityBasedRetention.type - schemas.RetentionSettings.properties.retentionUnit.description - schemas.RetentionSettings.properties.retentionUnit.enum - schemas.RetentionSettings.properties.retentionUnit.enumDescriptions - schemas.RetentionSettings.properties.retentionUnit.type - schemas.RetentionSettings.properties.timeBasedRetention.format - schemas.RetentionSettings.properties.timeBasedRetention.type - schemas.RetentionSettings.type - schemas.UserLabels.description - schemas.UserLabels.id - schemas.UserLabels.properties.labels.additionalProperties.type - schemas.UserLabels.properties.labels.type - schemas.UserLabels.type #### redis:v1 The following keys were added: - schemas.AvailabilityConfiguration.description - schemas.AvailabilityConfiguration.id - schemas.AvailabilityConfiguration.properties.availabilityType.description - schemas.AvailabilityConfiguration.properties.availabilityType.enum - schemas.AvailabilityConfiguration.properties.availabilityType.enumDescriptions - schemas.AvailabilityConfiguration.properties.availabilityType.type - schemas.AvailabilityConfiguration.properties.externalReplicaConfigured.type - schemas.AvailabilityConfiguration.properties.promotableReplicaConfigured.type - schemas.AvailabilityConfiguration.type - schemas.BackupConfiguration.description - schemas.BackupConfiguration.id - schemas.BackupConfiguration.properties.automatedBackupEnabled.description - schemas.BackupConfiguration.properties.automatedBackupEnabled.type - schemas.BackupConfiguration.properties.backupRetentionSettings.$ref - schemas.BackupConfiguration.properties.backupRetentionSettings.description - schemas.BackupConfiguration.properties.pointInTimeRecoveryEnabled.description - schemas.BackupConfiguration.properties.pointInTimeRecoveryEnabled.type - schemas.BackupConfiguration.type - schemas.BackupRun.description - schemas.BackupRun.id - schemas.BackupRun.properties.endTime.description - schemas.BackupRun.properties.endTime.format - schemas.BackupRun.properties.endTime.type - schemas.BackupRun.properties.error.$ref - schemas.BackupRun.properties.error.description - schemas.BackupRun.properties.startTime.description - schemas.BackupRun.properties.startTime.format - schemas.BackupRun.properties.startTime.type - schemas.BackupRun.properties.status.description - schemas.BackupRun.properties.status.enum - schemas.BackupRun.properties.status.enumDescriptions - schemas.BackupRun.properties.status.type - schemas.BackupRun.type - schemas.Compliance.description - schemas.Compliance.id - schemas.Compliance.properties.standard.description - schemas.Compliance.properties.standard.type - schemas.Compliance.properties.version.description - schemas.Compliance.properties.version.type - schemas.Compliance.type - schemas.CustomMetadataData.description - schemas.CustomMetadataData.id - schemas.CustomMetadataData.properties.databaseMetadata.items.$ref - schemas.CustomMetadataData.properties.databaseMetadata.type - schemas.CustomMetadataData.type - schemas.DatabaseMetadata.description - schemas.DatabaseMetadata.id - schemas.DatabaseMetadata.properties.backupConfiguration.$ref - schemas.DatabaseMetadata.properties.backupConfiguration.description - schemas.DatabaseMetadata.properties.backupRun.$ref - schemas.DatabaseMetadata.properties.backupRun.description - schemas.DatabaseMetadata.properties.product.$ref - schemas.DatabaseMetadata.properties.resourceId.$ref - schemas.DatabaseMetadata.properties.resourceName.description - schemas.DatabaseMetadata.properties.resourceName.type - schemas.DatabaseMetadata.type - schemas.DatabaseResourceFeed.description - schemas.DatabaseResourceFeed.id - schemas.DatabaseResourceFeed.properties.feedTimestamp.description - schemas.DatabaseResourceFeed.properties.feedTimestamp.format - schemas.DatabaseResourceFeed.properties.feedTimestamp.type - schemas.DatabaseResourceFeed.properties.feedType.description - schemas.DatabaseResourceFeed.properties.feedType.enum - schemas.DatabaseResourceFeed.properties.feedType.enumDescriptions - schemas.DatabaseResourceFeed.properties.feedType.type - schemas.DatabaseResourceFeed.properties.recommendationSignalData.$ref - schemas.DatabaseResourceFeed.properties.recommendationSignalData.description - schemas.DatabaseResourceFeed.properties.resourceHealthSignalData.$ref - schemas.DatabaseResourceFeed.properties.resourceId.$ref - schemas.DatabaseResourceFeed.properties.resourceId.deprecated - schemas.DatabaseResourceFeed.properties.resourceId.description - schemas.DatabaseResourceFeed.properties.resourceMetadata.$ref - schemas.DatabaseResourceFeed.type - schemas.DatabaseResourceHealthSignalData.description - schemas.DatabaseResourceHealthSignalData.id - schemas.DatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.description - schemas.DatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.type - schemas.DatabaseResourceHealthSignalData.properties.additionalMetadata.description - schemas.DatabaseResourceHealthSignalData.properties.additionalMetadata.type - schemas.DatabaseResourceHealthSignalData.properties.compliance.description - schemas.DatabaseResourceHealthSignalData.properties.compliance.items.$ref - schemas.DatabaseResourceHealthSignalData.properties.compliance.type - schemas.DatabaseResourceHealthSignalData.properties.description.description - schemas.DatabaseResourceHealthSignalData.properties.description.type - schemas.DatabaseResourceHealthSignalData.properties.eventTime.description - schemas.DatabaseResourceHealthSignalData.properties.eventTime.format - schemas.DatabaseResourceHealthSignalData.properties.eventTime.type - schemas.DatabaseResourceHealthSignalData.properties.externalUri.description - schemas.DatabaseResourceHealthSignalData.properties.externalUri.type - schemas.DatabaseResourceHealthSignalData.properties.name.description - schemas.DatabaseResourceHealthSignalData.properties.name.type - schemas.DatabaseResourceHealthSignalData.properties.provider.description - schemas.DatabaseResourceHealthSignalData.properties.provider.enum - schemas.DatabaseResourceHealthSignalData.properties.provider.enumDescriptions - schemas.DatabaseResourceHealthSignalData.properties.provider.type - schemas.DatabaseResourceHealthSignalData.properties.resourceContainer.description - schemas.DatabaseResourceHealthSignalData.properties.resourceContainer.type - schemas.DatabaseResourceHealthSignalData.properties.resourceName.description - schemas.DatabaseResourceHealthSignalData.properties.resourceName.type - schemas.DatabaseResourceHealthSignalData.properties.signalClass.description - schemas.DatabaseResourceHealthSignalData.properties.signalClass.enum - schemas.DatabaseResourceHealthSignalData.properties.signalClass.enumDescriptions - schemas.DatabaseResourceHealthSignalData.properties.signalClass.type - schemas.DatabaseResourceHealthSignalData.properties.signalId.description - schemas.DatabaseResourceHealthSignalData.properties.signalId.type - schemas.DatabaseResourceHealthSignalData.properties.signalType.description - schemas.DatabaseResourceHealthSignalData.properties.signalType.enum - schemas.DatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.DatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.DatabaseResourceHealthSignalData.properties.signalType.type - schemas.DatabaseResourceHealthSignalData.properties.state.enum - schemas.DatabaseResourceHealthSignalData.properties.state.enumDescriptions - schemas.DatabaseResourceHealthSignalData.properties.state.type - schemas.DatabaseResourceHealthSignalData.type - schemas.DatabaseResourceId.description - schemas.DatabaseResourceId.id - schemas.DatabaseResourceId.properties.provider.description - schemas.DatabaseResourceId.properties.provider.enum - schemas.DatabaseResourceId.properties.provider.enumDescriptions - schemas.DatabaseResourceId.properties.provider.type - schemas.DatabaseResourceId.properties.providerDescription.description - schemas.DatabaseResourceId.properties.providerDescription.type - schemas.DatabaseResourceId.properties.resourceType.description - schemas.DatabaseResourceId.properties.resourceType.type - schemas.DatabaseResourceId.properties.uniqueId.description - schemas.DatabaseResourceId.properties.uniqueId.type - schemas.DatabaseResourceId.type - schemas.DatabaseResourceMetadata.description - schemas.DatabaseResourceMetadata.id - schemas.DatabaseResourceMetadata.properties.availabilityConfiguration.$ref - schemas.DatabaseResourceMetadata.properties.availabilityConfiguration.description - schemas.DatabaseResourceMetadata.properties.backupConfiguration.$ref - schemas.DatabaseResourceMetadata.properties.backupConfiguration.description - schemas.DatabaseResourceMetadata.properties.backupRun.$ref - schemas.DatabaseResourceMetadata.properties.backupRun.description - schemas.DatabaseResourceMetadata.properties.creationTime.description - schemas.DatabaseResourceMetadata.properties.creationTime.format - schemas.DatabaseResourceMetadata.properties.creationTime.type - schemas.DatabaseResourceMetadata.properties.currentState.description - schemas.DatabaseResourceMetadata.properties.currentState.enum - schemas.DatabaseResourceMetadata.properties.currentState.enumDescriptions - schemas.DatabaseResourceMetadata.properties.currentState.type - schemas.DatabaseResourceMetadata.properties.customMetadata.$ref - schemas.DatabaseResourceMetadata.properties.customMetadata.description - schemas.DatabaseResourceMetadata.properties.entitlements.description - schemas.DatabaseResourceMetadata.properties.entitlements.items.$ref - schemas.DatabaseResourceMetadata.properties.entitlements.type - schemas.DatabaseResourceMetadata.properties.expectedState.description - schemas.DatabaseResourceMetadata.properties.expectedState.enum - schemas.DatabaseResourceMetadata.properties.expectedState.enumDescriptions - schemas.DatabaseResourceMetadata.properties.expectedState.type - schemas.DatabaseResourceMetadata.properties.id.$ref - schemas.DatabaseResourceMetadata.properties.id.description - schemas.DatabaseResourceMetadata.properties.instanceType.description - schemas.DatabaseResourceMetadata.properties.instanceType.enum - schemas.DatabaseResourceMetadata.properties.instanceType.enumDeprecated - schemas.DatabaseResourceMetadata.properties.instanceType.enumDescriptions - schemas.DatabaseResourceMetadata.properties.instanceType.type - schemas.DatabaseResourceMetadata.properties.location.description - schemas.DatabaseResourceMetadata.properties.location.type - schemas.DatabaseResourceMetadata.properties.primaryResourceId.$ref - schemas.DatabaseResourceMetadata.properties.primaryResourceId.description - schemas.DatabaseResourceMetadata.properties.product.$ref - schemas.DatabaseResourceMetadata.properties.product.description - schemas.DatabaseResourceMetadata.properties.resourceContainer.description - schemas.DatabaseResourceMetadata.properties.resourceContainer.type - schemas.DatabaseResourceMetadata.properties.resourceName.description - schemas.DatabaseResourceMetadata.properties.resourceName.type - schemas.DatabaseResourceMetadata.properties.updationTime.description - schemas.DatabaseResourceMetadata.properties.updationTime.format - schemas.DatabaseResourceMetadata.properties.updationTime.type - schemas.DatabaseResourceMetadata.properties.userLabelSet.$ref - schemas.DatabaseResourceMetadata.properties.userLabelSet.description - schemas.DatabaseResourceMetadata.properties.userLabels.additionalProperties.type - schemas.DatabaseResourceMetadata.properties.userLabels.deprecated - schemas.DatabaseResourceMetadata.properties.userLabels.description - schemas.DatabaseResourceMetadata.properties.userLabels.type - schemas.DatabaseResourceMetadata.type - schemas.DatabaseResourceRecommendationSignalData.description - schemas.DatabaseResourceRecommendationSignalData.id - schemas.DatabaseResourceRecommendationSignalData.properties.additionalMetadata.additionalProperties.description - schemas.DatabaseResourceRecommendationSignalData.properties.additionalMetadata.additionalProperties.type - schemas.DatabaseResourceRecommendationSignalData.properties.additionalMetadata.description - schemas.DatabaseResourceRecommendationSignalData.properties.additionalMetadata.type - schemas.DatabaseResourceRecommendationSignalData.properties.lastRefreshTime.description - schemas.DatabaseResourceRecommendationSignalData.properties.lastRefreshTime.format - schemas.DatabaseResourceRecommendationSignalData.properties.lastRefreshTime.type - schemas.DatabaseResourceRecommendationSignalData.properties.recommendationState.description - schemas.DatabaseResourceRecommendationSignalData.properties.recommendationState.enum - schemas.DatabaseResourceRecommendationSignalData.properties.recommendationState.enumDescriptions - schemas.DatabaseResourceRecommendationSignalData.properties.recommendationState.type - schemas.DatabaseResourceRecommendationSignalData.properties.recommender.description - schemas.DatabaseResourceRecommendationSignalData.properties.recommender.type - schemas.DatabaseResourceRecommendationSignalData.properties.recommenderId.description - schemas.DatabaseResourceRecommendationSignalData.properties.recommenderId.type - schemas.DatabaseResourceRecommendationSignalData.properties.recommenderSubtype.description - schemas.DatabaseResourceRecommendationSignalData.properties.recommenderSubtype.type - schemas.DatabaseResourceRecommendationSignalData.properties.resourceName.description - schemas.DatabaseResourceRecommendationSignalData.properties.resourceName.type - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.description - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.type - schemas.DatabaseResourceRecommendationSignalData.type - schemas.Entitlement.description - schemas.Entitlement.id - schemas.Entitlement.properties.entitlementState.description - schemas.Entitlement.properties.entitlementState.enum - schemas.Entitlement.properties.entitlementState.enumDescriptions - schemas.Entitlement.properties.entitlementState.type - schemas.Entitlement.properties.type.description - schemas.Entitlement.properties.type.enum - schemas.Entitlement.properties.type.enumDeprecated - schemas.Entitlement.properties.type.enumDescriptions - schemas.Entitlement.properties.type.type - schemas.Entitlement.type - schemas.OperationError.description - schemas.OperationError.id - schemas.OperationError.properties.code.description - schemas.OperationError.properties.code.type - schemas.OperationError.properties.errorType.enum - schemas.OperationError.properties.errorType.enumDescriptions - schemas.OperationError.properties.errorType.type - schemas.OperationError.properties.message.description - schemas.OperationError.properties.message.type - schemas.OperationError.type - schemas.Product.description - schemas.Product.id - schemas.Product.properties.engine.description - schemas.Product.properties.engine.enum - schemas.Product.properties.engine.enumDeprecated - schemas.Product.properties.engine.enumDescriptions - schemas.Product.properties.engine.type - schemas.Product.properties.type.description - schemas.Product.properties.type.enum - schemas.Product.properties.type.enumDeprecated - schemas.Product.properties.type.enumDescriptions - schemas.Product.properties.type.type - schemas.Product.properties.version.description - schemas.Product.properties.version.type - schemas.Product.type - schemas.RetentionSettings.id - schemas.RetentionSettings.properties.quantityBasedRetention.format - schemas.RetentionSettings.properties.quantityBasedRetention.type - schemas.RetentionSettings.properties.retentionUnit.description - schemas.RetentionSettings.properties.retentionUnit.enum - schemas.RetentionSettings.properties.retentionUnit.enumDescriptions - schemas.RetentionSettings.properties.retentionUnit.type - schemas.RetentionSettings.properties.timeBasedRetention.format - schemas.RetentionSettings.properties.timeBasedRetention.type - schemas.RetentionSettings.type - schemas.UserLabels.description - schemas.UserLabels.id - schemas.UserLabels.properties.labels.additionalProperties.type - schemas.UserLabels.properties.labels.type - schemas.UserLabels.type --- discovery/redis-v1.json | 1190 +++++++++++++++++++++++++++++++++- discovery/redis-v1beta1.json | 1190 +++++++++++++++++++++++++++++++++- src/apis/redis/v1.ts | 357 ++++++++++ src/apis/redis/v1beta1.ts | 357 ++++++++++ 4 files changed, 3092 insertions(+), 2 deletions(-) diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index ed66e3ee412..7833c1ee469 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-v1.json @@ -821,9 +821,94 @@ } } }, - "revision": "20240220", + "revision": "20240307", "rootUrl": "https://redis.googleapis.com/", "schemas": { + "AvailabilityConfiguration": { + "description": "Configuration for availability of database instance", + "id": "AvailabilityConfiguration", + "properties": { + "availabilityType": { + "description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).", + "enum": [ + "AVAILABILITY_TYPE_UNSPECIFIED", + "ZONAL", + "REGIONAL", + "MULTI_REGIONAL", + "AVAILABILITY_TYPE_OTHER" + ], + "enumDescriptions": [ + "", + "Zonal available instance.", + "Regional available instance.", + "Multi regional instance", + "For rest of the other category" + ], + "type": "string" + }, + "externalReplicaConfigured": { + "type": "boolean" + }, + "promotableReplicaConfigured": { + "type": "boolean" + } + }, + "type": "object" + }, + "BackupConfiguration": { + "description": "Configuration for automatic backups", + "id": "BackupConfiguration", + "properties": { + "automatedBackupEnabled": { + "description": "Whether customer visible automated backups are enabled on the instance.", + "type": "boolean" + }, + "backupRetentionSettings": { + "$ref": "RetentionSettings", + "description": "Backup retention settings." + }, + "pointInTimeRecoveryEnabled": { + "description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", + "type": "boolean" + } + }, + "type": "object" + }, + "BackupRun": { + "description": "A backup run.", + "id": "BackupRun", + "properties": { + "endTime": { + "description": "The time the backup operation completed. REQUIRED", + "format": "google-datetime", + "type": "string" + }, + "error": { + "$ref": "OperationError", + "description": "Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL" + }, + "startTime": { + "description": "The time the backup operation started. REQUIRED", + "format": "google-datetime", + "type": "string" + }, + "status": { + "description": "The status of this run. REQUIRED", + "enum": [ + "STATUS_UNSPECIFIED", + "SUCCESSFUL", + "FAILED" + ], + "enumDescriptions": [ + "", + "The backup was successful.", + "The backup was unsuccessful." + ], + "type": "string" + } + }, + "type": "object" + }, "CertChain": { "id": "CertChain", "properties": { @@ -964,6 +1049,887 @@ }, "type": "object" }, + "Compliance": { + "description": "Contains compliance information about a security standard indicating unmet recommendations.", + "id": "Compliance", + "properties": { + "standard": { + "description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", + "type": "string" + }, + "version": { + "description": "Version of the standard or benchmark, for example, 1.1", + "type": "string" + } + }, + "type": "object" + }, + "CustomMetadataData": { + "description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", + "id": "CustomMetadataData", + "properties": { + "databaseMetadata": { + "items": { + "$ref": "DatabaseMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "DatabaseMetadata": { + "description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", + "id": "DatabaseMetadata", + "properties": { + "backupConfiguration": { + "$ref": "BackupConfiguration", + "description": "Backup configuration for this database" + }, + "backupRun": { + "$ref": "BackupRun", + "description": "Information about the last backup attempt for this database" + }, + "product": { + "$ref": "Product" + }, + "resourceId": { + "$ref": "DatabaseResourceId" + }, + "resourceName": { + "description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseResourceFeed": { + "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", + "id": "DatabaseResourceFeed", + "properties": { + "feedTimestamp": { + "description": "Required. Timestamp when feed is generated.", + "format": "google-datetime", + "type": "string" + }, + "feedType": { + "description": "Required. Type feed to be ingested into condor", + "enum": [ + "FEEDTYPE_UNSPECIFIED", + "RESOURCE_METADATA", + "OBSERVABILITY_DATA", + "SECURITY_FINDING_DATA", + "RECOMMENDATION_SIGNAL_DATA" + ], + "enumDescriptions": [ + "", + "Database resource metadata feed from control plane", + "Database resource monitoring data", + "Database resource security health signal data", + "Database resource recommendation signal data" + ], + "type": "string" + }, + "recommendationSignalData": { + "$ref": "DatabaseResourceRecommendationSignalData", + "description": "More feed data would be added in subsequent CLs" + }, + "resourceHealthSignalData": { + "$ref": "DatabaseResourceHealthSignalData" + }, + "resourceId": { + "$ref": "DatabaseResourceId", + "deprecated": true, + "description": "Primary key associated with the Resource. resource_id is available in individual feed level as well." + }, + "resourceMetadata": { + "$ref": "DatabaseResourceMetadata" + } + }, + "type": "object" + }, + "DatabaseResourceHealthSignalData": { + "description": "Common model for database resource health signal data.", + "id": "DatabaseResourceHealthSignalData", + "properties": { + "additionalMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Any other additional metadata", + "type": "object" + }, + "compliance": { + "description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", + "items": { + "$ref": "Compliance" + }, + "type": "array" + }, + "description": { + "description": "Description associated with signal", + "type": "string" + }, + "eventTime": { + "description": "Required. The last time at which the event described by this signal took place", + "format": "google-datetime", + "type": "string" + }, + "externalUri": { + "description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", + "type": "string" + }, + "name": { + "description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", + "type": "string" + }, + "provider": { + "description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", + "enum": [ + "PROVIDER_UNSPECIFIED", + "GCP", + "AWS", + "AZURE", + "ONPREM", + "SELFMANAGED", + "PROVIDER_OTHER" + ], + "enumDescriptions": [ + "", + "Google cloud platform provider", + "Amazon web service", + "Azure web service", + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." + ], + "type": "string" + }, + "resourceContainer": { + "description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"projects/123\". For GCP provided resources, number should be project number.", + "type": "string" + }, + "resourceName": { + "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "signalClass": { + "description": "Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.", + "enum": [ + "CLASS_UNSPECIFIED", + "THREAT", + "VULNERABILITY", + "MISCONFIGURATION", + "OBSERVATION", + "ERROR" + ], + "enumDescriptions": [ + "Unspecified signal class.", + "Describes unwanted or malicious activity.", + "Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", + "Describes a potential weakness in cloud resource/asset configuration that increases risk.", + "Describes a security observation that is for informational purposes.", + "Describes an error that prevents some SCC functionality." + ], + "type": "string" + }, + "signalId": { + "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", + "type": "string" + }, + "signalType": { + "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", + "SIGNAL_TYPE_GROUP_NOT_REPLICATING_ACROSS_REGIONS", + "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_ZONES", + "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_REGIONS", + "SIGNAL_TYPE_NO_PROMOTABLE_REPLICA", + "SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", + "SIGNAL_TYPE_SHORT_BACKUP_RETENTION", + "SIGNAL_TYPE_LAST_BACKUP_FAILED", + "SIGNAL_TYPE_LAST_BACKUP_OLD", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_2_0", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_3", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", + "SIGNAL_TYPE_VIOLATES_NIST_800_53", + "SIGNAL_TYPE_VIOLATES_ISO_27001", + "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", + "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", + "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", + "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", + "SIGNAL_TYPE_QUERY_LOCK_WAITS_NOT_LOGGED", + "SIGNAL_TYPE_LOGGING_MOST_ERRORS", + "SIGNAL_TYPE_LOGGING_ONLY_CRITICAL_ERRORS", + "SIGNAL_TYPE_MINIMAL_ERROR_LOGGING", + "SIGNAL_TYPE_QUERY_STATISTICS_LOGGED", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_CLIENT_HOSTNAME", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PARSER_STATISTICS", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PLANNER_STATISTICS", + "SIGNAL_TYPE_NOT_LOGGING_ONLY_DDL_STATEMENTS", + "SIGNAL_TYPE_LOGGING_QUERY_STATISTICS", + "SIGNAL_TYPE_NOT_LOGGING_TEMPORARY_FILES", + "SIGNAL_TYPE_CONNECTION_MAX_NOT_CONFIGURED", + "SIGNAL_TYPE_USER_OPTIONS_CONFIGURED", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_WEAK_ROOT_PASSWORD", + "SIGNAL_TYPE_ENCRYPTION_KEY_NOT_CUSTOMER_MANAGED", + "SIGNAL_TYPE_SERVER_AUTHENTICATION_NOT_REQUIRED", + "SIGNAL_TYPE_EXPOSED_BY_OWNERSHIP_CHAINING", + "SIGNAL_TYPE_EXPOSED_TO_EXTERNAL_SCRIPTS", + "SIGNAL_TYPE_EXPOSED_TO_LOCAL_DATA_LOADS", + "SIGNAL_TYPE_CONNECTION_ATTEMPTS_NOT_LOGGED", + "SIGNAL_TYPE_DISCONNECTIONS_NOT_LOGGED", + "SIGNAL_TYPE_LOGGING_EXCESSIVE_STATEMENT_INFO", + "SIGNAL_TYPE_EXPOSED_TO_REMOTE_ACCESS", + "SIGNAL_TYPE_DATABASE_NAMES_EXPOSED", + "SIGNAL_TYPE_SENSITIVE_TRACE_INFO_NOT_MASKED", + "SIGNAL_TYPE_PUBLIC_IP_ENABLED", + "SIGNAL_TYPE_IDLE", + "SIGNAL_TYPE_OVERPROVISIONED", + "SIGNAL_TYPE_HIGH_NUMBER_OF_OPEN_TABLES", + "SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES", + "SIGNAL_TYPE_HIGH_TRANSACTION_ID_UTILIZATION", + "SIGNAL_TYPE_UNDERPROVISIONED", + "SIGNAL_TYPE_OUT_OF_DISK", + "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_CLUSTER_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Unspecified.", + "Represents if a resource is protected by automatic failover. Checks for resources that are configured to have redundancy within a region that enables automatic failover.", + "Represents if a group is replicating across regions. Checks for resources that are configured to have redundancy, and ongoing replication, across regions.", + "Represents if the resource is available in multiple zones or not.", + "Represents if a resource is available in multiple regions.", + "Represents if a resource has a promotable replica.", + "Represents if a resource has an automated backup policy.", + "Represents if a resources has a short backup retention period.", + "Represents if the last backup of a resource failed.", + "Represents if the last backup of a resource is older than some threshold value.", + "Represents if a resource violates CIS GCP Foundation 2.0.", + "Represents if a resource violates CIS GCP Foundation 1.3.", + "Represents if a resource violates CIS GCP Foundation 1.2.", + "Represents if a resource violates CIS GCP Foundation 1.1.", + "Represents if a resource violates CIS GCP Foundation 1.0.", + "Represents if a resource violates NIST 800-53.", + "Represents if a resource violates ISO-27001.", + "Represents if a resource violates PCI-DSS v3.2.1.", + "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", + "Represents if the log_lock_waits database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance is not set appropriately.", + "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance does not have an appropriate severity level.", + "Represents if the log_min_messages database flag for a Cloud SQL for PostgreSQL instance is not set to warning or another recommended value.", + "Represents if the databaseFlags property of instance metadata for the log_executor_status field is set to on.", + "Represents if the log_hostname database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_parser_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_planner_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_statement database flag for a Cloud SQL for PostgreSQL instance is not set to DDL (all data definition statements).", + "Represents if the log_statement_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_temp_files database flag for a Cloud SQL for PostgreSQL instance is not set to \"0\". (NOTE: 0 = ON)", + "Represents if the user connections database flag for a Cloud SQL for SQL Server instance is configured.", + "Represents if the user options database flag for Cloud SQL SQL Server instance is configured or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a Cloud SQL database has a password configured for the root account or not.", + "Represents if a Cloud SQL database has a weak password configured for the root account.", + "Represents if a SQL database instance is not encrypted with customer-managed encryption keys (CMEK).", + "Represents if The contained database authentication database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the cross_db_ownership_chaining database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if he external scripts enabled database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the local_infile database flag for a Cloud SQL for MySQL instance is not set to off.", + "Represents if the log_connections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_disconnections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_min_duration_statement database flag for a Cloud SQL for PostgreSQL instance is not set to -1.", + "Represents if the remote access database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the skip_show_database database flag for a Cloud SQL for MySQL instance is not set to on.", + "Represents if the 3625 (trace flag) database flag for a Cloud SQL for SQL Server instance is not set to on.", + "Represents if public IP is enabled.", + "Represents Idle instance helps to reduce costs.", + "Represents instances that are unnecessarily large for given workload.", + "Represents high number of concurrently opened tables.", + "Represents high table count close to SLA limit.", + "Represents high number of unvacuumed transactions", + "Represents need for more CPU and/or memory", + "Represents out of disk.", + "Represents server certificate is near expiry.", + "Represents database auditing is disabled.", + "Represents not restricted to authorized networks.", + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" + ], + "type": "string" + }, + "state": { + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "RESOLVED", + "MUTED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The signal requires attention and has not been addressed yet.", + "The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", + "The signal has been muted." + ], + "type": "string" + } + }, + "type": "object" + }, + "DatabaseResourceId": { + "description": "DatabaseResourceId will serve as primary key for any resource ingestion event.", + "id": "DatabaseResourceId", + "properties": { + "provider": { + "description": "Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", + "enum": [ + "PROVIDER_UNSPECIFIED", + "GCP", + "AWS", + "AZURE", + "ONPREM", + "SELFMANAGED", + "PROVIDER_OTHER" + ], + "enumDescriptions": [ + "", + "Google cloud platform provider", + "Amazon web service", + "Azure web service", + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." + ], + "type": "string" + }, + "providerDescription": { + "description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", + "type": "string" + }, + "resourceType": { + "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", + "type": "string" + }, + "uniqueId": { + "description": "Required. A service-local token that distinguishes this resource from other resources within the same service.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseResourceMetadata": { + "description": "Common model for database resource instance metadata.", + "id": "DatabaseResourceMetadata", + "properties": { + "availabilityConfiguration": { + "$ref": "AvailabilityConfiguration", + "description": "Availability configuration for this instance" + }, + "backupConfiguration": { + "$ref": "BackupConfiguration", + "description": "Backup configuration for this instance" + }, + "backupRun": { + "$ref": "BackupRun", + "description": "Latest backup run information for this instance" + }, + "creationTime": { + "description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", + "format": "google-datetime", + "type": "string" + }, + "currentState": { + "description": "Current state of the instance.", + "enum": [ + "STATE_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY", + "SUSPENDED", + "DELETED", + "STATE_OTHER" + ], + "enumDescriptions": [ + "", + "The instance is running.", + "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", + "For rest of the other category" + ], + "type": "string" + }, + "customMetadata": { + "$ref": "CustomMetadataData", + "description": "Any custom metadata associated with the resource" + }, + "entitlements": { + "description": "Entitlements associated with the resource", + "items": { + "$ref": "Entitlement" + }, + "type": "array" + }, + "expectedState": { + "description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", + "enum": [ + "STATE_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY", + "SUSPENDED", + "DELETED", + "STATE_OTHER" + ], + "enumDescriptions": [ + "", + "The instance is running.", + "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", + "For rest of the other category" + ], + "type": "string" + }, + "id": { + "$ref": "DatabaseResourceId", + "description": "Required. Unique identifier for a Database resource" + }, + "instanceType": { + "description": "The type of the instance. Specified at creation time.", + "enum": [ + "INSTANCE_TYPE_UNSPECIFIED", + "SUB_RESOURCE_TYPE_UNSPECIFIED", + "PRIMARY", + "SECONDARY", + "READ_REPLICA", + "OTHER", + "SUB_RESOURCE_TYPE_PRIMARY", + "SUB_RESOURCE_TYPE_SECONDARY", + "SUB_RESOURCE_TYPE_READ_REPLICA", + "SUB_RESOURCE_TYPE_OTHER" + ], + "enumDeprecated": [ + true, + false, + true, + true, + true, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "", + "For rest of the other categories.", + "A regular primary database instance.", + "A cluster or an instance acting as a secondary.", + "An instance acting as a read-replica.", + "For rest of the other categories.", + "A regular primary database instance.", + "A cluster or an instance acting as a secondary.", + "An instance acting as a read-replica.", + "For rest of the other categories." + ], + "type": "string" + }, + "location": { + "description": "The resource location. REQUIRED", + "type": "string" + }, + "primaryResourceId": { + "$ref": "DatabaseResourceId", + "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." + }, + "product": { + "$ref": "Product", + "description": "The product this resource represents." + }, + "resourceContainer": { + "description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", + "type": "string" + }, + "resourceName": { + "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "updationTime": { + "description": "The time at which the resource was updated and recorded at partner service.", + "format": "google-datetime", + "type": "string" + }, + "userLabelSet": { + "$ref": "UserLabels", + "description": "User-provided labels associated with the resource" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "deprecated": true, + "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", + "type": "object" + } + }, + "type": "object" + }, + "DatabaseResourceRecommendationSignalData": { + "description": "Common model for database resource recommendation signal data.", + "id": "DatabaseResourceRecommendationSignalData", + "properties": { + "additionalMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any other additional metadata specific to recommendation", + "type": "object" + }, + "lastRefreshTime": { + "description": "Required. last time recommendationw as refreshed", + "format": "google-datetime", + "type": "string" + }, + "recommendationState": { + "description": "Required. Recommendation state", + "enum": [ + "UNSPECIFIED", + "ACTIVE", + "CLAIMED", + "SUCCEEDED", + "FAILED", + "DISMISSED" + ], + "enumDescriptions": [ + "", + "Recommendation is active and can be applied. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", + "Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", + "Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", + "Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.", + "Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." + ], + "type": "string" + }, + "recommender": { + "description": "Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876", + "type": "string" + }, + "recommenderId": { + "description": "Required. ID of recommender. Examples: \"google.cloudsql.instance.PerformanceRecommender\"", + "type": "string" + }, + "recommenderSubtype": { + "description": "Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.cloudsql.instance.PerformanceRecommender\", recommender_subtype can be \"MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE\"/\"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE\"", + "type": "string" + }, + "resourceName": { + "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "signalType": { + "description": "Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", + "SIGNAL_TYPE_GROUP_NOT_REPLICATING_ACROSS_REGIONS", + "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_ZONES", + "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_REGIONS", + "SIGNAL_TYPE_NO_PROMOTABLE_REPLICA", + "SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", + "SIGNAL_TYPE_SHORT_BACKUP_RETENTION", + "SIGNAL_TYPE_LAST_BACKUP_FAILED", + "SIGNAL_TYPE_LAST_BACKUP_OLD", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_2_0", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_3", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", + "SIGNAL_TYPE_VIOLATES_NIST_800_53", + "SIGNAL_TYPE_VIOLATES_ISO_27001", + "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", + "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", + "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", + "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", + "SIGNAL_TYPE_QUERY_LOCK_WAITS_NOT_LOGGED", + "SIGNAL_TYPE_LOGGING_MOST_ERRORS", + "SIGNAL_TYPE_LOGGING_ONLY_CRITICAL_ERRORS", + "SIGNAL_TYPE_MINIMAL_ERROR_LOGGING", + "SIGNAL_TYPE_QUERY_STATISTICS_LOGGED", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_CLIENT_HOSTNAME", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PARSER_STATISTICS", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PLANNER_STATISTICS", + "SIGNAL_TYPE_NOT_LOGGING_ONLY_DDL_STATEMENTS", + "SIGNAL_TYPE_LOGGING_QUERY_STATISTICS", + "SIGNAL_TYPE_NOT_LOGGING_TEMPORARY_FILES", + "SIGNAL_TYPE_CONNECTION_MAX_NOT_CONFIGURED", + "SIGNAL_TYPE_USER_OPTIONS_CONFIGURED", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_WEAK_ROOT_PASSWORD", + "SIGNAL_TYPE_ENCRYPTION_KEY_NOT_CUSTOMER_MANAGED", + "SIGNAL_TYPE_SERVER_AUTHENTICATION_NOT_REQUIRED", + "SIGNAL_TYPE_EXPOSED_BY_OWNERSHIP_CHAINING", + "SIGNAL_TYPE_EXPOSED_TO_EXTERNAL_SCRIPTS", + "SIGNAL_TYPE_EXPOSED_TO_LOCAL_DATA_LOADS", + "SIGNAL_TYPE_CONNECTION_ATTEMPTS_NOT_LOGGED", + "SIGNAL_TYPE_DISCONNECTIONS_NOT_LOGGED", + "SIGNAL_TYPE_LOGGING_EXCESSIVE_STATEMENT_INFO", + "SIGNAL_TYPE_EXPOSED_TO_REMOTE_ACCESS", + "SIGNAL_TYPE_DATABASE_NAMES_EXPOSED", + "SIGNAL_TYPE_SENSITIVE_TRACE_INFO_NOT_MASKED", + "SIGNAL_TYPE_PUBLIC_IP_ENABLED", + "SIGNAL_TYPE_IDLE", + "SIGNAL_TYPE_OVERPROVISIONED", + "SIGNAL_TYPE_HIGH_NUMBER_OF_OPEN_TABLES", + "SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES", + "SIGNAL_TYPE_HIGH_TRANSACTION_ID_UTILIZATION", + "SIGNAL_TYPE_UNDERPROVISIONED", + "SIGNAL_TYPE_OUT_OF_DISK", + "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_CLUSTER_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Unspecified.", + "Represents if a resource is protected by automatic failover. Checks for resources that are configured to have redundancy within a region that enables automatic failover.", + "Represents if a group is replicating across regions. Checks for resources that are configured to have redundancy, and ongoing replication, across regions.", + "Represents if the resource is available in multiple zones or not.", + "Represents if a resource is available in multiple regions.", + "Represents if a resource has a promotable replica.", + "Represents if a resource has an automated backup policy.", + "Represents if a resources has a short backup retention period.", + "Represents if the last backup of a resource failed.", + "Represents if the last backup of a resource is older than some threshold value.", + "Represents if a resource violates CIS GCP Foundation 2.0.", + "Represents if a resource violates CIS GCP Foundation 1.3.", + "Represents if a resource violates CIS GCP Foundation 1.2.", + "Represents if a resource violates CIS GCP Foundation 1.1.", + "Represents if a resource violates CIS GCP Foundation 1.0.", + "Represents if a resource violates NIST 800-53.", + "Represents if a resource violates ISO-27001.", + "Represents if a resource violates PCI-DSS v3.2.1.", + "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", + "Represents if the log_lock_waits database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance is not set appropriately.", + "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance does not have an appropriate severity level.", + "Represents if the log_min_messages database flag for a Cloud SQL for PostgreSQL instance is not set to warning or another recommended value.", + "Represents if the databaseFlags property of instance metadata for the log_executor_status field is set to on.", + "Represents if the log_hostname database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_parser_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_planner_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_statement database flag for a Cloud SQL for PostgreSQL instance is not set to DDL (all data definition statements).", + "Represents if the log_statement_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_temp_files database flag for a Cloud SQL for PostgreSQL instance is not set to \"0\". (NOTE: 0 = ON)", + "Represents if the user connections database flag for a Cloud SQL for SQL Server instance is configured.", + "Represents if the user options database flag for Cloud SQL SQL Server instance is configured or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a Cloud SQL database has a password configured for the root account or not.", + "Represents if a Cloud SQL database has a weak password configured for the root account.", + "Represents if a SQL database instance is not encrypted with customer-managed encryption keys (CMEK).", + "Represents if The contained database authentication database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the cross_db_ownership_chaining database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if he external scripts enabled database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the local_infile database flag for a Cloud SQL for MySQL instance is not set to off.", + "Represents if the log_connections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_disconnections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_min_duration_statement database flag for a Cloud SQL for PostgreSQL instance is not set to -1.", + "Represents if the remote access database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the skip_show_database database flag for a Cloud SQL for MySQL instance is not set to on.", + "Represents if the 3625 (trace flag) database flag for a Cloud SQL for SQL Server instance is not set to on.", + "Represents if public IP is enabled.", + "Represents Idle instance helps to reduce costs.", + "Represents instances that are unnecessarily large for given workload.", + "Represents high number of concurrently opened tables.", + "Represents high table count close to SLA limit.", + "Represents high number of unvacuumed transactions", + "Represents need for more CPU and/or memory", + "Represents out of disk.", + "Represents server certificate is near expiry.", + "Represents database auditing is disabled.", + "Represents not restricted to authorized networks.", + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" + ], + "type": "string" + } + }, + "type": "object" + }, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -993,6 +1959,46 @@ "properties": {}, "type": "object" }, + "Entitlement": { + "description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", + "id": "Entitlement", + "properties": { + "entitlementState": { + "description": "The current state of user's accessibility to a feature/benefit.", + "enum": [ + "ENTITLEMENT_STATE_UNSPECIFIED", + "ENTITLED", + "REVOKED" + ], + "enumDescriptions": [ + "", + "User is entitled to a feature/benefit, but whether it has been successfully provisioned is decided by provisioning state.", + "User is entitled to a feature/benefit, but it was requested to be revoked. Whether the revoke has been successful is decided by provisioning state." + ], + "type": "string" + }, + "type": { + "description": "An enum that represents the type of this entitlement.", + "enum": [ + "ENTITLEMENT_TYPE_UNSPECIFIED", + "DUET_AI", + "GEMINI" + ], + "enumDeprecated": [ + false, + true, + false + ], + "enumDescriptions": [ + "", + "The root entitlement representing Duet AI package ownership.", + "The root entitlement representing Gemini package ownership." + ], + "type": "string" + } + }, + "type": "object" + }, "ExportInstanceRequest": { "description": "Request for Export.", "id": "ExportInstanceRequest", @@ -1645,6 +2651,42 @@ }, "type": "object" }, + "OperationError": { + "description": "An error that occurred during a backup creation operation.", + "id": "OperationError", + "properties": { + "code": { + "description": "Identifies the specific error that occurred. REQUIRED", + "type": "string" + }, + "errorType": { + "enum": [ + "OPERATION_ERROR_TYPE_UNSPECIFIED", + "KMS_KEY_ERROR", + "DATABASE_ERROR", + "STOCKOUT_ERROR", + "CANCELLATION_ERROR", + "SQLSERVER_ERROR", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "UNSPECIFIED means product type is not known or available.", + "key destroyed, expired, not found, unreachable or permission denied.", + "Database is not accessible", + "The zone or region does not have sufficient resources to handle the request at the moment", + "User initiated cancellation", + "SQL server specific error", + "Any other internal error." + ], + "type": "string" + }, + "message": { + "description": "Additional information about the error encountered. REQUIRED", + "type": "string" + } + }, + "type": "object" + }, "OperationMetadata": { "description": "Pre-defined metadata fields.", "id": "OperationMetadata", @@ -1750,6 +2792,109 @@ }, "type": "object" }, + "Product": { + "description": "Product specification for Condor resources.", + "id": "Product", + "properties": { + "engine": { + "description": "The specific engine that the underlying database is running.", + "enum": [ + "ENGINE_UNSPECIFIED", + "ENGINE_MYSQL", + "MYSQL", + "ENGINE_POSTGRES", + "POSTGRES", + "ENGINE_SQL_SERVER", + "SQL_SERVER", + "ENGINE_NATIVE", + "NATIVE", + "ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT", + "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", + "ENGINE_MEMORYSTORE_FOR_REDIS", + "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", + "ENGINE_OTHER" + ], + "enumDeprecated": [ + false, + false, + true, + false, + true, + false, + true, + false, + true, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "UNSPECIFIED means engine type is not known or available.", + "MySQL binary running as an engine in the database instance.", + "MySQL binary running as engine in database instance.", + "Postgres binary running as engine in database instance.", + "Postgres binary running as engine in database instance.", + "SQLServer binary running as engine in database instance.", + "SQLServer binary running as engine in database instance.", + "Native database binary running as engine in instance.", + "Native database binary running as engine in instance.", + "Cloud Spanner with PostgreSQL dialect.", + "Cloud Spanner with Google SQL dialect.", + "Memorystore with Redis dialect.", + "Memorystore with Redis cluster dialect.", + "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." + ], + "type": "string" + }, + "type": { + "description": "Type of specific database product. It could be CloudSQL, AlloyDB etc..", + "enum": [ + "PRODUCT_TYPE_UNSPECIFIED", + "PRODUCT_TYPE_CLOUD_SQL", + "CLOUD_SQL", + "PRODUCT_TYPE_ALLOYDB", + "ALLOYDB", + "PRODUCT_TYPE_SPANNER", + "PRODUCT_TYPE_ON_PREM", + "ON_PREM", + "PRODUCT_TYPE_MEMORYSTORE", + "PRODUCT_TYPE_OTHER" + ], + "enumDeprecated": [ + false, + false, + true, + false, + true, + false, + false, + true, + false, + false + ], + "enumDescriptions": [ + "UNSPECIFIED means product type is not known or available.", + "Cloud SQL product area in GCP", + "Cloud SQL product area in GCP", + "AlloyDB product area in GCP", + "AlloyDB product area in GCP", + "Spanner product area in GCP", + "On premises database product.", + "On premises database product.", + "Memorystore product area in GCP", + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." + ], + "type": "string" + }, + "version": { + "description": "Version of the underlying database engine. Example values: For MySQL, it could be \"8.0\", \"5.7\" etc.. For Postgres, it could be \"14\", \"15\" etc..", + "type": "string" + } + }, + "type": "object" + }, "PscConfig": { "id": "PscConfig", "properties": { @@ -1850,6 +2995,36 @@ }, "type": "object" }, + "RetentionSettings": { + "id": "RetentionSettings", + "properties": { + "quantityBasedRetention": { + "format": "int32", + "type": "integer" + }, + "retentionUnit": { + "description": "The unit that 'retained_backups' represents.", + "enum": [ + "RETENTION_UNIT_UNSPECIFIED", + "COUNT", + "TIME", + "RETENTION_UNIT_OTHER" + ], + "enumDescriptions": [ + "Backup retention unit is unspecified, will be treated as COUNT.", + "Retention will be by count, eg. \"retain the most recent 7 backups\".", + "Retention will be by Time, eg. \"retain the last 7 days backups\".", + "For rest of the other category" + ], + "type": "string" + }, + "timeBasedRetention": { + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "StateInfo": { "description": "Represents additional information about the state of the cluster.", "id": "StateInfo", @@ -1974,6 +3149,19 @@ }, "type": "object" }, + "UserLabels": { + "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", + "id": "UserLabels", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, "WeeklyMaintenanceWindow": { "description": "Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.", "id": "WeeklyMaintenanceWindow", diff --git a/discovery/redis-v1beta1.json b/discovery/redis-v1beta1.json index 5185e8ee4bd..64b07798b11 100644 --- a/discovery/redis-v1beta1.json +++ b/discovery/redis-v1beta1.json @@ -821,9 +821,94 @@ } } }, - "revision": "20240220", + "revision": "20240307", "rootUrl": "https://redis.googleapis.com/", "schemas": { + "AvailabilityConfiguration": { + "description": "Configuration for availability of database instance", + "id": "AvailabilityConfiguration", + "properties": { + "availabilityType": { + "description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).", + "enum": [ + "AVAILABILITY_TYPE_UNSPECIFIED", + "ZONAL", + "REGIONAL", + "MULTI_REGIONAL", + "AVAILABILITY_TYPE_OTHER" + ], + "enumDescriptions": [ + "", + "Zonal available instance.", + "Regional available instance.", + "Multi regional instance", + "For rest of the other category" + ], + "type": "string" + }, + "externalReplicaConfigured": { + "type": "boolean" + }, + "promotableReplicaConfigured": { + "type": "boolean" + } + }, + "type": "object" + }, + "BackupConfiguration": { + "description": "Configuration for automatic backups", + "id": "BackupConfiguration", + "properties": { + "automatedBackupEnabled": { + "description": "Whether customer visible automated backups are enabled on the instance.", + "type": "boolean" + }, + "backupRetentionSettings": { + "$ref": "RetentionSettings", + "description": "Backup retention settings." + }, + "pointInTimeRecoveryEnabled": { + "description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", + "type": "boolean" + } + }, + "type": "object" + }, + "BackupRun": { + "description": "A backup run.", + "id": "BackupRun", + "properties": { + "endTime": { + "description": "The time the backup operation completed. REQUIRED", + "format": "google-datetime", + "type": "string" + }, + "error": { + "$ref": "OperationError", + "description": "Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL" + }, + "startTime": { + "description": "The time the backup operation started. REQUIRED", + "format": "google-datetime", + "type": "string" + }, + "status": { + "description": "The status of this run. REQUIRED", + "enum": [ + "STATUS_UNSPECIFIED", + "SUCCESSFUL", + "FAILED" + ], + "enumDescriptions": [ + "", + "The backup was successful.", + "The backup was unsuccessful." + ], + "type": "string" + } + }, + "type": "object" + }, "CertChain": { "id": "CertChain", "properties": { @@ -964,6 +1049,887 @@ }, "type": "object" }, + "Compliance": { + "description": "Contains compliance information about a security standard indicating unmet recommendations.", + "id": "Compliance", + "properties": { + "standard": { + "description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", + "type": "string" + }, + "version": { + "description": "Version of the standard or benchmark, for example, 1.1", + "type": "string" + } + }, + "type": "object" + }, + "CustomMetadataData": { + "description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", + "id": "CustomMetadataData", + "properties": { + "databaseMetadata": { + "items": { + "$ref": "DatabaseMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "DatabaseMetadata": { + "description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", + "id": "DatabaseMetadata", + "properties": { + "backupConfiguration": { + "$ref": "BackupConfiguration", + "description": "Backup configuration for this database" + }, + "backupRun": { + "$ref": "BackupRun", + "description": "Information about the last backup attempt for this database" + }, + "product": { + "$ref": "Product" + }, + "resourceId": { + "$ref": "DatabaseResourceId" + }, + "resourceName": { + "description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseResourceFeed": { + "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", + "id": "DatabaseResourceFeed", + "properties": { + "feedTimestamp": { + "description": "Required. Timestamp when feed is generated.", + "format": "google-datetime", + "type": "string" + }, + "feedType": { + "description": "Required. Type feed to be ingested into condor", + "enum": [ + "FEEDTYPE_UNSPECIFIED", + "RESOURCE_METADATA", + "OBSERVABILITY_DATA", + "SECURITY_FINDING_DATA", + "RECOMMENDATION_SIGNAL_DATA" + ], + "enumDescriptions": [ + "", + "Database resource metadata feed from control plane", + "Database resource monitoring data", + "Database resource security health signal data", + "Database resource recommendation signal data" + ], + "type": "string" + }, + "recommendationSignalData": { + "$ref": "DatabaseResourceRecommendationSignalData", + "description": "More feed data would be added in subsequent CLs" + }, + "resourceHealthSignalData": { + "$ref": "DatabaseResourceHealthSignalData" + }, + "resourceId": { + "$ref": "DatabaseResourceId", + "deprecated": true, + "description": "Primary key associated with the Resource. resource_id is available in individual feed level as well." + }, + "resourceMetadata": { + "$ref": "DatabaseResourceMetadata" + } + }, + "type": "object" + }, + "DatabaseResourceHealthSignalData": { + "description": "Common model for database resource health signal data.", + "id": "DatabaseResourceHealthSignalData", + "properties": { + "additionalMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Any other additional metadata", + "type": "object" + }, + "compliance": { + "description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", + "items": { + "$ref": "Compliance" + }, + "type": "array" + }, + "description": { + "description": "Description associated with signal", + "type": "string" + }, + "eventTime": { + "description": "Required. The last time at which the event described by this signal took place", + "format": "google-datetime", + "type": "string" + }, + "externalUri": { + "description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", + "type": "string" + }, + "name": { + "description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", + "type": "string" + }, + "provider": { + "description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", + "enum": [ + "PROVIDER_UNSPECIFIED", + "GCP", + "AWS", + "AZURE", + "ONPREM", + "SELFMANAGED", + "PROVIDER_OTHER" + ], + "enumDescriptions": [ + "", + "Google cloud platform provider", + "Amazon web service", + "Azure web service", + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." + ], + "type": "string" + }, + "resourceContainer": { + "description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"projects/123\". For GCP provided resources, number should be project number.", + "type": "string" + }, + "resourceName": { + "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "signalClass": { + "description": "Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.", + "enum": [ + "CLASS_UNSPECIFIED", + "THREAT", + "VULNERABILITY", + "MISCONFIGURATION", + "OBSERVATION", + "ERROR" + ], + "enumDescriptions": [ + "Unspecified signal class.", + "Describes unwanted or malicious activity.", + "Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", + "Describes a potential weakness in cloud resource/asset configuration that increases risk.", + "Describes a security observation that is for informational purposes.", + "Describes an error that prevents some SCC functionality." + ], + "type": "string" + }, + "signalId": { + "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", + "type": "string" + }, + "signalType": { + "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", + "SIGNAL_TYPE_GROUP_NOT_REPLICATING_ACROSS_REGIONS", + "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_ZONES", + "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_REGIONS", + "SIGNAL_TYPE_NO_PROMOTABLE_REPLICA", + "SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", + "SIGNAL_TYPE_SHORT_BACKUP_RETENTION", + "SIGNAL_TYPE_LAST_BACKUP_FAILED", + "SIGNAL_TYPE_LAST_BACKUP_OLD", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_2_0", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_3", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", + "SIGNAL_TYPE_VIOLATES_NIST_800_53", + "SIGNAL_TYPE_VIOLATES_ISO_27001", + "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", + "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", + "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", + "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", + "SIGNAL_TYPE_QUERY_LOCK_WAITS_NOT_LOGGED", + "SIGNAL_TYPE_LOGGING_MOST_ERRORS", + "SIGNAL_TYPE_LOGGING_ONLY_CRITICAL_ERRORS", + "SIGNAL_TYPE_MINIMAL_ERROR_LOGGING", + "SIGNAL_TYPE_QUERY_STATISTICS_LOGGED", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_CLIENT_HOSTNAME", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PARSER_STATISTICS", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PLANNER_STATISTICS", + "SIGNAL_TYPE_NOT_LOGGING_ONLY_DDL_STATEMENTS", + "SIGNAL_TYPE_LOGGING_QUERY_STATISTICS", + "SIGNAL_TYPE_NOT_LOGGING_TEMPORARY_FILES", + "SIGNAL_TYPE_CONNECTION_MAX_NOT_CONFIGURED", + "SIGNAL_TYPE_USER_OPTIONS_CONFIGURED", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_WEAK_ROOT_PASSWORD", + "SIGNAL_TYPE_ENCRYPTION_KEY_NOT_CUSTOMER_MANAGED", + "SIGNAL_TYPE_SERVER_AUTHENTICATION_NOT_REQUIRED", + "SIGNAL_TYPE_EXPOSED_BY_OWNERSHIP_CHAINING", + "SIGNAL_TYPE_EXPOSED_TO_EXTERNAL_SCRIPTS", + "SIGNAL_TYPE_EXPOSED_TO_LOCAL_DATA_LOADS", + "SIGNAL_TYPE_CONNECTION_ATTEMPTS_NOT_LOGGED", + "SIGNAL_TYPE_DISCONNECTIONS_NOT_LOGGED", + "SIGNAL_TYPE_LOGGING_EXCESSIVE_STATEMENT_INFO", + "SIGNAL_TYPE_EXPOSED_TO_REMOTE_ACCESS", + "SIGNAL_TYPE_DATABASE_NAMES_EXPOSED", + "SIGNAL_TYPE_SENSITIVE_TRACE_INFO_NOT_MASKED", + "SIGNAL_TYPE_PUBLIC_IP_ENABLED", + "SIGNAL_TYPE_IDLE", + "SIGNAL_TYPE_OVERPROVISIONED", + "SIGNAL_TYPE_HIGH_NUMBER_OF_OPEN_TABLES", + "SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES", + "SIGNAL_TYPE_HIGH_TRANSACTION_ID_UTILIZATION", + "SIGNAL_TYPE_UNDERPROVISIONED", + "SIGNAL_TYPE_OUT_OF_DISK", + "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_CLUSTER_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Unspecified.", + "Represents if a resource is protected by automatic failover. Checks for resources that are configured to have redundancy within a region that enables automatic failover.", + "Represents if a group is replicating across regions. Checks for resources that are configured to have redundancy, and ongoing replication, across regions.", + "Represents if the resource is available in multiple zones or not.", + "Represents if a resource is available in multiple regions.", + "Represents if a resource has a promotable replica.", + "Represents if a resource has an automated backup policy.", + "Represents if a resources has a short backup retention period.", + "Represents if the last backup of a resource failed.", + "Represents if the last backup of a resource is older than some threshold value.", + "Represents if a resource violates CIS GCP Foundation 2.0.", + "Represents if a resource violates CIS GCP Foundation 1.3.", + "Represents if a resource violates CIS GCP Foundation 1.2.", + "Represents if a resource violates CIS GCP Foundation 1.1.", + "Represents if a resource violates CIS GCP Foundation 1.0.", + "Represents if a resource violates NIST 800-53.", + "Represents if a resource violates ISO-27001.", + "Represents if a resource violates PCI-DSS v3.2.1.", + "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", + "Represents if the log_lock_waits database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance is not set appropriately.", + "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance does not have an appropriate severity level.", + "Represents if the log_min_messages database flag for a Cloud SQL for PostgreSQL instance is not set to warning or another recommended value.", + "Represents if the databaseFlags property of instance metadata for the log_executor_status field is set to on.", + "Represents if the log_hostname database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_parser_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_planner_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_statement database flag for a Cloud SQL for PostgreSQL instance is not set to DDL (all data definition statements).", + "Represents if the log_statement_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_temp_files database flag for a Cloud SQL for PostgreSQL instance is not set to \"0\". (NOTE: 0 = ON)", + "Represents if the user connections database flag for a Cloud SQL for SQL Server instance is configured.", + "Represents if the user options database flag for Cloud SQL SQL Server instance is configured or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a Cloud SQL database has a password configured for the root account or not.", + "Represents if a Cloud SQL database has a weak password configured for the root account.", + "Represents if a SQL database instance is not encrypted with customer-managed encryption keys (CMEK).", + "Represents if The contained database authentication database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the cross_db_ownership_chaining database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if he external scripts enabled database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the local_infile database flag for a Cloud SQL for MySQL instance is not set to off.", + "Represents if the log_connections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_disconnections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_min_duration_statement database flag for a Cloud SQL for PostgreSQL instance is not set to -1.", + "Represents if the remote access database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the skip_show_database database flag for a Cloud SQL for MySQL instance is not set to on.", + "Represents if the 3625 (trace flag) database flag for a Cloud SQL for SQL Server instance is not set to on.", + "Represents if public IP is enabled.", + "Represents Idle instance helps to reduce costs.", + "Represents instances that are unnecessarily large for given workload.", + "Represents high number of concurrently opened tables.", + "Represents high table count close to SLA limit.", + "Represents high number of unvacuumed transactions", + "Represents need for more CPU and/or memory", + "Represents out of disk.", + "Represents server certificate is near expiry.", + "Represents database auditing is disabled.", + "Represents not restricted to authorized networks.", + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" + ], + "type": "string" + }, + "state": { + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "RESOLVED", + "MUTED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The signal requires attention and has not been addressed yet.", + "The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", + "The signal has been muted." + ], + "type": "string" + } + }, + "type": "object" + }, + "DatabaseResourceId": { + "description": "DatabaseResourceId will serve as primary key for any resource ingestion event.", + "id": "DatabaseResourceId", + "properties": { + "provider": { + "description": "Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", + "enum": [ + "PROVIDER_UNSPECIFIED", + "GCP", + "AWS", + "AZURE", + "ONPREM", + "SELFMANAGED", + "PROVIDER_OTHER" + ], + "enumDescriptions": [ + "", + "Google cloud platform provider", + "Amazon web service", + "Azure web service", + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." + ], + "type": "string" + }, + "providerDescription": { + "description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", + "type": "string" + }, + "resourceType": { + "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", + "type": "string" + }, + "uniqueId": { + "description": "Required. A service-local token that distinguishes this resource from other resources within the same service.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseResourceMetadata": { + "description": "Common model for database resource instance metadata.", + "id": "DatabaseResourceMetadata", + "properties": { + "availabilityConfiguration": { + "$ref": "AvailabilityConfiguration", + "description": "Availability configuration for this instance" + }, + "backupConfiguration": { + "$ref": "BackupConfiguration", + "description": "Backup configuration for this instance" + }, + "backupRun": { + "$ref": "BackupRun", + "description": "Latest backup run information for this instance" + }, + "creationTime": { + "description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", + "format": "google-datetime", + "type": "string" + }, + "currentState": { + "description": "Current state of the instance.", + "enum": [ + "STATE_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY", + "SUSPENDED", + "DELETED", + "STATE_OTHER" + ], + "enumDescriptions": [ + "", + "The instance is running.", + "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", + "For rest of the other category" + ], + "type": "string" + }, + "customMetadata": { + "$ref": "CustomMetadataData", + "description": "Any custom metadata associated with the resource" + }, + "entitlements": { + "description": "Entitlements associated with the resource", + "items": { + "$ref": "Entitlement" + }, + "type": "array" + }, + "expectedState": { + "description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", + "enum": [ + "STATE_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY", + "SUSPENDED", + "DELETED", + "STATE_OTHER" + ], + "enumDescriptions": [ + "", + "The instance is running.", + "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", + "For rest of the other category" + ], + "type": "string" + }, + "id": { + "$ref": "DatabaseResourceId", + "description": "Required. Unique identifier for a Database resource" + }, + "instanceType": { + "description": "The type of the instance. Specified at creation time.", + "enum": [ + "INSTANCE_TYPE_UNSPECIFIED", + "SUB_RESOURCE_TYPE_UNSPECIFIED", + "PRIMARY", + "SECONDARY", + "READ_REPLICA", + "OTHER", + "SUB_RESOURCE_TYPE_PRIMARY", + "SUB_RESOURCE_TYPE_SECONDARY", + "SUB_RESOURCE_TYPE_READ_REPLICA", + "SUB_RESOURCE_TYPE_OTHER" + ], + "enumDeprecated": [ + true, + false, + true, + true, + true, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "", + "For rest of the other categories.", + "A regular primary database instance.", + "A cluster or an instance acting as a secondary.", + "An instance acting as a read-replica.", + "For rest of the other categories.", + "A regular primary database instance.", + "A cluster or an instance acting as a secondary.", + "An instance acting as a read-replica.", + "For rest of the other categories." + ], + "type": "string" + }, + "location": { + "description": "The resource location. REQUIRED", + "type": "string" + }, + "primaryResourceId": { + "$ref": "DatabaseResourceId", + "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." + }, + "product": { + "$ref": "Product", + "description": "The product this resource represents." + }, + "resourceContainer": { + "description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", + "type": "string" + }, + "resourceName": { + "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "updationTime": { + "description": "The time at which the resource was updated and recorded at partner service.", + "format": "google-datetime", + "type": "string" + }, + "userLabelSet": { + "$ref": "UserLabels", + "description": "User-provided labels associated with the resource" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "deprecated": true, + "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", + "type": "object" + } + }, + "type": "object" + }, + "DatabaseResourceRecommendationSignalData": { + "description": "Common model for database resource recommendation signal data.", + "id": "DatabaseResourceRecommendationSignalData", + "properties": { + "additionalMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any other additional metadata specific to recommendation", + "type": "object" + }, + "lastRefreshTime": { + "description": "Required. last time recommendationw as refreshed", + "format": "google-datetime", + "type": "string" + }, + "recommendationState": { + "description": "Required. Recommendation state", + "enum": [ + "UNSPECIFIED", + "ACTIVE", + "CLAIMED", + "SUCCEEDED", + "FAILED", + "DISMISSED" + ], + "enumDescriptions": [ + "", + "Recommendation is active and can be applied. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", + "Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", + "Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", + "Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.", + "Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." + ], + "type": "string" + }, + "recommender": { + "description": "Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876", + "type": "string" + }, + "recommenderId": { + "description": "Required. ID of recommender. Examples: \"google.cloudsql.instance.PerformanceRecommender\"", + "type": "string" + }, + "recommenderSubtype": { + "description": "Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.cloudsql.instance.PerformanceRecommender\", recommender_subtype can be \"MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE\"/\"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE\"", + "type": "string" + }, + "resourceName": { + "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "signalType": { + "description": "Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.", + "enum": [ + "SIGNAL_TYPE_UNSPECIFIED", + "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", + "SIGNAL_TYPE_GROUP_NOT_REPLICATING_ACROSS_REGIONS", + "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_ZONES", + "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_REGIONS", + "SIGNAL_TYPE_NO_PROMOTABLE_REPLICA", + "SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", + "SIGNAL_TYPE_SHORT_BACKUP_RETENTION", + "SIGNAL_TYPE_LAST_BACKUP_FAILED", + "SIGNAL_TYPE_LAST_BACKUP_OLD", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_2_0", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_3", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", + "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", + "SIGNAL_TYPE_VIOLATES_NIST_800_53", + "SIGNAL_TYPE_VIOLATES_ISO_27001", + "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", + "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", + "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", + "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", + "SIGNAL_TYPE_QUERY_LOCK_WAITS_NOT_LOGGED", + "SIGNAL_TYPE_LOGGING_MOST_ERRORS", + "SIGNAL_TYPE_LOGGING_ONLY_CRITICAL_ERRORS", + "SIGNAL_TYPE_MINIMAL_ERROR_LOGGING", + "SIGNAL_TYPE_QUERY_STATISTICS_LOGGED", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_CLIENT_HOSTNAME", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PARSER_STATISTICS", + "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PLANNER_STATISTICS", + "SIGNAL_TYPE_NOT_LOGGING_ONLY_DDL_STATEMENTS", + "SIGNAL_TYPE_LOGGING_QUERY_STATISTICS", + "SIGNAL_TYPE_NOT_LOGGING_TEMPORARY_FILES", + "SIGNAL_TYPE_CONNECTION_MAX_NOT_CONFIGURED", + "SIGNAL_TYPE_USER_OPTIONS_CONFIGURED", + "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_NO_ROOT_PASSWORD", + "SIGNAL_TYPE_WEAK_ROOT_PASSWORD", + "SIGNAL_TYPE_ENCRYPTION_KEY_NOT_CUSTOMER_MANAGED", + "SIGNAL_TYPE_SERVER_AUTHENTICATION_NOT_REQUIRED", + "SIGNAL_TYPE_EXPOSED_BY_OWNERSHIP_CHAINING", + "SIGNAL_TYPE_EXPOSED_TO_EXTERNAL_SCRIPTS", + "SIGNAL_TYPE_EXPOSED_TO_LOCAL_DATA_LOADS", + "SIGNAL_TYPE_CONNECTION_ATTEMPTS_NOT_LOGGED", + "SIGNAL_TYPE_DISCONNECTIONS_NOT_LOGGED", + "SIGNAL_TYPE_LOGGING_EXCESSIVE_STATEMENT_INFO", + "SIGNAL_TYPE_EXPOSED_TO_REMOTE_ACCESS", + "SIGNAL_TYPE_DATABASE_NAMES_EXPOSED", + "SIGNAL_TYPE_SENSITIVE_TRACE_INFO_NOT_MASKED", + "SIGNAL_TYPE_PUBLIC_IP_ENABLED", + "SIGNAL_TYPE_IDLE", + "SIGNAL_TYPE_OVERPROVISIONED", + "SIGNAL_TYPE_HIGH_NUMBER_OF_OPEN_TABLES", + "SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES", + "SIGNAL_TYPE_HIGH_TRANSACTION_ID_UTILIZATION", + "SIGNAL_TYPE_UNDERPROVISIONED", + "SIGNAL_TYPE_OUT_OF_DISK", + "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", + "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", + "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_CLUSTER_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Unspecified.", + "Represents if a resource is protected by automatic failover. Checks for resources that are configured to have redundancy within a region that enables automatic failover.", + "Represents if a group is replicating across regions. Checks for resources that are configured to have redundancy, and ongoing replication, across regions.", + "Represents if the resource is available in multiple zones or not.", + "Represents if a resource is available in multiple regions.", + "Represents if a resource has a promotable replica.", + "Represents if a resource has an automated backup policy.", + "Represents if a resources has a short backup retention period.", + "Represents if the last backup of a resource failed.", + "Represents if the last backup of a resource is older than some threshold value.", + "Represents if a resource violates CIS GCP Foundation 2.0.", + "Represents if a resource violates CIS GCP Foundation 1.3.", + "Represents if a resource violates CIS GCP Foundation 1.2.", + "Represents if a resource violates CIS GCP Foundation 1.1.", + "Represents if a resource violates CIS GCP Foundation 1.0.", + "Represents if a resource violates NIST 800-53.", + "Represents if a resource violates ISO-27001.", + "Represents if a resource violates PCI-DSS v3.2.1.", + "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", + "Represents if the log_lock_waits database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance is not set appropriately.", + "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance does not have an appropriate severity level.", + "Represents if the log_min_messages database flag for a Cloud SQL for PostgreSQL instance is not set to warning or another recommended value.", + "Represents if the databaseFlags property of instance metadata for the log_executor_status field is set to on.", + "Represents if the log_hostname database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_parser_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_planner_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_statement database flag for a Cloud SQL for PostgreSQL instance is not set to DDL (all data definition statements).", + "Represents if the log_statement_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", + "Represents if the log_temp_files database flag for a Cloud SQL for PostgreSQL instance is not set to \"0\". (NOTE: 0 = ON)", + "Represents if the user connections database flag for a Cloud SQL for SQL Server instance is configured.", + "Represents if the user options database flag for Cloud SQL SQL Server instance is configured or not.", + "Represents if a resource is exposed to public access.", + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a Cloud SQL database has a password configured for the root account or not.", + "Represents if a Cloud SQL database has a weak password configured for the root account.", + "Represents if a SQL database instance is not encrypted with customer-managed encryption keys (CMEK).", + "Represents if The contained database authentication database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the cross_db_ownership_chaining database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if he external scripts enabled database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the local_infile database flag for a Cloud SQL for MySQL instance is not set to off.", + "Represents if the log_connections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_disconnections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", + "Represents if the log_min_duration_statement database flag for a Cloud SQL for PostgreSQL instance is not set to -1.", + "Represents if the remote access database flag for a Cloud SQL for SQL Server instance is not set to off.", + "Represents if the skip_show_database database flag for a Cloud SQL for MySQL instance is not set to on.", + "Represents if the 3625 (trace flag) database flag for a Cloud SQL for SQL Server instance is not set to on.", + "Represents if public IP is enabled.", + "Represents Idle instance helps to reduce costs.", + "Represents instances that are unnecessarily large for given workload.", + "Represents high number of concurrently opened tables.", + "Represents high table count close to SLA limit.", + "Represents high number of unvacuumed transactions", + "Represents need for more CPU and/or memory", + "Represents out of disk.", + "Represents server certificate is near expiry.", + "Represents database auditing is disabled.", + "Represents not restricted to authorized networks.", + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" + ], + "type": "string" + } + }, + "type": "object" + }, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -993,6 +1959,46 @@ "properties": {}, "type": "object" }, + "Entitlement": { + "description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", + "id": "Entitlement", + "properties": { + "entitlementState": { + "description": "The current state of user's accessibility to a feature/benefit.", + "enum": [ + "ENTITLEMENT_STATE_UNSPECIFIED", + "ENTITLED", + "REVOKED" + ], + "enumDescriptions": [ + "", + "User is entitled to a feature/benefit, but whether it has been successfully provisioned is decided by provisioning state.", + "User is entitled to a feature/benefit, but it was requested to be revoked. Whether the revoke has been successful is decided by provisioning state." + ], + "type": "string" + }, + "type": { + "description": "An enum that represents the type of this entitlement.", + "enum": [ + "ENTITLEMENT_TYPE_UNSPECIFIED", + "DUET_AI", + "GEMINI" + ], + "enumDeprecated": [ + false, + true, + false + ], + "enumDescriptions": [ + "", + "The root entitlement representing Duet AI package ownership.", + "The root entitlement representing Gemini package ownership." + ], + "type": "string" + } + }, + "type": "object" + }, "ExportInstanceRequest": { "description": "Request for Export.", "id": "ExportInstanceRequest", @@ -1652,6 +2658,42 @@ }, "type": "object" }, + "OperationError": { + "description": "An error that occurred during a backup creation operation.", + "id": "OperationError", + "properties": { + "code": { + "description": "Identifies the specific error that occurred. REQUIRED", + "type": "string" + }, + "errorType": { + "enum": [ + "OPERATION_ERROR_TYPE_UNSPECIFIED", + "KMS_KEY_ERROR", + "DATABASE_ERROR", + "STOCKOUT_ERROR", + "CANCELLATION_ERROR", + "SQLSERVER_ERROR", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "UNSPECIFIED means product type is not known or available.", + "key destroyed, expired, not found, unreachable or permission denied.", + "Database is not accessible", + "The zone or region does not have sufficient resources to handle the request at the moment", + "User initiated cancellation", + "SQL server specific error", + "Any other internal error." + ], + "type": "string" + }, + "message": { + "description": "Additional information about the error encountered. REQUIRED", + "type": "string" + } + }, + "type": "object" + }, "OperationMetadata": { "description": "Pre-defined metadata fields.", "id": "OperationMetadata", @@ -1757,6 +2799,109 @@ }, "type": "object" }, + "Product": { + "description": "Product specification for Condor resources.", + "id": "Product", + "properties": { + "engine": { + "description": "The specific engine that the underlying database is running.", + "enum": [ + "ENGINE_UNSPECIFIED", + "ENGINE_MYSQL", + "MYSQL", + "ENGINE_POSTGRES", + "POSTGRES", + "ENGINE_SQL_SERVER", + "SQL_SERVER", + "ENGINE_NATIVE", + "NATIVE", + "ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT", + "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", + "ENGINE_MEMORYSTORE_FOR_REDIS", + "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", + "ENGINE_OTHER" + ], + "enumDeprecated": [ + false, + false, + true, + false, + true, + false, + true, + false, + true, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "UNSPECIFIED means engine type is not known or available.", + "MySQL binary running as an engine in the database instance.", + "MySQL binary running as engine in database instance.", + "Postgres binary running as engine in database instance.", + "Postgres binary running as engine in database instance.", + "SQLServer binary running as engine in database instance.", + "SQLServer binary running as engine in database instance.", + "Native database binary running as engine in instance.", + "Native database binary running as engine in instance.", + "Cloud Spanner with PostgreSQL dialect.", + "Cloud Spanner with Google SQL dialect.", + "Memorystore with Redis dialect.", + "Memorystore with Redis cluster dialect.", + "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." + ], + "type": "string" + }, + "type": { + "description": "Type of specific database product. It could be CloudSQL, AlloyDB etc..", + "enum": [ + "PRODUCT_TYPE_UNSPECIFIED", + "PRODUCT_TYPE_CLOUD_SQL", + "CLOUD_SQL", + "PRODUCT_TYPE_ALLOYDB", + "ALLOYDB", + "PRODUCT_TYPE_SPANNER", + "PRODUCT_TYPE_ON_PREM", + "ON_PREM", + "PRODUCT_TYPE_MEMORYSTORE", + "PRODUCT_TYPE_OTHER" + ], + "enumDeprecated": [ + false, + false, + true, + false, + true, + false, + false, + true, + false, + false + ], + "enumDescriptions": [ + "UNSPECIFIED means product type is not known or available.", + "Cloud SQL product area in GCP", + "Cloud SQL product area in GCP", + "AlloyDB product area in GCP", + "AlloyDB product area in GCP", + "Spanner product area in GCP", + "On premises database product.", + "On premises database product.", + "Memorystore product area in GCP", + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." + ], + "type": "string" + }, + "version": { + "description": "Version of the underlying database engine. Example values: For MySQL, it could be \"8.0\", \"5.7\" etc.. For Postgres, it could be \"14\", \"15\" etc..", + "type": "string" + } + }, + "type": "object" + }, "PscConfig": { "id": "PscConfig", "properties": { @@ -1857,6 +3002,36 @@ }, "type": "object" }, + "RetentionSettings": { + "id": "RetentionSettings", + "properties": { + "quantityBasedRetention": { + "format": "int32", + "type": "integer" + }, + "retentionUnit": { + "description": "The unit that 'retained_backups' represents.", + "enum": [ + "RETENTION_UNIT_UNSPECIFIED", + "COUNT", + "TIME", + "RETENTION_UNIT_OTHER" + ], + "enumDescriptions": [ + "Backup retention unit is unspecified, will be treated as COUNT.", + "Retention will be by count, eg. \"retain the most recent 7 backups\".", + "Retention will be by Time, eg. \"retain the last 7 days backups\".", + "For rest of the other category" + ], + "type": "string" + }, + "timeBasedRetention": { + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "StateInfo": { "description": "Represents additional information about the state of the cluster.", "id": "StateInfo", @@ -1981,6 +3156,19 @@ }, "type": "object" }, + "UserLabels": { + "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", + "id": "UserLabels", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, "WeeklyMaintenanceWindow": { "description": "Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.", "id": "WeeklyMaintenanceWindow", diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index 5b672b43654..ac3c25114f0 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -124,6 +124,55 @@ export namespace redis_v1 { } } + /** + * Configuration for availability of database instance + */ + export interface Schema$AvailabilityConfiguration { + /** + * Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available). + */ + availabilityType?: string | null; + externalReplicaConfigured?: boolean | null; + promotableReplicaConfigured?: boolean | null; + } + /** + * Configuration for automatic backups + */ + export interface Schema$BackupConfiguration { + /** + * Whether customer visible automated backups are enabled on the instance. + */ + automatedBackupEnabled?: boolean | null; + /** + * Backup retention settings. + */ + backupRetentionSettings?: Schema$RetentionSettings; + /** + * Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted. + */ + pointInTimeRecoveryEnabled?: boolean | null; + } + /** + * A backup run. + */ + export interface Schema$BackupRun { + /** + * The time the backup operation completed. REQUIRED + */ + endTime?: string | null; + /** + * Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL + */ + error?: Schema$OperationError; + /** + * The time the backup operation started. REQUIRED + */ + startTime?: string | null; + /** + * The status of this run. REQUIRED + */ + status?: string | null; + } export interface Schema$CertChain { /** * The certificates that form the CA chain, from leaf to root order. @@ -197,6 +246,256 @@ export namespace redis_v1 { */ uid?: string | null; } + /** + * Contains compliance information about a security standard indicating unmet recommendations. + */ + export interface Schema$Compliance { + /** + * Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. + */ + standard?: string | null; + /** + * Version of the standard or benchmark, for example, 1.1 + */ + version?: string | null; + } + /** + * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data + */ + export interface Schema$CustomMetadataData { + databaseMetadata?: Schema$DatabaseMetadata[]; + } + /** + * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings. + */ + export interface Schema$DatabaseMetadata { + /** + * Backup configuration for this database + */ + backupConfiguration?: Schema$BackupConfiguration; + /** + * Information about the last backup attempt for this database + */ + backupRun?: Schema$BackupRun; + product?: Schema$Product; + resourceId?: Schema$DatabaseResourceId; + /** + * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + } + /** + * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. + */ + export interface Schema$DatabaseResourceFeed { + /** + * Required. Timestamp when feed is generated. + */ + feedTimestamp?: string | null; + /** + * Required. Type feed to be ingested into condor + */ + feedType?: string | null; + /** + * More feed data would be added in subsequent CLs + */ + recommendationSignalData?: Schema$DatabaseResourceRecommendationSignalData; + resourceHealthSignalData?: Schema$DatabaseResourceHealthSignalData; + /** + * Primary key associated with the Resource. resource_id is available in individual feed level as well. + */ + resourceId?: Schema$DatabaseResourceId; + resourceMetadata?: Schema$DatabaseResourceMetadata; + } + /** + * Common model for database resource health signal data. + */ + export interface Schema$DatabaseResourceHealthSignalData { + /** + * Any other additional metadata + */ + additionalMetadata?: {[key: string]: any} | null; + /** + * Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards. + */ + compliance?: Schema$Compliance[]; + /** + * Description associated with signal + */ + description?: string | null; + /** + * Required. The last time at which the event described by this signal took place + */ + eventTime?: string | null; + /** + * The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals. + */ + externalUri?: string | null; + /** + * Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc. + */ + name?: string | null; + /** + * Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged + */ + provider?: string | null; + /** + * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "projects/123". For GCP provided resources, number should be project number. + */ + resourceContainer?: string | null; + /** + * Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * Required. The class of the signal, such as if it's a THREAT or VULNERABILITY. + */ + signalClass?: string | null; + /** + * Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal. + */ + signalId?: string | null; + /** + * Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc. + */ + signalType?: string | null; + state?: string | null; + } + /** + * DatabaseResourceId will serve as primary key for any resource ingestion event. + */ + export interface Schema$DatabaseResourceId { + /** + * Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged + */ + provider?: string | null; + /** + * Optional. Needs to be used only when the provider is PROVIDER_OTHER. + */ + providerDescription?: string | null; + /** + * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel + */ + resourceType?: string | null; + /** + * Required. A service-local token that distinguishes this resource from other resources within the same service. + */ + uniqueId?: string | null; + } + /** + * Common model for database resource instance metadata. + */ + export interface Schema$DatabaseResourceMetadata { + /** + * Availability configuration for this instance + */ + availabilityConfiguration?: Schema$AvailabilityConfiguration; + /** + * Backup configuration for this instance + */ + backupConfiguration?: Schema$BackupConfiguration; + /** + * Latest backup run information for this instance + */ + backupRun?: Schema$BackupRun; + /** + * The creation time of the resource, i.e. the time when resource is created and recorded in partner service. + */ + creationTime?: string | null; + /** + * Current state of the instance. + */ + currentState?: string | null; + /** + * Any custom metadata associated with the resource + */ + customMetadata?: Schema$CustomMetadataData; + /** + * Entitlements associated with the resource + */ + entitlements?: Schema$Entitlement[]; + /** + * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. + */ + expectedState?: string | null; + /** + * Required. Unique identifier for a Database resource + */ + id?: Schema$DatabaseResourceId; + /** + * The type of the instance. Specified at creation time. + */ + instanceType?: string | null; + /** + * The resource location. REQUIRED + */ + location?: string | null; + /** + * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. + */ + primaryResourceId?: Schema$DatabaseResourceId; + /** + * The product this resource represents. + */ + product?: Schema$Product; + /** + * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "/", such as "projects/123". For GCP provided resources, number should be project number. + */ + resourceContainer?: string | null; + /** + * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * The time at which the resource was updated and recorded at partner service. + */ + updationTime?: string | null; + /** + * User-provided labels, represented as a dictionary where each label is a single key value pair. + */ + userLabels?: {[key: string]: string} | null; + /** + * User-provided labels associated with the resource + */ + userLabelSet?: Schema$UserLabels; + } + /** + * Common model for database resource recommendation signal data. + */ + export interface Schema$DatabaseResourceRecommendationSignalData { + /** + * Optional. Any other additional metadata specific to recommendation + */ + additionalMetadata?: {[key: string]: any} | null; + /** + * Required. last time recommendationw as refreshed + */ + lastRefreshTime?: string | null; + /** + * Required. Recommendation state + */ + recommendationState?: string | null; + /** + * Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876 + */ + recommender?: string | null; + /** + * Required. ID of recommender. Examples: "google.cloudsql.instance.PerformanceRecommender" + */ + recommenderId?: string | null; + /** + * Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.cloudsql.instance.PerformanceRecommender", recommender_subtype can be "MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE"/"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE" + */ + recommenderSubtype?: string | null; + /** + * Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc. + */ + signalType?: string | null; + } /** * Endpoints on each network, for Redis clients to connect to the cluster. */ @@ -218,6 +517,19 @@ export namespace redis_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * Proto representing the access that a user has to a specific feature/service. NextId: 3. + */ + export interface Schema$Entitlement { + /** + * The current state of user's accessibility to a feature/benefit. + */ + entitlementState?: string | null; + /** + * An enum that represents the type of this entitlement. + */ + type?: string | null; + } /** * Request for Export. */ @@ -653,6 +965,20 @@ export namespace redis_v1 { */ response?: {[key: string]: any} | null; } + /** + * An error that occurred during a backup creation operation. + */ + export interface Schema$OperationError { + /** + * Identifies the specific error that occurred. REQUIRED + */ + code?: string | null; + errorType?: string | null; + /** + * Additional information about the error encountered. REQUIRED + */ + message?: string | null; + } /** * Pre-defined metadata fields. */ @@ -716,6 +1042,23 @@ export namespace redis_v1 { */ rdbSnapshotStartTime?: string | null; } + /** + * Product specification for Condor resources. + */ + export interface Schema$Product { + /** + * The specific engine that the underlying database is running. + */ + engine?: string | null; + /** + * Type of specific database product. It could be CloudSQL, AlloyDB etc.. + */ + type?: string | null; + /** + * Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc.. For Postgres, it could be "14", "15" etc.. + */ + version?: string | null; + } export interface Schema$PscConfig { /** * Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project\}/global/networks/{network_id\}. @@ -773,6 +1116,14 @@ export namespace redis_v1 { */ scheduleTime?: string | null; } + export interface Schema$RetentionSettings { + quantityBasedRetention?: number | null; + /** + * The unit that 'retained_backups' represents. + */ + retentionUnit?: string | null; + timeBasedRetention?: string | null; + } /** * Represents additional information about the state of the cluster. */ @@ -867,6 +1218,12 @@ export namespace redis_v1 { */ redisVersion?: string | null; } + /** + * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. + */ + export interface Schema$UserLabels { + labels?: {[key: string]: string} | null; + } /** * Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window. */ diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 39ad812bc5f..a5a15019523 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -124,6 +124,55 @@ export namespace redis_v1beta1 { } } + /** + * Configuration for availability of database instance + */ + export interface Schema$AvailabilityConfiguration { + /** + * Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available). + */ + availabilityType?: string | null; + externalReplicaConfigured?: boolean | null; + promotableReplicaConfigured?: boolean | null; + } + /** + * Configuration for automatic backups + */ + export interface Schema$BackupConfiguration { + /** + * Whether customer visible automated backups are enabled on the instance. + */ + automatedBackupEnabled?: boolean | null; + /** + * Backup retention settings. + */ + backupRetentionSettings?: Schema$RetentionSettings; + /** + * Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted. + */ + pointInTimeRecoveryEnabled?: boolean | null; + } + /** + * A backup run. + */ + export interface Schema$BackupRun { + /** + * The time the backup operation completed. REQUIRED + */ + endTime?: string | null; + /** + * Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL + */ + error?: Schema$OperationError; + /** + * The time the backup operation started. REQUIRED + */ + startTime?: string | null; + /** + * The status of this run. REQUIRED + */ + status?: string | null; + } export interface Schema$CertChain { /** * The certificates that form the CA chain, from leaf to root order. @@ -197,6 +246,256 @@ export namespace redis_v1beta1 { */ uid?: string | null; } + /** + * Contains compliance information about a security standard indicating unmet recommendations. + */ + export interface Schema$Compliance { + /** + * Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. + */ + standard?: string | null; + /** + * Version of the standard or benchmark, for example, 1.1 + */ + version?: string | null; + } + /** + * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data + */ + export interface Schema$CustomMetadataData { + databaseMetadata?: Schema$DatabaseMetadata[]; + } + /** + * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings. + */ + export interface Schema$DatabaseMetadata { + /** + * Backup configuration for this database + */ + backupConfiguration?: Schema$BackupConfiguration; + /** + * Information about the last backup attempt for this database + */ + backupRun?: Schema$BackupRun; + product?: Schema$Product; + resourceId?: Schema$DatabaseResourceId; + /** + * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + } + /** + * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. + */ + export interface Schema$DatabaseResourceFeed { + /** + * Required. Timestamp when feed is generated. + */ + feedTimestamp?: string | null; + /** + * Required. Type feed to be ingested into condor + */ + feedType?: string | null; + /** + * More feed data would be added in subsequent CLs + */ + recommendationSignalData?: Schema$DatabaseResourceRecommendationSignalData; + resourceHealthSignalData?: Schema$DatabaseResourceHealthSignalData; + /** + * Primary key associated with the Resource. resource_id is available in individual feed level as well. + */ + resourceId?: Schema$DatabaseResourceId; + resourceMetadata?: Schema$DatabaseResourceMetadata; + } + /** + * Common model for database resource health signal data. + */ + export interface Schema$DatabaseResourceHealthSignalData { + /** + * Any other additional metadata + */ + additionalMetadata?: {[key: string]: any} | null; + /** + * Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards. + */ + compliance?: Schema$Compliance[]; + /** + * Description associated with signal + */ + description?: string | null; + /** + * Required. The last time at which the event described by this signal took place + */ + eventTime?: string | null; + /** + * The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals. + */ + externalUri?: string | null; + /** + * Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc. + */ + name?: string | null; + /** + * Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged + */ + provider?: string | null; + /** + * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "projects/123". For GCP provided resources, number should be project number. + */ + resourceContainer?: string | null; + /** + * Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * Required. The class of the signal, such as if it's a THREAT or VULNERABILITY. + */ + signalClass?: string | null; + /** + * Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal. + */ + signalId?: string | null; + /** + * Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc. + */ + signalType?: string | null; + state?: string | null; + } + /** + * DatabaseResourceId will serve as primary key for any resource ingestion event. + */ + export interface Schema$DatabaseResourceId { + /** + * Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged + */ + provider?: string | null; + /** + * Optional. Needs to be used only when the provider is PROVIDER_OTHER. + */ + providerDescription?: string | null; + /** + * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel + */ + resourceType?: string | null; + /** + * Required. A service-local token that distinguishes this resource from other resources within the same service. + */ + uniqueId?: string | null; + } + /** + * Common model for database resource instance metadata. + */ + export interface Schema$DatabaseResourceMetadata { + /** + * Availability configuration for this instance + */ + availabilityConfiguration?: Schema$AvailabilityConfiguration; + /** + * Backup configuration for this instance + */ + backupConfiguration?: Schema$BackupConfiguration; + /** + * Latest backup run information for this instance + */ + backupRun?: Schema$BackupRun; + /** + * The creation time of the resource, i.e. the time when resource is created and recorded in partner service. + */ + creationTime?: string | null; + /** + * Current state of the instance. + */ + currentState?: string | null; + /** + * Any custom metadata associated with the resource + */ + customMetadata?: Schema$CustomMetadataData; + /** + * Entitlements associated with the resource + */ + entitlements?: Schema$Entitlement[]; + /** + * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. + */ + expectedState?: string | null; + /** + * Required. Unique identifier for a Database resource + */ + id?: Schema$DatabaseResourceId; + /** + * The type of the instance. Specified at creation time. + */ + instanceType?: string | null; + /** + * The resource location. REQUIRED + */ + location?: string | null; + /** + * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. + */ + primaryResourceId?: Schema$DatabaseResourceId; + /** + * The product this resource represents. + */ + product?: Schema$Product; + /** + * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "/", such as "projects/123". For GCP provided resources, number should be project number. + */ + resourceContainer?: string | null; + /** + * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * The time at which the resource was updated and recorded at partner service. + */ + updationTime?: string | null; + /** + * User-provided labels, represented as a dictionary where each label is a single key value pair. + */ + userLabels?: {[key: string]: string} | null; + /** + * User-provided labels associated with the resource + */ + userLabelSet?: Schema$UserLabels; + } + /** + * Common model for database resource recommendation signal data. + */ + export interface Schema$DatabaseResourceRecommendationSignalData { + /** + * Optional. Any other additional metadata specific to recommendation + */ + additionalMetadata?: {[key: string]: any} | null; + /** + * Required. last time recommendationw as refreshed + */ + lastRefreshTime?: string | null; + /** + * Required. Recommendation state + */ + recommendationState?: string | null; + /** + * Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876 + */ + recommender?: string | null; + /** + * Required. ID of recommender. Examples: "google.cloudsql.instance.PerformanceRecommender" + */ + recommenderId?: string | null; + /** + * Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.cloudsql.instance.PerformanceRecommender", recommender_subtype can be "MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE"/"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE" + */ + recommenderSubtype?: string | null; + /** + * Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc. + */ + signalType?: string | null; + } /** * Endpoints on each network, for Redis clients to connect to the cluster. */ @@ -218,6 +517,19 @@ export namespace redis_v1beta1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * Proto representing the access that a user has to a specific feature/service. NextId: 3. + */ + export interface Schema$Entitlement { + /** + * The current state of user's accessibility to a feature/benefit. + */ + entitlementState?: string | null; + /** + * An enum that represents the type of this entitlement. + */ + type?: string | null; + } /** * Request for Export. */ @@ -653,6 +965,20 @@ export namespace redis_v1beta1 { */ response?: {[key: string]: any} | null; } + /** + * An error that occurred during a backup creation operation. + */ + export interface Schema$OperationError { + /** + * Identifies the specific error that occurred. REQUIRED + */ + code?: string | null; + errorType?: string | null; + /** + * Additional information about the error encountered. REQUIRED + */ + message?: string | null; + } /** * Pre-defined metadata fields. */ @@ -716,6 +1042,23 @@ export namespace redis_v1beta1 { */ rdbSnapshotStartTime?: string | null; } + /** + * Product specification for Condor resources. + */ + export interface Schema$Product { + /** + * The specific engine that the underlying database is running. + */ + engine?: string | null; + /** + * Type of specific database product. It could be CloudSQL, AlloyDB etc.. + */ + type?: string | null; + /** + * Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc.. For Postgres, it could be "14", "15" etc.. + */ + version?: string | null; + } export interface Schema$PscConfig { /** * Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project\}/global/networks/{network_id\}. @@ -773,6 +1116,14 @@ export namespace redis_v1beta1 { */ scheduleTime?: string | null; } + export interface Schema$RetentionSettings { + quantityBasedRetention?: number | null; + /** + * The unit that 'retained_backups' represents. + */ + retentionUnit?: string | null; + timeBasedRetention?: string | null; + } /** * Represents additional information about the state of the cluster. */ @@ -867,6 +1218,12 @@ export namespace redis_v1beta1 { */ redisVersion?: string | null; } + /** + * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. + */ + export interface Schema$UserLabels { + labels?: {[key: string]: string} | null; + } /** * Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window. */ From bf50f07fcb2d94efc9ec9cb380c7d50c751def78 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 63/78] feat(retail): update the API #### retail:v2alpha The following keys were added: - resources.projects.methods.getAlertConfig.description - resources.projects.methods.getAlertConfig.flatPath - resources.projects.methods.getAlertConfig.httpMethod - resources.projects.methods.getAlertConfig.id - resources.projects.methods.getAlertConfig.parameterOrder - resources.projects.methods.getAlertConfig.parameters.name.description - resources.projects.methods.getAlertConfig.parameters.name.location - resources.projects.methods.getAlertConfig.parameters.name.pattern - resources.projects.methods.getAlertConfig.parameters.name.required - resources.projects.methods.getAlertConfig.parameters.name.type - resources.projects.methods.getAlertConfig.path - resources.projects.methods.getAlertConfig.response.$ref - resources.projects.methods.getAlertConfig.scopes - resources.projects.methods.updateAlertConfig.description - resources.projects.methods.updateAlertConfig.flatPath - resources.projects.methods.updateAlertConfig.httpMethod - resources.projects.methods.updateAlertConfig.id - resources.projects.methods.updateAlertConfig.parameterOrder - resources.projects.methods.updateAlertConfig.parameters.name.description - resources.projects.methods.updateAlertConfig.parameters.name.location - resources.projects.methods.updateAlertConfig.parameters.name.pattern - resources.projects.methods.updateAlertConfig.parameters.name.required - resources.projects.methods.updateAlertConfig.parameters.name.type - resources.projects.methods.updateAlertConfig.parameters.updateMask.description - resources.projects.methods.updateAlertConfig.parameters.updateMask.format - resources.projects.methods.updateAlertConfig.parameters.updateMask.location - resources.projects.methods.updateAlertConfig.parameters.updateMask.type - resources.projects.methods.updateAlertConfig.path - resources.projects.methods.updateAlertConfig.request.$ref - resources.projects.methods.updateAlertConfig.response.$ref - resources.projects.methods.updateAlertConfig.scopes - schemas.GoogleCloudRetailV2alphaAlertConfig.description - schemas.GoogleCloudRetailV2alphaAlertConfig.id - schemas.GoogleCloudRetailV2alphaAlertConfig.properties.alertPolicies.description - schemas.GoogleCloudRetailV2alphaAlertConfig.properties.alertPolicies.items.$ref - schemas.GoogleCloudRetailV2alphaAlertConfig.properties.alertPolicies.type - schemas.GoogleCloudRetailV2alphaAlertConfig.properties.name.description - schemas.GoogleCloudRetailV2alphaAlertConfig.properties.name.type - schemas.GoogleCloudRetailV2alphaAlertConfig.type - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.description - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.id - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.alertGroup.description - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.alertGroup.type - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.enrollStatus.description - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.enrollStatus.enum - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.enrollStatus.enumDescriptions - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.enrollStatus.type - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.recipients.description - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.recipients.items.$ref - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.properties.recipients.type - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicy.type - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient.description - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient.id - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient.properties.emailAddress.description - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient.properties.emailAddress.type - schemas.GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient.type --- discovery/retail-v2alpha.json | 122 ++++++++++++++++- src/apis/retail/v2alpha.ts | 248 ++++++++++++++++++++++++++++++++++ 2 files changed, 369 insertions(+), 1 deletion(-) diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index 4112c764b8d..b77ed56f20e 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -135,6 +135,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getAlertConfig": { + "description": "Get the AlertConfig of the requested project.", + "flatPath": "v2alpha/projects/{projectsId}/alertConfig", + "httpMethod": "GET", + "id": "retail.projects.getAlertConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig", + "location": "path", + "pattern": "^projects/[^/]+/alertConfig$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+name}", + "response": { + "$ref": "GoogleCloudRetailV2alphaAlertConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getLoggingConfig": { "description": "Gets the LoggingConfig of the requested project.", "flatPath": "v2alpha/projects/{projectsId}/loggingConfig", @@ -210,6 +235,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "updateAlertConfig": { + "description": "Update the alert config of the requested project.", + "flatPath": "v2alpha/projects/{projectsId}/alertConfig", + "httpMethod": "PATCH", + "id": "retail.projects.updateAlertConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig", + "location": "path", + "pattern": "^projects/[^/]+/alertConfig$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided AlertConfig to update. If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2alpha/{+name}", + "request": { + "$ref": "GoogleCloudRetailV2alphaAlertConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2alphaAlertConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateLoggingConfig": { "description": "Updates the LoggingConfig of the requested project.", "flatPath": "v2alpha/projects/{projectsId}/loggingConfig", @@ -2416,7 +2475,7 @@ } } }, - "revision": "20240222", + "revision": "20240307", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3241,6 +3300,67 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2alphaAlertConfig": { + "description": "Project level alert config.", + "id": "GoogleCloudRetailV2alphaAlertConfig", + "properties": { + "alertPolicies": { + "description": "Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]", + "items": { + "$ref": "GoogleCloudRetailV2alphaAlertConfigAlertPolicy" + }, + "type": "array" + }, + "name": { + "description": "Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaAlertConfigAlertPolicy": { + "description": "Alert policy for a customer.", + "id": "GoogleCloudRetailV2alphaAlertConfigAlertPolicy", + "properties": { + "alertGroup": { + "description": "The feature that provides alerting capability. Supported value is only `search-data-quality` for now.", + "type": "string" + }, + "enrollStatus": { + "description": "The enrollment status of a customer.", + "enum": [ + "ENROLL_STATUS_UNSPECIFIED", + "ENROLLED", + "DECLINED" + ], + "enumDescriptions": [ + "Default value. Used for customers who have not responded to the alert policy.", + "Customer is enrolled in this policy.", + "Customer declined this policy." + ], + "type": "string" + }, + "recipients": { + "description": "Recipients for the alert policy. One alert policy should not exceed 20 recipients.", + "items": { + "$ref": "GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient": { + "description": "Recipient contact information.", + "id": "GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient", + "properties": { + "emailAddress": { + "description": "Email address of the recipient.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaAttributesConfig": { "description": "Catalog level attribute config.", "id": "GoogleCloudRetailV2alphaAttributesConfig", diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 40d3e89482c..9cbbf5df5f2 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -339,6 +339,45 @@ export namespace retail_v2alpha { * Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method. */ export interface Schema$GoogleCloudRetailV2alphaAddLocalInventoriesResponse {} + /** + * Project level alert config. + */ + export interface Schema$GoogleCloudRetailV2alphaAlertConfig { + /** + * Alert policies for a customer. They must be unique by [AlertPolicy.alert_group] + */ + alertPolicies?: Schema$GoogleCloudRetailV2alphaAlertConfigAlertPolicy[]; + /** + * Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/x/alertConfig + */ + name?: string | null; + } + /** + * Alert policy for a customer. + */ + export interface Schema$GoogleCloudRetailV2alphaAlertConfigAlertPolicy { + /** + * The feature that provides alerting capability. Supported value is only `search-data-quality` for now. + */ + alertGroup?: string | null; + /** + * The enrollment status of a customer. + */ + enrollStatus?: string | null; + /** + * Recipients for the alert policy. One alert policy should not exceed 20 recipients. + */ + recipients?: Schema$GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient[]; + } + /** + * Recipient contact information. + */ + export interface Schema$GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient { + /** + * Email address of the recipient. + */ + emailAddress?: string | null; + } /** * Catalog level attribute config. */ @@ -4102,6 +4141,99 @@ export namespace retail_v2alpha { } } + /** + * Get the AlertConfig of the requested project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAlertConfig( + params: Params$Resource$Projects$Getalertconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getAlertConfig( + params?: Params$Resource$Projects$Getalertconfig, + options?: MethodOptions + ): GaxiosPromise; + getAlertConfig( + params: Params$Resource$Projects$Getalertconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAlertConfig( + params: Params$Resource$Projects$Getalertconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAlertConfig( + params: Params$Resource$Projects$Getalertconfig, + callback: BodyResponseCallback + ): void; + getAlertConfig( + callback: BodyResponseCallback + ): void; + getAlertConfig( + paramsOrCallback?: + | Params$Resource$Projects$Getalertconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getalertconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getalertconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets the LoggingConfig of the requested project. * @@ -4384,6 +4516,99 @@ export namespace retail_v2alpha { } } + /** + * Update the alert config of the requested project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateAlertConfig( + params: Params$Resource$Projects$Updatealertconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateAlertConfig( + params?: Params$Resource$Projects$Updatealertconfig, + options?: MethodOptions + ): GaxiosPromise; + updateAlertConfig( + params: Params$Resource$Projects$Updatealertconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAlertConfig( + params: Params$Resource$Projects$Updatealertconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAlertConfig( + params: Params$Resource$Projects$Updatealertconfig, + callback: BodyResponseCallback + ): void; + updateAlertConfig( + callback: BodyResponseCallback + ): void; + updateAlertConfig( + paramsOrCallback?: + | Params$Resource$Projects$Updatealertconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Updatealertconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Updatealertconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Updates the LoggingConfig of the requested project. * @@ -4490,6 +4715,13 @@ export namespace retail_v2alpha { */ requestBody?: Schema$GoogleCloudRetailV2alphaEnrollSolutionRequest; } + export interface Params$Resource$Projects$Getalertconfig + extends StandardParameters { + /** + * Required. Full AlertConfig resource name. Format: projects/{project_number\}/alertConfig + */ + name?: string; + } export interface Params$Resource$Projects$Getloggingconfig extends StandardParameters { /** @@ -4511,6 +4743,22 @@ export namespace retail_v2alpha { */ parent?: string; } + export interface Params$Resource$Projects$Updatealertconfig + extends StandardParameters { + /** + * Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/x/alertConfig + */ + name?: string; + /** + * Indicates which fields in the provided AlertConfig to update. If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaAlertConfig; + } export interface Params$Resource$Projects$Updateloggingconfig extends StandardParameters { /** From 7c08e19e0edf70a3ef9fc13003ba5413e5f7ca60 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 64/78] feat(run): update the API #### run:v1 The following keys were added: - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.id - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.properties.approvalRequired.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.properties.approvalRequired.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.id - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approvalTime.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approvalTime.format - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approvalTime.readOnly - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approvalTime.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approverAccount.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approverAccount.readOnly - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approverAccount.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.comment.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.comment.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.decision.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.decision.enum - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.decision.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.decision.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.url.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.url.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.type - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.description - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.id - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.location.description - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.location.type - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.paths.description - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.paths.items.type - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.paths.type - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.timing.$ref - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.timing.description - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.timing.readOnly - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.id - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.images.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.images.items.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.images.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.mavenArtifacts.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.mavenArtifacts.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.mavenArtifacts.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.npmPackages.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.npmPackages.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.npmPackages.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.objects.$ref - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.objects.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.pythonPackages.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.pythonPackages.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.pythonPackages.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.type - schemas.GoogleDevtoolsCloudbuildV1Build.description - schemas.GoogleDevtoolsCloudbuildV1Build.id - schemas.GoogleDevtoolsCloudbuildV1Build.properties.approval.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.approval.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.approval.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.artifacts.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.artifacts.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.availableSecrets.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.availableSecrets.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.buildTriggerId.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.buildTriggerId.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.buildTriggerId.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.createTime.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.createTime.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.createTime.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.createTime.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.failureInfo.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.failureInfo.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.failureInfo.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.finishTime.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.finishTime.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.finishTime.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.finishTime.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.id.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.id.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.id.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.images.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.images.items.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.images.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logUrl.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logUrl.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logUrl.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logsBucket.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logsBucket.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.name.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.options.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.options.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.projectId.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.projectId.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.projectId.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.queueTtl.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.queueTtl.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.queueTtl.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.results.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.results.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.results.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.secrets.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.secrets.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.secrets.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.serviceAccount.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.serviceAccount.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.source.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.source.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.sourceProvenance.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.sourceProvenance.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.sourceProvenance.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.startTime.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.startTime.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.startTime.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.startTime.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.enum - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.statusDetail.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.statusDetail.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.statusDetail.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.steps.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.steps.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.steps.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.substitutions.additionalProperties.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.substitutions.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.substitutions.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.tags.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.tags.items.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.tags.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timeout.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timeout.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timeout.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timing.additionalProperties.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timing.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timing.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timing.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.warnings.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.warnings.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.warnings.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.warnings.type - schemas.GoogleDevtoolsCloudbuildV1Build.type - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.description - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.id - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.config.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.config.description - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.config.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.result.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.result.description - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.result.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.description - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.enum - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.type - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.type - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.description - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.id - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.properties.build.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.properties.build.description - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.id - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.automapSubstitutions.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.automapSubstitutions.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.defaultLogsBucketBehavior.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.defaultLogsBucketBehavior.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.defaultLogsBucketBehavior.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.defaultLogsBucketBehavior.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.diskSizeGb.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.diskSizeGb.format - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.diskSizeGb.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.dynamicSubstitutions.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.dynamicSubstitutions.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.env.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.env.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.env.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logStreamingOption.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logStreamingOption.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logStreamingOption.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logStreamingOption.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.enumDeprecated - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enumDeprecated - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pool.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pool.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.requestedVerifyOption.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.requestedVerifyOption.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.requestedVerifyOption.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.requestedVerifyOption.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.secretEnv.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.secretEnv.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.secretEnv.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.substitutionOption.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.substitutionOption.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.substitutionOption.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.substitutionOption.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.volumes.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.volumes.items.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.volumes.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.workerPool.deprecated - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.workerPool.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.workerPool.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.id - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowExitCodes.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowExitCodes.items.format - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowExitCodes.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowExitCodes.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowFailure.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowFailure.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.args.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.args.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.args.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.automapSubstitutions.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.automapSubstitutions.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.dir.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.dir.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.entrypoint.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.entrypoint.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.env.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.env.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.env.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.exitCode.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.exitCode.format - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.exitCode.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.exitCode.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.id.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.id.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.pullTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.pullTiming.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.pullTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.script.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.script.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.secretEnv.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.secretEnv.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.secretEnv.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.enum - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timeout.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timeout.format - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timeout.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timing.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timing.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timing.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.volumes.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.volumes.items.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.volumes.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.waitFor.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.waitFor.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.waitFor.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.type - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.description - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.id - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.digest.description - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.digest.type - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.pushTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.pushTiming.description - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.pushTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.type - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.description - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.id - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.dir.description - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.dir.type - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.repository.type - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.revision.description - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.revision.type - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.type - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.description - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.id - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.detail.description - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.detail.type - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.type.description - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.type.enum - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.type.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.type.type - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.type - schemas.GoogleDevtoolsCloudbuildV1FileHashes.description - schemas.GoogleDevtoolsCloudbuildV1FileHashes.id - schemas.GoogleDevtoolsCloudbuildV1FileHashes.properties.fileHash.description - schemas.GoogleDevtoolsCloudbuildV1FileHashes.properties.fileHash.items.$ref - schemas.GoogleDevtoolsCloudbuildV1FileHashes.properties.fileHash.type - schemas.GoogleDevtoolsCloudbuildV1FileHashes.type - schemas.GoogleDevtoolsCloudbuildV1GitSource.description - schemas.GoogleDevtoolsCloudbuildV1GitSource.id - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.dir.description - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.dir.type - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.revision.description - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.revision.type - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.url.description - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.url.type - schemas.GoogleDevtoolsCloudbuildV1GitSource.type - schemas.GoogleDevtoolsCloudbuildV1Hash.description - schemas.GoogleDevtoolsCloudbuildV1Hash.id - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.type.description - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.type.enum - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.type.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.type.type - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.value.description - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.value.format - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.value.type - schemas.GoogleDevtoolsCloudbuildV1Hash.type - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.description - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.id - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.envMap.additionalProperties.format - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.envMap.additionalProperties.type - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.envMap.description - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.envMap.type - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.kmsKeyName.description - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.kmsKeyName.type - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.id - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.artifactId.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.artifactId.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.groupId.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.groupId.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.path.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.path.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.repository.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.version.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.version.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.type - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.description - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.id - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.properties.packagePath.description - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.properties.packagePath.type - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.properties.repository.type - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.type - schemas.GoogleDevtoolsCloudbuildV1PoolOption.description - schemas.GoogleDevtoolsCloudbuildV1PoolOption.id - schemas.GoogleDevtoolsCloudbuildV1PoolOption.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1PoolOption.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1PoolOption.type - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.description - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.id - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.paths.description - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.paths.items.type - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.paths.type - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.repository.type - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.id - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.branchName.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.branchName.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.commitSha.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.commitSha.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.dir.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.dir.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.invertRegex.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.invertRegex.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.projectId.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.projectId.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.repoName.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.repoName.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.substitutions.additionalProperties.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.substitutions.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.substitutions.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.tagName.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.tagName.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.type - schemas.GoogleDevtoolsCloudbuildV1Results.description - schemas.GoogleDevtoolsCloudbuildV1Results.id - schemas.GoogleDevtoolsCloudbuildV1Results.properties.artifactManifest.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.artifactManifest.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.artifactTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.artifactTiming.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepImages.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepImages.items.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepImages.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepOutputs.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepOutputs.items.format - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepOutputs.items.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepOutputs.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.images.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.images.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.images.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.mavenArtifacts.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.mavenArtifacts.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.mavenArtifacts.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.npmPackages.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.npmPackages.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.npmPackages.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.numArtifacts.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.numArtifacts.format - schemas.GoogleDevtoolsCloudbuildV1Results.properties.numArtifacts.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.pythonPackages.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.pythonPackages.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.pythonPackages.type - schemas.GoogleDevtoolsCloudbuildV1Results.type - schemas.GoogleDevtoolsCloudbuildV1Secret.description - schemas.GoogleDevtoolsCloudbuildV1Secret.id - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.kmsKeyName.description - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.kmsKeyName.type - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.secretEnv.additionalProperties.format - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.secretEnv.additionalProperties.type - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.secretEnv.description - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.secretEnv.type - schemas.GoogleDevtoolsCloudbuildV1Secret.type - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.description - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.id - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.properties.env.description - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.properties.env.type - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.properties.versionName.description - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.properties.versionName.type - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.type - schemas.GoogleDevtoolsCloudbuildV1Secrets.description - schemas.GoogleDevtoolsCloudbuildV1Secrets.id - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.inline.description - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.inline.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.inline.type - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.secretManager.description - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.secretManager.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.secretManager.type - schemas.GoogleDevtoolsCloudbuildV1Secrets.type - schemas.GoogleDevtoolsCloudbuildV1Source.description - schemas.GoogleDevtoolsCloudbuildV1Source.id - schemas.GoogleDevtoolsCloudbuildV1Source.properties.connectedRepository.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.connectedRepository.description - schemas.GoogleDevtoolsCloudbuildV1Source.properties.gitSource.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.gitSource.description - schemas.GoogleDevtoolsCloudbuildV1Source.properties.repoSource.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.repoSource.description - schemas.GoogleDevtoolsCloudbuildV1Source.properties.storageSource.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.storageSource.description - schemas.GoogleDevtoolsCloudbuildV1Source.properties.storageSourceManifest.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.storageSourceManifest.description - schemas.GoogleDevtoolsCloudbuildV1Source.type - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.id - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.fileHashes.additionalProperties.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.fileHashes.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.fileHashes.readOnly - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.fileHashes.type - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedConnectedRepository.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedConnectedRepository.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedConnectedRepository.readOnly - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedGitSource.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedGitSource.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedGitSource.readOnly - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedRepoSource.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedRepoSource.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedStorageSource.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedStorageSource.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedStorageSourceManifest.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedStorageSourceManifest.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.id - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.bucket.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.bucket.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.generation.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.generation.format - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.generation.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.object.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.object.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enum - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.type - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.description - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.id - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.bucket.description - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.bucket.type - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.generation.description - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.generation.format - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.generation.type - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.object.description - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.object.type - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.type - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.description - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.id - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.endTime.description - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.endTime.format - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.endTime.type - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.startTime.description - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.startTime.format - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.startTime.type - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.type - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.description - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.id - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.fileHashes.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.fileHashes.description - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.pushTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.pushTiming.description - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.pushTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.uri.description - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.uri.type - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.type - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.description - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.id - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.fileHashes.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.fileHashes.description - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.pushTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.pushTiming.description - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.pushTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.uri.description - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.uri.type - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.type - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.description - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.id - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.fileHashes.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.fileHashes.description - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.pushTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.pushTiming.description - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.pushTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.uri.description - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.uri.type - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.type - schemas.GoogleDevtoolsCloudbuildV1Volume.description - schemas.GoogleDevtoolsCloudbuildV1Volume.id - schemas.GoogleDevtoolsCloudbuildV1Volume.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1Volume.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1Volume.properties.path.description - schemas.GoogleDevtoolsCloudbuildV1Volume.properties.path.type - schemas.GoogleDevtoolsCloudbuildV1Volume.type - schemas.GoogleDevtoolsCloudbuildV1Warning.description - schemas.GoogleDevtoolsCloudbuildV1Warning.id - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.priority.description - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.priority.enum - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.priority.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.priority.type - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.text.description - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.text.type - schemas.GoogleDevtoolsCloudbuildV1Warning.type #### run:v2 The following keys were added: - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.id - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.properties.approvalRequired.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.properties.approvalRequired.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalConfig.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.id - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approvalTime.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approvalTime.format - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approvalTime.readOnly - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approvalTime.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approverAccount.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approverAccount.readOnly - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.approverAccount.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.comment.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.comment.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.decision.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.decision.enum - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.decision.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.decision.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.url.description - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.properties.url.type - schemas.GoogleDevtoolsCloudbuildV1ApprovalResult.type - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.description - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.id - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.location.description - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.location.type - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.paths.description - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.paths.items.type - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.paths.type - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.timing.$ref - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.timing.description - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.properties.timing.readOnly - schemas.GoogleDevtoolsCloudbuildV1ArtifactObjects.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.id - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.images.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.images.items.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.images.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.mavenArtifacts.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.mavenArtifacts.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.mavenArtifacts.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.npmPackages.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.npmPackages.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.npmPackages.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.objects.$ref - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.objects.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.pythonPackages.description - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.pythonPackages.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Artifacts.properties.pythonPackages.type - schemas.GoogleDevtoolsCloudbuildV1Artifacts.type - schemas.GoogleDevtoolsCloudbuildV1Build.description - schemas.GoogleDevtoolsCloudbuildV1Build.id - schemas.GoogleDevtoolsCloudbuildV1Build.properties.approval.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.approval.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.approval.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.artifacts.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.artifacts.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.availableSecrets.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.availableSecrets.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.buildTriggerId.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.buildTriggerId.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.buildTriggerId.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.createTime.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.createTime.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.createTime.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.createTime.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.failureInfo.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.failureInfo.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.failureInfo.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.finishTime.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.finishTime.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.finishTime.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.finishTime.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.id.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.id.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.id.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.images.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.images.items.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.images.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logUrl.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logUrl.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logUrl.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logsBucket.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.logsBucket.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.name.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.options.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.options.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.projectId.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.projectId.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.projectId.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.queueTtl.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.queueTtl.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.queueTtl.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.results.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.results.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.results.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.secrets.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.secrets.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.secrets.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.serviceAccount.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.serviceAccount.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.source.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.source.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.sourceProvenance.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.sourceProvenance.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.sourceProvenance.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.startTime.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.startTime.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.startTime.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.startTime.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.enum - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.status.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.statusDetail.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.statusDetail.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.statusDetail.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.steps.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.steps.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.steps.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.substitutions.additionalProperties.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.substitutions.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.substitutions.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.tags.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.tags.items.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.tags.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timeout.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timeout.format - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timeout.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timing.additionalProperties.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timing.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timing.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.timing.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.warnings.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.warnings.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.warnings.readOnly - schemas.GoogleDevtoolsCloudbuildV1Build.properties.warnings.type - schemas.GoogleDevtoolsCloudbuildV1Build.type - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.description - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.id - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.config.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.config.description - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.config.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.result.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.result.description - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.result.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.description - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.enum - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.properties.state.type - schemas.GoogleDevtoolsCloudbuildV1BuildApproval.type - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.description - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.id - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.properties.build.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.properties.build.description - schemas.GoogleDevtoolsCloudbuildV1BuildOperationMetadata.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.id - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.automapSubstitutions.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.automapSubstitutions.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.defaultLogsBucketBehavior.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.defaultLogsBucketBehavior.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.defaultLogsBucketBehavior.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.defaultLogsBucketBehavior.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.diskSizeGb.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.diskSizeGb.format - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.diskSizeGb.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.dynamicSubstitutions.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.dynamicSubstitutions.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.env.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.env.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.env.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logStreamingOption.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logStreamingOption.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logStreamingOption.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logStreamingOption.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.enumDeprecated - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.logging.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enumDeprecated - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.machineType.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pool.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pool.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.requestedVerifyOption.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.requestedVerifyOption.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.requestedVerifyOption.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.requestedVerifyOption.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.secretEnv.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.secretEnv.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.secretEnv.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.substitutionOption.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.substitutionOption.enum - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.substitutionOption.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.substitutionOption.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.volumes.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.volumes.items.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.volumes.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.workerPool.deprecated - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.workerPool.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.workerPool.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.id - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowExitCodes.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowExitCodes.items.format - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowExitCodes.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowExitCodes.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowFailure.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.allowFailure.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.args.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.args.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.args.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.automapSubstitutions.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.automapSubstitutions.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.dir.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.dir.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.entrypoint.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.entrypoint.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.env.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.env.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.env.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.exitCode.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.exitCode.format - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.exitCode.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.exitCode.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.id.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.id.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.pullTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.pullTiming.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.pullTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.script.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.script.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.secretEnv.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.secretEnv.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.secretEnv.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.enum - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.status.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timeout.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timeout.format - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timeout.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timing.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timing.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.timing.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.volumes.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.volumes.items.$ref - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.volumes.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.waitFor.description - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.waitFor.items.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.properties.waitFor.type - schemas.GoogleDevtoolsCloudbuildV1BuildStep.type - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.description - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.id - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.digest.description - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.digest.type - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.pushTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.pushTiming.description - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.properties.pushTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1BuiltImage.type - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.description - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.id - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.dir.description - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.dir.type - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.repository.type - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.revision.description - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.properties.revision.type - schemas.GoogleDevtoolsCloudbuildV1ConnectedRepository.type - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.description - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.id - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.detail.description - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.detail.type - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.type.description - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.type.enum - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.type.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.properties.type.type - schemas.GoogleDevtoolsCloudbuildV1FailureInfo.type - schemas.GoogleDevtoolsCloudbuildV1FileHashes.description - schemas.GoogleDevtoolsCloudbuildV1FileHashes.id - schemas.GoogleDevtoolsCloudbuildV1FileHashes.properties.fileHash.description - schemas.GoogleDevtoolsCloudbuildV1FileHashes.properties.fileHash.items.$ref - schemas.GoogleDevtoolsCloudbuildV1FileHashes.properties.fileHash.type - schemas.GoogleDevtoolsCloudbuildV1FileHashes.type - schemas.GoogleDevtoolsCloudbuildV1GitSource.description - schemas.GoogleDevtoolsCloudbuildV1GitSource.id - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.dir.description - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.dir.type - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.revision.description - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.revision.type - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.url.description - schemas.GoogleDevtoolsCloudbuildV1GitSource.properties.url.type - schemas.GoogleDevtoolsCloudbuildV1GitSource.type - schemas.GoogleDevtoolsCloudbuildV1Hash.description - schemas.GoogleDevtoolsCloudbuildV1Hash.id - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.type.description - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.type.enum - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.type.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.type.type - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.value.description - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.value.format - schemas.GoogleDevtoolsCloudbuildV1Hash.properties.value.type - schemas.GoogleDevtoolsCloudbuildV1Hash.type - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.description - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.id - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.envMap.additionalProperties.format - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.envMap.additionalProperties.type - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.envMap.description - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.envMap.type - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.kmsKeyName.description - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.properties.kmsKeyName.type - schemas.GoogleDevtoolsCloudbuildV1InlineSecret.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.id - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.artifactId.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.artifactId.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.groupId.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.groupId.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.path.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.path.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.repository.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.version.description - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.properties.version.type - schemas.GoogleDevtoolsCloudbuildV1MavenArtifact.type - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.description - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.id - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.properties.packagePath.description - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.properties.packagePath.type - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.properties.repository.type - schemas.GoogleDevtoolsCloudbuildV1NpmPackage.type - schemas.GoogleDevtoolsCloudbuildV1PoolOption.description - schemas.GoogleDevtoolsCloudbuildV1PoolOption.id - schemas.GoogleDevtoolsCloudbuildV1PoolOption.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1PoolOption.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1PoolOption.type - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.description - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.id - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.paths.description - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.paths.items.type - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.paths.type - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.properties.repository.type - schemas.GoogleDevtoolsCloudbuildV1PythonPackage.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.id - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.branchName.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.branchName.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.commitSha.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.commitSha.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.dir.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.dir.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.invertRegex.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.invertRegex.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.projectId.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.projectId.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.repoName.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.repoName.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.substitutions.additionalProperties.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.substitutions.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.substitutions.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.tagName.description - schemas.GoogleDevtoolsCloudbuildV1RepoSource.properties.tagName.type - schemas.GoogleDevtoolsCloudbuildV1RepoSource.type - schemas.GoogleDevtoolsCloudbuildV1Results.description - schemas.GoogleDevtoolsCloudbuildV1Results.id - schemas.GoogleDevtoolsCloudbuildV1Results.properties.artifactManifest.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.artifactManifest.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.artifactTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.artifactTiming.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepImages.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepImages.items.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepImages.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepOutputs.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepOutputs.items.format - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepOutputs.items.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.buildStepOutputs.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.images.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.images.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.images.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.mavenArtifacts.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.mavenArtifacts.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.mavenArtifacts.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.npmPackages.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.npmPackages.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.npmPackages.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.numArtifacts.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.numArtifacts.format - schemas.GoogleDevtoolsCloudbuildV1Results.properties.numArtifacts.type - schemas.GoogleDevtoolsCloudbuildV1Results.properties.pythonPackages.description - schemas.GoogleDevtoolsCloudbuildV1Results.properties.pythonPackages.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Results.properties.pythonPackages.type - schemas.GoogleDevtoolsCloudbuildV1Results.type - schemas.GoogleDevtoolsCloudbuildV1Secret.description - schemas.GoogleDevtoolsCloudbuildV1Secret.id - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.kmsKeyName.description - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.kmsKeyName.type - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.secretEnv.additionalProperties.format - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.secretEnv.additionalProperties.type - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.secretEnv.description - schemas.GoogleDevtoolsCloudbuildV1Secret.properties.secretEnv.type - schemas.GoogleDevtoolsCloudbuildV1Secret.type - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.description - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.id - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.properties.env.description - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.properties.env.type - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.properties.versionName.description - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.properties.versionName.type - schemas.GoogleDevtoolsCloudbuildV1SecretManagerSecret.type - schemas.GoogleDevtoolsCloudbuildV1Secrets.description - schemas.GoogleDevtoolsCloudbuildV1Secrets.id - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.inline.description - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.inline.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.inline.type - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.secretManager.description - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.secretManager.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Secrets.properties.secretManager.type - schemas.GoogleDevtoolsCloudbuildV1Secrets.type - schemas.GoogleDevtoolsCloudbuildV1Source.description - schemas.GoogleDevtoolsCloudbuildV1Source.id - schemas.GoogleDevtoolsCloudbuildV1Source.properties.connectedRepository.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.connectedRepository.description - schemas.GoogleDevtoolsCloudbuildV1Source.properties.gitSource.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.gitSource.description - schemas.GoogleDevtoolsCloudbuildV1Source.properties.repoSource.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.repoSource.description - schemas.GoogleDevtoolsCloudbuildV1Source.properties.storageSource.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.storageSource.description - schemas.GoogleDevtoolsCloudbuildV1Source.properties.storageSourceManifest.$ref - schemas.GoogleDevtoolsCloudbuildV1Source.properties.storageSourceManifest.description - schemas.GoogleDevtoolsCloudbuildV1Source.type - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.id - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.fileHashes.additionalProperties.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.fileHashes.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.fileHashes.readOnly - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.fileHashes.type - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedConnectedRepository.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedConnectedRepository.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedConnectedRepository.readOnly - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedGitSource.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedGitSource.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedGitSource.readOnly - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedRepoSource.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedRepoSource.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedStorageSource.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedStorageSource.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedStorageSourceManifest.$ref - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.properties.resolvedStorageSourceManifest.description - schemas.GoogleDevtoolsCloudbuildV1SourceProvenance.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.id - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.bucket.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.bucket.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.generation.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.generation.format - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.generation.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.object.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.object.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.description - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enum - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.type - schemas.GoogleDevtoolsCloudbuildV1StorageSource.type - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.description - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.id - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.bucket.description - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.bucket.type - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.generation.description - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.generation.format - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.generation.type - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.object.description - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.properties.object.type - schemas.GoogleDevtoolsCloudbuildV1StorageSourceManifest.type - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.description - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.id - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.endTime.description - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.endTime.format - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.endTime.type - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.startTime.description - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.startTime.format - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.properties.startTime.type - schemas.GoogleDevtoolsCloudbuildV1TimeSpan.type - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.description - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.id - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.fileHashes.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.fileHashes.description - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.pushTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.pushTiming.description - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.pushTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.uri.description - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.properties.uri.type - schemas.GoogleDevtoolsCloudbuildV1UploadedMavenArtifact.type - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.description - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.id - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.fileHashes.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.fileHashes.description - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.pushTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.pushTiming.description - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.pushTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.uri.description - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.properties.uri.type - schemas.GoogleDevtoolsCloudbuildV1UploadedNpmPackage.type - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.description - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.id - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.fileHashes.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.fileHashes.description - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.pushTiming.$ref - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.pushTiming.description - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.pushTiming.readOnly - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.uri.description - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.properties.uri.type - schemas.GoogleDevtoolsCloudbuildV1UploadedPythonPackage.type - schemas.GoogleDevtoolsCloudbuildV1Volume.description - schemas.GoogleDevtoolsCloudbuildV1Volume.id - schemas.GoogleDevtoolsCloudbuildV1Volume.properties.name.description - schemas.GoogleDevtoolsCloudbuildV1Volume.properties.name.type - schemas.GoogleDevtoolsCloudbuildV1Volume.properties.path.description - schemas.GoogleDevtoolsCloudbuildV1Volume.properties.path.type - schemas.GoogleDevtoolsCloudbuildV1Volume.type - schemas.GoogleDevtoolsCloudbuildV1Warning.description - schemas.GoogleDevtoolsCloudbuildV1Warning.id - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.priority.description - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.priority.enum - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.priority.enumDescriptions - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.priority.type - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.text.description - schemas.GoogleDevtoolsCloudbuildV1Warning.properties.text.type - schemas.GoogleDevtoolsCloudbuildV1Warning.type The following keys were changed: - schemas.GoogleCloudRunV2ServiceScaling.properties.minInstanceCount.description --- discovery/run-v1.json | 1274 +++++++++++++++++++++++++++++++++++++++- discovery/run-v2.json | 1276 ++++++++++++++++++++++++++++++++++++++++- src/apis/run/v1.ts | 825 ++++++++++++++++++++++++++ src/apis/run/v2.ts | 827 +++++++++++++++++++++++++- 4 files changed, 4198 insertions(+), 4 deletions(-) diff --git a/discovery/run-v1.json b/discovery/run-v1.json index 31b000feb0e..b34614e1da5 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -2614,7 +2614,7 @@ } } }, - "revision": "20240211", + "revision": "20240303", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -3411,6 +3411,1278 @@ }, "type": "object" }, + "GoogleDevtoolsCloudbuildV1ApprovalConfig": { + "description": "ApprovalConfig describes configuration for manual approval of a build.", + "id": "GoogleDevtoolsCloudbuildV1ApprovalConfig", + "properties": { + "approvalRequired": { + "description": "Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1ApprovalResult": { + "description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build.", + "id": "GoogleDevtoolsCloudbuildV1ApprovalResult", + "properties": { + "approvalTime": { + "description": "Output only. The time when the approval decision was made.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "approverAccount": { + "description": "Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Optional. An optional comment for this manual approval result.", + "type": "string" + }, + "decision": { + "description": "Required. The decision of this manual approval.", + "enum": [ + "DECISION_UNSPECIFIED", + "APPROVED", + "REJECTED" + ], + "enumDescriptions": [ + "Default enum type. This should not be used.", + "Build is approved.", + "Build is rejected." + ], + "type": "string" + }, + "url": { + "description": "Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1ArtifactObjects": { + "description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.", + "id": "GoogleDevtoolsCloudbuildV1ArtifactObjects", + "properties": { + "location": { + "description": "Cloud Storage bucket and optional object path, in the form \"gs://bucket/path/to/somewhere/\". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.", + "type": "string" + }, + "paths": { + "description": "Path globs used to match files in the build's workspace.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timing": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing all artifact objects.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Artifacts": { + "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", + "id": "GoogleDevtoolsCloudbuildV1Artifacts", + "properties": { + "images": { + "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mavenArtifacts": { + "description": "A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1MavenArtifact" + }, + "type": "array" + }, + "npmPackages": { + "description": "A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1NpmPackage" + }, + "type": "array" + }, + "objects": { + "$ref": "GoogleDevtoolsCloudbuildV1ArtifactObjects", + "description": "A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE." + }, + "pythonPackages": { + "description": "A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1PythonPackage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Build": { + "description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", + "id": "GoogleDevtoolsCloudbuildV1Build", + "properties": { + "approval": { + "$ref": "GoogleDevtoolsCloudbuildV1BuildApproval", + "description": "Output only. Describes this build's approval configuration, status, and result.", + "readOnly": true + }, + "artifacts": { + "$ref": "GoogleDevtoolsCloudbuildV1Artifacts", + "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps." + }, + "availableSecrets": { + "$ref": "GoogleDevtoolsCloudbuildV1Secrets", + "description": "Secrets and secret environment variables." + }, + "buildTriggerId": { + "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Time at which the request to create the build was received.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "failureInfo": { + "$ref": "GoogleDevtoolsCloudbuildV1FailureInfo", + "description": "Output only. Contains information about the build when status=FAILURE.", + "readOnly": true + }, + "finishTime": { + "description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. Unique identifier of the build.", + "readOnly": true, + "type": "string" + }, + "images": { + "description": "A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logUrl": { + "description": "Output only. URL to logs for this build in Google Cloud Console.", + "readOnly": true, + "type": "string" + }, + "logsBucket": { + "description": "Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.", + "type": "string" + }, + "name": { + "description": "Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.", + "readOnly": true, + "type": "string" + }, + "options": { + "$ref": "GoogleDevtoolsCloudbuildV1BuildOptions", + "description": "Special options for this build." + }, + "projectId": { + "description": "Output only. ID of the project.", + "readOnly": true, + "type": "string" + }, + "queueTtl": { + "description": "TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.", + "format": "google-duration", + "type": "string" + }, + "results": { + "$ref": "GoogleDevtoolsCloudbuildV1Results", + "description": "Output only. Results of the build.", + "readOnly": true + }, + "secrets": { + "description": "Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Secret" + }, + "type": "array" + }, + "serviceAccount": { + "description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. ", + "type": "string" + }, + "source": { + "$ref": "GoogleDevtoolsCloudbuildV1Source", + "description": "The location of the source files to build." + }, + "sourceProvenance": { + "$ref": "GoogleDevtoolsCloudbuildV1SourceProvenance", + "description": "Output only. A permanent fixed identifier for source.", + "readOnly": true + }, + "startTime": { + "description": "Output only. Time at which execution of the build was started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. Status of the build.", + "enum": [ + "STATUS_UNKNOWN", + "PENDING", + "QUEUED", + "WORKING", + "SUCCESS", + "FAILURE", + "INTERNAL_ERROR", + "TIMEOUT", + "CANCELLED", + "EXPIRED" + ], + "enumDescriptions": [ + "Status of the build is unknown.", + "Build has been created and is pending execution and queuing. It has not been queued.", + "Build or step is queued; work has not yet begun.", + "Build or step is being executed.", + "Build or step finished successfully.", + "Build or step failed to complete successfully.", + "Build or step failed due to an internal cause.", + "Build or step took longer than was allowed.", + "Build or step was canceled by a user.", + "Build was enqueued for longer than the value of `queue_ttl`." + ], + "readOnly": true, + "type": "string" + }, + "statusDetail": { + "description": "Output only. Customer-readable message about the current status.", + "readOnly": true, + "type": "string" + }, + "steps": { + "description": "Required. The operations to be performed on the workspace.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1BuildStep" + }, + "type": "array" + }, + "substitutions": { + "additionalProperties": { + "type": "string" + }, + "description": "Substitutions data for `Build` resource.", + "type": "object" + }, + "tags": { + "description": "Tags for annotation of a `Build`. These are not docker tags.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeout": { + "description": "Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes.", + "format": "google-duration", + "type": "string" + }, + "timing": { + "additionalProperties": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan" + }, + "description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.", + "readOnly": true, + "type": "object" + }, + "warnings": { + "description": "Output only. Non-fatal problems encountered during the execution of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Warning" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuildApproval": { + "description": "BuildApproval describes a build's approval configuration, state, and result.", + "id": "GoogleDevtoolsCloudbuildV1BuildApproval", + "properties": { + "config": { + "$ref": "GoogleDevtoolsCloudbuildV1ApprovalConfig", + "description": "Output only. Configuration for manual approval of this build.", + "readOnly": true + }, + "result": { + "$ref": "GoogleDevtoolsCloudbuildV1ApprovalResult", + "description": "Output only. Result of manual approval for this Build.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of this build's approval.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "APPROVED", + "REJECTED", + "CANCELLED" + ], + "enumDescriptions": [ + "Default enum type. This should not be used.", + "Build approval is pending.", + "Build approval has been approved.", + "Build approval has been rejected.", + "Build was cancelled while it was still pending approval." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuildOperationMetadata": { + "description": "Metadata for build operations.", + "id": "GoogleDevtoolsCloudbuildV1BuildOperationMetadata", + "properties": { + "build": { + "$ref": "GoogleDevtoolsCloudbuildV1Build", + "description": "The build that the operation is tracking." + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuildOptions": { + "description": "Optional arguments to enable specific features of builds.", + "id": "GoogleDevtoolsCloudbuildV1BuildOptions", + "properties": { + "automapSubstitutions": { + "description": "Option to include built-in and custom substitutions as env variables for all build steps.", + "type": "boolean" + }, + "defaultLogsBucketBehavior": { + "description": "Optional. Option to specify how default logs buckets are setup.", + "enum": [ + "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", + "REGIONAL_USER_OWNED_BUCKET" + ], + "enumDescriptions": [ + "Unspecified.", + "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project." + ], + "type": "string" + }, + "diskSizeGb": { + "description": "Requested disk size for the VM that runs the build. Note that this is *NOT* \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error.", + "format": "int64", + "type": "string" + }, + "dynamicSubstitutions": { + "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.", + "type": "boolean" + }, + "env": { + "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "logStreamingOption": { + "description": "Option to define build log streaming behavior to Cloud Storage.", + "enum": [ + "STREAM_DEFAULT", + "STREAM_ON", + "STREAM_OFF" + ], + "enumDescriptions": [ + "Service may automatically determine build log streaming behavior.", + "Build logs should be streamed to Cloud Storage.", + "Build logs should not be streamed to Cloud Storage; they will be written when the build is completed." + ], + "type": "string" + }, + "logging": { + "description": "Option to specify the logging mode, which determines if and where build logs are stored.", + "enum": [ + "LOGGING_UNSPECIFIED", + "LEGACY", + "GCS_ONLY", + "STACKDRIVER_ONLY", + "CLOUD_LOGGING_ONLY", + "NONE" + ], + "enumDeprecated": [ + false, + false, + false, + true, + false, + false + ], + "enumDescriptions": [ + "The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.", + "Build logs are stored in Cloud Logging and Cloud Storage.", + "Build logs are stored in Cloud Storage.", + "This option is the same as CLOUD_LOGGING_ONLY.", + "Build logs are stored in Cloud Logging. Selecting this option will not allow [logs streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).", + "Turn off all logging. No build logs will be captured." + ], + "type": "string" + }, + "machineType": { + "description": "Compute Engine machine type on which to run the build.", + "enum": [ + "UNSPECIFIED", + "N1_HIGHCPU_8", + "N1_HIGHCPU_32", + "E2_HIGHCPU_8", + "E2_HIGHCPU_32", + "E2_MEDIUM" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false + ], + "enumDescriptions": [ + "Standard machine type.", + "Highcpu machine with 8 CPUs.", + "Highcpu machine with 32 CPUs.", + "Highcpu e2 machine with 8 CPUs.", + "Highcpu e2 machine with 32 CPUs.", + "E2 machine with 1 CPU." + ], + "type": "string" + }, + "pool": { + "$ref": "GoogleDevtoolsCloudbuildV1PoolOption", + "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." + }, + "requestedVerifyOption": { + "description": "Requested verifiability options.", + "enum": [ + "NOT_VERIFIED", + "VERIFIED" + ], + "enumDescriptions": [ + "Not a verifiable build (the default).", + "Build must be verified." + ], + "type": "string" + }, + "secretEnv": { + "description": "A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceProvenanceHash": { + "description": "Requested hash for SourceProvenance.", + "items": { + "enum": [ + "NONE", + "SHA256", + "MD5", + "SHA512" + ], + "enumDescriptions": [ + "No hash requested.", + "Use a sha256 hash.", + "Use a md5 hash.", + "Use a sha512 hash." + ], + "type": "string" + }, + "type": "array" + }, + "substitutionOption": { + "description": "Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.", + "enum": [ + "MUST_MATCH", + "ALLOW_LOOSE" + ], + "enumDescriptions": [ + "Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.", + "Do not fail the build if error in substitutions checks." + ], + "type": "string" + }, + "volumes": { + "description": "Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Volume" + }, + "type": "array" + }, + "workerPool": { + "deprecated": true, + "description": "This field deprecated; please use `pool.name` instead.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuildStep": { + "description": "A step in the build pipeline.", + "id": "GoogleDevtoolsCloudbuildV1BuildStep", + "properties": { + "allowExitCodes": { + "description": "Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "allowFailure": { + "description": "Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.", + "type": "boolean" + }, + "args": { + "description": "A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.", + "items": { + "type": "string" + }, + "type": "array" + }, + "automapSubstitutions": { + "description": "Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.", + "type": "boolean" + }, + "dir": { + "description": "Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.", + "type": "string" + }, + "entrypoint": { + "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.", + "type": "string" + }, + "env": { + "description": "A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "exitCode": { + "description": "Output only. Return code from running the step.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "id": { + "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.", + "type": "string" + }, + "name": { + "description": "Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like \"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.", + "type": "string" + }, + "pullTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pulling this build step's builder image only.", + "readOnly": true + }, + "script": { + "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.", + "type": "string" + }, + "secretEnv": { + "description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.", + "enum": [ + "STATUS_UNKNOWN", + "PENDING", + "QUEUED", + "WORKING", + "SUCCESS", + "FAILURE", + "INTERNAL_ERROR", + "TIMEOUT", + "CANCELLED", + "EXPIRED" + ], + "enumDescriptions": [ + "Status of the build is unknown.", + "Build has been created and is pending execution and queuing. It has not been queued.", + "Build or step is queued; work has not yet begun.", + "Build or step is being executed.", + "Build or step finished successfully.", + "Build or step failed to complete successfully.", + "Build or step failed due to an internal cause.", + "Build or step took longer than was allowed.", + "Build or step was canceled by a user.", + "Build was enqueued for longer than the value of `queue_ttl`." + ], + "readOnly": true, + "type": "string" + }, + "timeout": { + "description": "Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.", + "format": "google-duration", + "type": "string" + }, + "timing": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for executing this build step.", + "readOnly": true + }, + "volumes": { + "description": "List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Volume" + }, + "type": "array" + }, + "waitFor": { + "description": "The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuiltImage": { + "description": "An image built by the pipeline.", + "id": "GoogleDevtoolsCloudbuildV1BuiltImage", + "properties": { + "digest": { + "description": "Docker Registry 2.0 digest.", + "type": "string" + }, + "name": { + "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`.", + "type": "string" + }, + "pushTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified image.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1ConnectedRepository": { + "description": "Location of the source in a 2nd-gen Google Cloud Build repository resource.", + "id": "GoogleDevtoolsCloudbuildV1ConnectedRepository", + "properties": { + "dir": { + "description": "Directory, relative to the source root, in which to run the build.", + "type": "string" + }, + "repository": { + "description": "Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.", + "type": "string" + }, + "revision": { + "description": "The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1FailureInfo": { + "description": "A fatal problem encountered during the execution of the build.", + "id": "GoogleDevtoolsCloudbuildV1FailureInfo", + "properties": { + "detail": { + "description": "Explains the failure issue in more detail using hard-coded text.", + "type": "string" + }, + "type": { + "description": "The name of the failure.", + "enum": [ + "FAILURE_TYPE_UNSPECIFIED", + "PUSH_FAILED", + "PUSH_IMAGE_NOT_FOUND", + "PUSH_NOT_AUTHORIZED", + "LOGGING_FAILURE", + "USER_BUILD_STEP", + "FETCH_SOURCE_FAILED" + ], + "enumDescriptions": [ + "Type unspecified", + "Unable to push the image to the repository.", + "Final image not found.", + "Unauthorized push of the final image.", + "Backend logging failures. Should retry.", + "A build step has failed.", + "The source fetching has failed." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1FileHashes": { + "description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.", + "id": "GoogleDevtoolsCloudbuildV1FileHashes", + "properties": { + "fileHash": { + "description": "Collection of file hashes.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Hash" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1GitSource": { + "description": "Location of the source in any accessible Git repository.", + "id": "GoogleDevtoolsCloudbuildV1GitSource", + "properties": { + "dir": { + "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.", + "type": "string" + }, + "revision": { + "description": "The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.", + "type": "string" + }, + "url": { + "description": "Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Hash": { + "description": "Container message for hash values.", + "id": "GoogleDevtoolsCloudbuildV1Hash", + "properties": { + "type": { + "description": "The type of hash that was performed.", + "enum": [ + "NONE", + "SHA256", + "MD5", + "SHA512" + ], + "enumDescriptions": [ + "No hash requested.", + "Use a sha256 hash.", + "Use a md5 hash.", + "Use a sha512 hash." + ], + "type": "string" + }, + "value": { + "description": "The hash value.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1InlineSecret": { + "description": "Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.", + "id": "GoogleDevtoolsCloudbuildV1InlineSecret", + "properties": { + "envMap": { + "additionalProperties": { + "format": "byte", + "type": "string" + }, + "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", + "type": "object" + }, + "kmsKeyName": { + "description": "Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1MavenArtifact": { + "description": "A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.", + "id": "GoogleDevtoolsCloudbuildV1MavenArtifact", + "properties": { + "artifactId": { + "description": "Maven `artifactId` value used when uploading the artifact to Artifact Registry.", + "type": "string" + }, + "groupId": { + "description": "Maven `groupId` value used when uploading the artifact to Artifact Registry.", + "type": "string" + }, + "path": { + "description": "Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", + "type": "string" + }, + "repository": { + "description": "Artifact Registry repository, in the form \"https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY\" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.", + "type": "string" + }, + "version": { + "description": "Maven `version` value used when uploading the artifact to Artifact Registry.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1NpmPackage": { + "description": "Npm package to upload to Artifact Registry upon successful completion of all build steps.", + "id": "GoogleDevtoolsCloudbuildV1NpmPackage", + "properties": { + "packagePath": { + "description": "Path to the package.json. e.g. workspace/path/to/package", + "type": "string" + }, + "repository": { + "description": "Artifact Registry repository, in the form \"https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY\" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1PoolOption": { + "description": "Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.", + "id": "GoogleDevtoolsCloudbuildV1PoolOption", + "properties": { + "name": { + "description": "The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1PythonPackage": { + "description": "Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.", + "id": "GoogleDevtoolsCloudbuildV1PythonPackage", + "properties": { + "paths": { + "description": "Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file.", + "items": { + "type": "string" + }, + "type": "array" + }, + "repository": { + "description": "Artifact Registry repository, in the form \"https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY\" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1RepoSource": { + "description": "Location of the source in a Google Cloud Source Repository.", + "id": "GoogleDevtoolsCloudbuildV1RepoSource", + "properties": { + "branchName": { + "description": "Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", + "type": "string" + }, + "commitSha": { + "description": "Explicit commit SHA to build.", + "type": "string" + }, + "dir": { + "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.", + "type": "string" + }, + "invertRegex": { + "description": "Only trigger a build if the revision regex does NOT match the revision regex.", + "type": "boolean" + }, + "projectId": { + "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", + "type": "string" + }, + "repoName": { + "description": "Name of the Cloud Source Repository.", + "type": "string" + }, + "substitutions": { + "additionalProperties": { + "type": "string" + }, + "description": "Substitutions to use in a triggered build. Should only be used with RunBuildTrigger", + "type": "object" + }, + "tagName": { + "description": "Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Results": { + "description": "Artifacts created by the build pipeline.", + "id": "GoogleDevtoolsCloudbuildV1Results", + "properties": { + "artifactManifest": { + "description": "Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", + "type": "string" + }, + "artifactTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Time to push all non-container artifacts to Cloud Storage." + }, + "buildStepImages": { + "description": "List of build step digests, in the order corresponding to build step indices.", + "items": { + "type": "string" + }, + "type": "array" + }, + "buildStepOutputs": { + "description": "List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored.", + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "images": { + "description": "Container images that were built as a part of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1BuiltImage" + }, + "type": "array" + }, + "mavenArtifacts": { + "description": "Maven artifacts uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact" + }, + "type": "array" + }, + "npmPackages": { + "description": "Npm packages uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1UploadedNpmPackage" + }, + "type": "array" + }, + "numArtifacts": { + "description": "Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", + "format": "int64", + "type": "string" + }, + "pythonPackages": { + "description": "Python artifacts uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1UploadedPythonPackage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Secret": { + "description": "Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.", + "id": "GoogleDevtoolsCloudbuildV1Secret", + "properties": { + "kmsKeyName": { + "description": "Cloud KMS key name to use to decrypt these envs.", + "type": "string" + }, + "secretEnv": { + "additionalProperties": { + "format": "byte", + "type": "string" + }, + "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1SecretManagerSecret": { + "description": "Pairs a secret environment variable with a SecretVersion in Secret Manager.", + "id": "GoogleDevtoolsCloudbuildV1SecretManagerSecret", + "properties": { + "env": { + "description": "Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.", + "type": "string" + }, + "versionName": { + "description": "Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Secrets": { + "description": "Secrets and secret environment variables.", + "id": "GoogleDevtoolsCloudbuildV1Secrets", + "properties": { + "inline": { + "description": "Secrets encrypted with KMS key and the associated secret environment variable.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1InlineSecret" + }, + "type": "array" + }, + "secretManager": { + "description": "Secrets in Secret Manager and associated secret environment variable.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1SecretManagerSecret" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Source": { + "description": "Location of the source in a supported storage service.", + "id": "GoogleDevtoolsCloudbuildV1Source", + "properties": { + "connectedRepository": { + "$ref": "GoogleDevtoolsCloudbuildV1ConnectedRepository", + "description": "Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource." + }, + "gitSource": { + "$ref": "GoogleDevtoolsCloudbuildV1GitSource", + "description": "If provided, get the source from this Git repository." + }, + "repoSource": { + "$ref": "GoogleDevtoolsCloudbuildV1RepoSource", + "description": "If provided, get the source from this location in a Cloud Source Repository." + }, + "storageSource": { + "$ref": "GoogleDevtoolsCloudbuildV1StorageSource", + "description": "If provided, get the source from this location in Cloud Storage." + }, + "storageSourceManifest": { + "$ref": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", + "description": "If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher)." + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1SourceProvenance": { + "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.", + "id": "GoogleDevtoolsCloudbuildV1SourceProvenance", + "properties": { + "fileHashes": { + "additionalProperties": { + "$ref": "GoogleDevtoolsCloudbuildV1FileHashes" + }, + "description": "Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.", + "readOnly": true, + "type": "object" + }, + "resolvedConnectedRepository": { + "$ref": "GoogleDevtoolsCloudbuildV1ConnectedRepository", + "description": "Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.", + "readOnly": true + }, + "resolvedGitSource": { + "$ref": "GoogleDevtoolsCloudbuildV1GitSource", + "description": "Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.", + "readOnly": true + }, + "resolvedRepoSource": { + "$ref": "GoogleDevtoolsCloudbuildV1RepoSource", + "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved." + }, + "resolvedStorageSource": { + "$ref": "GoogleDevtoolsCloudbuildV1StorageSource", + "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved." + }, + "resolvedStorageSourceManifest": { + "$ref": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", + "description": "A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview." + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1StorageSource": { + "description": "Location of the source in an archive file in Cloud Storage.", + "id": "GoogleDevtoolsCloudbuildV1StorageSource", + "properties": { + "bucket": { + "description": "Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "type": "string" + }, + "generation": { + "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", + "format": "int64", + "type": "string" + }, + "object": { + "description": "Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", + "type": "string" + }, + "sourceFetcher": { + "description": "Optional. Option to specify the tool to fetch the source file for the build.", + "enum": [ + "SOURCE_FETCHER_UNSPECIFIED", + "GSUTIL", + "GCS_FETCHER" + ], + "enumDescriptions": [ + "Unspecified defaults to GSUTIL.", + "Use the \"gsutil\" tool to download the source file.", + "Use the Cloud Storage Fetcher tool to download the source file." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1StorageSourceManifest": { + "description": "Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).", + "id": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", + "properties": { + "bucket": { + "description": "Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "type": "string" + }, + "generation": { + "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", + "format": "int64", + "type": "string" + }, + "object": { + "description": "Cloud Storage object containing the source manifest. This object must be a JSON file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1TimeSpan": { + "description": "Start and end times for a build execution phase.", + "id": "GoogleDevtoolsCloudbuildV1TimeSpan", + "properties": { + "endTime": { + "description": "End of time span.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Start of time span.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact": { + "description": "A Maven artifact uploaded using the MavenArtifact directive.", + "id": "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact", + "properties": { + "fileHashes": { + "$ref": "GoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the Maven Artifact." + }, + "pushTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded artifact.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1UploadedNpmPackage": { + "description": "An npm package uploaded to Artifact Registry using the NpmPackage directive.", + "id": "GoogleDevtoolsCloudbuildV1UploadedNpmPackage", + "properties": { + "fileHashes": { + "$ref": "GoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the npm package." + }, + "pushTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded npm package.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1UploadedPythonPackage": { + "description": "Artifact uploaded using the PythonPackage directive.", + "id": "GoogleDevtoolsCloudbuildV1UploadedPythonPackage", + "properties": { + "fileHashes": { + "$ref": "GoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the Python Artifact." + }, + "pushTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded artifact.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Volume": { + "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.", + "id": "GoogleDevtoolsCloudbuildV1Volume", + "properties": { + "name": { + "description": "Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.", + "type": "string" + }, + "path": { + "description": "Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Warning": { + "description": "A non-fatal problem encountered during the execution of the build.", + "id": "GoogleDevtoolsCloudbuildV1Warning", + "properties": { + "priority": { + "description": "The priority for this warning.", + "enum": [ + "PRIORITY_UNSPECIFIED", + "INFO", + "WARNING", + "ALERT" + ], + "enumDescriptions": [ + "Should not be used.", + "e.g. deprecation warnings and alternative feature highlights.", + "e.g. automated detection of possible issues with the build.", + "e.g. alerts that a feature used in the build is pending removal" + ], + "type": "string" + }, + "text": { + "description": "Explanation of the warning generated.", + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse", diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 20821bc1298..d5c8b088382 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1317,7 +1317,7 @@ } } }, - "revision": "20240218", + "revision": "20240303", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2957,7 +2957,7 @@ "id": "GoogleCloudRunV2ServiceScaling", "properties": { "minInstanceCount": { - "description": "total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. (ALPHA)", + "description": "total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. (BETA)", "format": "int32", "type": "integer" } @@ -3415,6 +3415,1278 @@ }, "type": "object" }, + "GoogleDevtoolsCloudbuildV1ApprovalConfig": { + "description": "ApprovalConfig describes configuration for manual approval of a build.", + "id": "GoogleDevtoolsCloudbuildV1ApprovalConfig", + "properties": { + "approvalRequired": { + "description": "Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1ApprovalResult": { + "description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build.", + "id": "GoogleDevtoolsCloudbuildV1ApprovalResult", + "properties": { + "approvalTime": { + "description": "Output only. The time when the approval decision was made.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "approverAccount": { + "description": "Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Optional. An optional comment for this manual approval result.", + "type": "string" + }, + "decision": { + "description": "Required. The decision of this manual approval.", + "enum": [ + "DECISION_UNSPECIFIED", + "APPROVED", + "REJECTED" + ], + "enumDescriptions": [ + "Default enum type. This should not be used.", + "Build is approved.", + "Build is rejected." + ], + "type": "string" + }, + "url": { + "description": "Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1ArtifactObjects": { + "description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.", + "id": "GoogleDevtoolsCloudbuildV1ArtifactObjects", + "properties": { + "location": { + "description": "Cloud Storage bucket and optional object path, in the form \"gs://bucket/path/to/somewhere/\". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.", + "type": "string" + }, + "paths": { + "description": "Path globs used to match files in the build's workspace.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timing": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing all artifact objects.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Artifacts": { + "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", + "id": "GoogleDevtoolsCloudbuildV1Artifacts", + "properties": { + "images": { + "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mavenArtifacts": { + "description": "A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1MavenArtifact" + }, + "type": "array" + }, + "npmPackages": { + "description": "A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1NpmPackage" + }, + "type": "array" + }, + "objects": { + "$ref": "GoogleDevtoolsCloudbuildV1ArtifactObjects", + "description": "A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE." + }, + "pythonPackages": { + "description": "A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1PythonPackage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Build": { + "description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", + "id": "GoogleDevtoolsCloudbuildV1Build", + "properties": { + "approval": { + "$ref": "GoogleDevtoolsCloudbuildV1BuildApproval", + "description": "Output only. Describes this build's approval configuration, status, and result.", + "readOnly": true + }, + "artifacts": { + "$ref": "GoogleDevtoolsCloudbuildV1Artifacts", + "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps." + }, + "availableSecrets": { + "$ref": "GoogleDevtoolsCloudbuildV1Secrets", + "description": "Secrets and secret environment variables." + }, + "buildTriggerId": { + "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Time at which the request to create the build was received.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "failureInfo": { + "$ref": "GoogleDevtoolsCloudbuildV1FailureInfo", + "description": "Output only. Contains information about the build when status=FAILURE.", + "readOnly": true + }, + "finishTime": { + "description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. Unique identifier of the build.", + "readOnly": true, + "type": "string" + }, + "images": { + "description": "A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logUrl": { + "description": "Output only. URL to logs for this build in Google Cloud Console.", + "readOnly": true, + "type": "string" + }, + "logsBucket": { + "description": "Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.", + "type": "string" + }, + "name": { + "description": "Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.", + "readOnly": true, + "type": "string" + }, + "options": { + "$ref": "GoogleDevtoolsCloudbuildV1BuildOptions", + "description": "Special options for this build." + }, + "projectId": { + "description": "Output only. ID of the project.", + "readOnly": true, + "type": "string" + }, + "queueTtl": { + "description": "TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.", + "format": "google-duration", + "type": "string" + }, + "results": { + "$ref": "GoogleDevtoolsCloudbuildV1Results", + "description": "Output only. Results of the build.", + "readOnly": true + }, + "secrets": { + "description": "Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Secret" + }, + "type": "array" + }, + "serviceAccount": { + "description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. ", + "type": "string" + }, + "source": { + "$ref": "GoogleDevtoolsCloudbuildV1Source", + "description": "The location of the source files to build." + }, + "sourceProvenance": { + "$ref": "GoogleDevtoolsCloudbuildV1SourceProvenance", + "description": "Output only. A permanent fixed identifier for source.", + "readOnly": true + }, + "startTime": { + "description": "Output only. Time at which execution of the build was started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. Status of the build.", + "enum": [ + "STATUS_UNKNOWN", + "PENDING", + "QUEUED", + "WORKING", + "SUCCESS", + "FAILURE", + "INTERNAL_ERROR", + "TIMEOUT", + "CANCELLED", + "EXPIRED" + ], + "enumDescriptions": [ + "Status of the build is unknown.", + "Build has been created and is pending execution and queuing. It has not been queued.", + "Build or step is queued; work has not yet begun.", + "Build or step is being executed.", + "Build or step finished successfully.", + "Build or step failed to complete successfully.", + "Build or step failed due to an internal cause.", + "Build or step took longer than was allowed.", + "Build or step was canceled by a user.", + "Build was enqueued for longer than the value of `queue_ttl`." + ], + "readOnly": true, + "type": "string" + }, + "statusDetail": { + "description": "Output only. Customer-readable message about the current status.", + "readOnly": true, + "type": "string" + }, + "steps": { + "description": "Required. The operations to be performed on the workspace.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1BuildStep" + }, + "type": "array" + }, + "substitutions": { + "additionalProperties": { + "type": "string" + }, + "description": "Substitutions data for `Build` resource.", + "type": "object" + }, + "tags": { + "description": "Tags for annotation of a `Build`. These are not docker tags.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeout": { + "description": "Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes.", + "format": "google-duration", + "type": "string" + }, + "timing": { + "additionalProperties": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan" + }, + "description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.", + "readOnly": true, + "type": "object" + }, + "warnings": { + "description": "Output only. Non-fatal problems encountered during the execution of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Warning" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuildApproval": { + "description": "BuildApproval describes a build's approval configuration, state, and result.", + "id": "GoogleDevtoolsCloudbuildV1BuildApproval", + "properties": { + "config": { + "$ref": "GoogleDevtoolsCloudbuildV1ApprovalConfig", + "description": "Output only. Configuration for manual approval of this build.", + "readOnly": true + }, + "result": { + "$ref": "GoogleDevtoolsCloudbuildV1ApprovalResult", + "description": "Output only. Result of manual approval for this Build.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of this build's approval.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "APPROVED", + "REJECTED", + "CANCELLED" + ], + "enumDescriptions": [ + "Default enum type. This should not be used.", + "Build approval is pending.", + "Build approval has been approved.", + "Build approval has been rejected.", + "Build was cancelled while it was still pending approval." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuildOperationMetadata": { + "description": "Metadata for build operations.", + "id": "GoogleDevtoolsCloudbuildV1BuildOperationMetadata", + "properties": { + "build": { + "$ref": "GoogleDevtoolsCloudbuildV1Build", + "description": "The build that the operation is tracking." + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuildOptions": { + "description": "Optional arguments to enable specific features of builds.", + "id": "GoogleDevtoolsCloudbuildV1BuildOptions", + "properties": { + "automapSubstitutions": { + "description": "Option to include built-in and custom substitutions as env variables for all build steps.", + "type": "boolean" + }, + "defaultLogsBucketBehavior": { + "description": "Optional. Option to specify how default logs buckets are setup.", + "enum": [ + "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", + "REGIONAL_USER_OWNED_BUCKET" + ], + "enumDescriptions": [ + "Unspecified.", + "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project." + ], + "type": "string" + }, + "diskSizeGb": { + "description": "Requested disk size for the VM that runs the build. Note that this is *NOT* \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error.", + "format": "int64", + "type": "string" + }, + "dynamicSubstitutions": { + "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.", + "type": "boolean" + }, + "env": { + "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "logStreamingOption": { + "description": "Option to define build log streaming behavior to Cloud Storage.", + "enum": [ + "STREAM_DEFAULT", + "STREAM_ON", + "STREAM_OFF" + ], + "enumDescriptions": [ + "Service may automatically determine build log streaming behavior.", + "Build logs should be streamed to Cloud Storage.", + "Build logs should not be streamed to Cloud Storage; they will be written when the build is completed." + ], + "type": "string" + }, + "logging": { + "description": "Option to specify the logging mode, which determines if and where build logs are stored.", + "enum": [ + "LOGGING_UNSPECIFIED", + "LEGACY", + "GCS_ONLY", + "STACKDRIVER_ONLY", + "CLOUD_LOGGING_ONLY", + "NONE" + ], + "enumDeprecated": [ + false, + false, + false, + true, + false, + false + ], + "enumDescriptions": [ + "The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.", + "Build logs are stored in Cloud Logging and Cloud Storage.", + "Build logs are stored in Cloud Storage.", + "This option is the same as CLOUD_LOGGING_ONLY.", + "Build logs are stored in Cloud Logging. Selecting this option will not allow [logs streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).", + "Turn off all logging. No build logs will be captured." + ], + "type": "string" + }, + "machineType": { + "description": "Compute Engine machine type on which to run the build.", + "enum": [ + "UNSPECIFIED", + "N1_HIGHCPU_8", + "N1_HIGHCPU_32", + "E2_HIGHCPU_8", + "E2_HIGHCPU_32", + "E2_MEDIUM" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false + ], + "enumDescriptions": [ + "Standard machine type.", + "Highcpu machine with 8 CPUs.", + "Highcpu machine with 32 CPUs.", + "Highcpu e2 machine with 8 CPUs.", + "Highcpu e2 machine with 32 CPUs.", + "E2 machine with 1 CPU." + ], + "type": "string" + }, + "pool": { + "$ref": "GoogleDevtoolsCloudbuildV1PoolOption", + "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." + }, + "requestedVerifyOption": { + "description": "Requested verifiability options.", + "enum": [ + "NOT_VERIFIED", + "VERIFIED" + ], + "enumDescriptions": [ + "Not a verifiable build (the default).", + "Build must be verified." + ], + "type": "string" + }, + "secretEnv": { + "description": "A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceProvenanceHash": { + "description": "Requested hash for SourceProvenance.", + "items": { + "enum": [ + "NONE", + "SHA256", + "MD5", + "SHA512" + ], + "enumDescriptions": [ + "No hash requested.", + "Use a sha256 hash.", + "Use a md5 hash.", + "Use a sha512 hash." + ], + "type": "string" + }, + "type": "array" + }, + "substitutionOption": { + "description": "Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.", + "enum": [ + "MUST_MATCH", + "ALLOW_LOOSE" + ], + "enumDescriptions": [ + "Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.", + "Do not fail the build if error in substitutions checks." + ], + "type": "string" + }, + "volumes": { + "description": "Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Volume" + }, + "type": "array" + }, + "workerPool": { + "deprecated": true, + "description": "This field deprecated; please use `pool.name` instead.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuildStep": { + "description": "A step in the build pipeline.", + "id": "GoogleDevtoolsCloudbuildV1BuildStep", + "properties": { + "allowExitCodes": { + "description": "Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "allowFailure": { + "description": "Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.", + "type": "boolean" + }, + "args": { + "description": "A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.", + "items": { + "type": "string" + }, + "type": "array" + }, + "automapSubstitutions": { + "description": "Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.", + "type": "boolean" + }, + "dir": { + "description": "Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.", + "type": "string" + }, + "entrypoint": { + "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.", + "type": "string" + }, + "env": { + "description": "A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "exitCode": { + "description": "Output only. Return code from running the step.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "id": { + "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.", + "type": "string" + }, + "name": { + "description": "Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like \"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.", + "type": "string" + }, + "pullTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pulling this build step's builder image only.", + "readOnly": true + }, + "script": { + "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.", + "type": "string" + }, + "secretEnv": { + "description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.", + "enum": [ + "STATUS_UNKNOWN", + "PENDING", + "QUEUED", + "WORKING", + "SUCCESS", + "FAILURE", + "INTERNAL_ERROR", + "TIMEOUT", + "CANCELLED", + "EXPIRED" + ], + "enumDescriptions": [ + "Status of the build is unknown.", + "Build has been created and is pending execution and queuing. It has not been queued.", + "Build or step is queued; work has not yet begun.", + "Build or step is being executed.", + "Build or step finished successfully.", + "Build or step failed to complete successfully.", + "Build or step failed due to an internal cause.", + "Build or step took longer than was allowed.", + "Build or step was canceled by a user.", + "Build was enqueued for longer than the value of `queue_ttl`." + ], + "readOnly": true, + "type": "string" + }, + "timeout": { + "description": "Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.", + "format": "google-duration", + "type": "string" + }, + "timing": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for executing this build step.", + "readOnly": true + }, + "volumes": { + "description": "List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Volume" + }, + "type": "array" + }, + "waitFor": { + "description": "The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1BuiltImage": { + "description": "An image built by the pipeline.", + "id": "GoogleDevtoolsCloudbuildV1BuiltImage", + "properties": { + "digest": { + "description": "Docker Registry 2.0 digest.", + "type": "string" + }, + "name": { + "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`.", + "type": "string" + }, + "pushTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified image.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1ConnectedRepository": { + "description": "Location of the source in a 2nd-gen Google Cloud Build repository resource.", + "id": "GoogleDevtoolsCloudbuildV1ConnectedRepository", + "properties": { + "dir": { + "description": "Directory, relative to the source root, in which to run the build.", + "type": "string" + }, + "repository": { + "description": "Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.", + "type": "string" + }, + "revision": { + "description": "The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1FailureInfo": { + "description": "A fatal problem encountered during the execution of the build.", + "id": "GoogleDevtoolsCloudbuildV1FailureInfo", + "properties": { + "detail": { + "description": "Explains the failure issue in more detail using hard-coded text.", + "type": "string" + }, + "type": { + "description": "The name of the failure.", + "enum": [ + "FAILURE_TYPE_UNSPECIFIED", + "PUSH_FAILED", + "PUSH_IMAGE_NOT_FOUND", + "PUSH_NOT_AUTHORIZED", + "LOGGING_FAILURE", + "USER_BUILD_STEP", + "FETCH_SOURCE_FAILED" + ], + "enumDescriptions": [ + "Type unspecified", + "Unable to push the image to the repository.", + "Final image not found.", + "Unauthorized push of the final image.", + "Backend logging failures. Should retry.", + "A build step has failed.", + "The source fetching has failed." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1FileHashes": { + "description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.", + "id": "GoogleDevtoolsCloudbuildV1FileHashes", + "properties": { + "fileHash": { + "description": "Collection of file hashes.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Hash" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1GitSource": { + "description": "Location of the source in any accessible Git repository.", + "id": "GoogleDevtoolsCloudbuildV1GitSource", + "properties": { + "dir": { + "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.", + "type": "string" + }, + "revision": { + "description": "The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.", + "type": "string" + }, + "url": { + "description": "Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Hash": { + "description": "Container message for hash values.", + "id": "GoogleDevtoolsCloudbuildV1Hash", + "properties": { + "type": { + "description": "The type of hash that was performed.", + "enum": [ + "NONE", + "SHA256", + "MD5", + "SHA512" + ], + "enumDescriptions": [ + "No hash requested.", + "Use a sha256 hash.", + "Use a md5 hash.", + "Use a sha512 hash." + ], + "type": "string" + }, + "value": { + "description": "The hash value.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1InlineSecret": { + "description": "Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.", + "id": "GoogleDevtoolsCloudbuildV1InlineSecret", + "properties": { + "envMap": { + "additionalProperties": { + "format": "byte", + "type": "string" + }, + "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", + "type": "object" + }, + "kmsKeyName": { + "description": "Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1MavenArtifact": { + "description": "A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.", + "id": "GoogleDevtoolsCloudbuildV1MavenArtifact", + "properties": { + "artifactId": { + "description": "Maven `artifactId` value used when uploading the artifact to Artifact Registry.", + "type": "string" + }, + "groupId": { + "description": "Maven `groupId` value used when uploading the artifact to Artifact Registry.", + "type": "string" + }, + "path": { + "description": "Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", + "type": "string" + }, + "repository": { + "description": "Artifact Registry repository, in the form \"https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY\" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.", + "type": "string" + }, + "version": { + "description": "Maven `version` value used when uploading the artifact to Artifact Registry.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1NpmPackage": { + "description": "Npm package to upload to Artifact Registry upon successful completion of all build steps.", + "id": "GoogleDevtoolsCloudbuildV1NpmPackage", + "properties": { + "packagePath": { + "description": "Path to the package.json. e.g. workspace/path/to/package", + "type": "string" + }, + "repository": { + "description": "Artifact Registry repository, in the form \"https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY\" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1PoolOption": { + "description": "Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.", + "id": "GoogleDevtoolsCloudbuildV1PoolOption", + "properties": { + "name": { + "description": "The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1PythonPackage": { + "description": "Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.", + "id": "GoogleDevtoolsCloudbuildV1PythonPackage", + "properties": { + "paths": { + "description": "Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file.", + "items": { + "type": "string" + }, + "type": "array" + }, + "repository": { + "description": "Artifact Registry repository, in the form \"https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY\" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1RepoSource": { + "description": "Location of the source in a Google Cloud Source Repository.", + "id": "GoogleDevtoolsCloudbuildV1RepoSource", + "properties": { + "branchName": { + "description": "Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", + "type": "string" + }, + "commitSha": { + "description": "Explicit commit SHA to build.", + "type": "string" + }, + "dir": { + "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.", + "type": "string" + }, + "invertRegex": { + "description": "Only trigger a build if the revision regex does NOT match the revision regex.", + "type": "boolean" + }, + "projectId": { + "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", + "type": "string" + }, + "repoName": { + "description": "Name of the Cloud Source Repository.", + "type": "string" + }, + "substitutions": { + "additionalProperties": { + "type": "string" + }, + "description": "Substitutions to use in a triggered build. Should only be used with RunBuildTrigger", + "type": "object" + }, + "tagName": { + "description": "Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Results": { + "description": "Artifacts created by the build pipeline.", + "id": "GoogleDevtoolsCloudbuildV1Results", + "properties": { + "artifactManifest": { + "description": "Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", + "type": "string" + }, + "artifactTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Time to push all non-container artifacts to Cloud Storage." + }, + "buildStepImages": { + "description": "List of build step digests, in the order corresponding to build step indices.", + "items": { + "type": "string" + }, + "type": "array" + }, + "buildStepOutputs": { + "description": "List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored.", + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "images": { + "description": "Container images that were built as a part of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1BuiltImage" + }, + "type": "array" + }, + "mavenArtifacts": { + "description": "Maven artifacts uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact" + }, + "type": "array" + }, + "npmPackages": { + "description": "Npm packages uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1UploadedNpmPackage" + }, + "type": "array" + }, + "numArtifacts": { + "description": "Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", + "format": "int64", + "type": "string" + }, + "pythonPackages": { + "description": "Python artifacts uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1UploadedPythonPackage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Secret": { + "description": "Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.", + "id": "GoogleDevtoolsCloudbuildV1Secret", + "properties": { + "kmsKeyName": { + "description": "Cloud KMS key name to use to decrypt these envs.", + "type": "string" + }, + "secretEnv": { + "additionalProperties": { + "format": "byte", + "type": "string" + }, + "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1SecretManagerSecret": { + "description": "Pairs a secret environment variable with a SecretVersion in Secret Manager.", + "id": "GoogleDevtoolsCloudbuildV1SecretManagerSecret", + "properties": { + "env": { + "description": "Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.", + "type": "string" + }, + "versionName": { + "description": "Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Secrets": { + "description": "Secrets and secret environment variables.", + "id": "GoogleDevtoolsCloudbuildV1Secrets", + "properties": { + "inline": { + "description": "Secrets encrypted with KMS key and the associated secret environment variable.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1InlineSecret" + }, + "type": "array" + }, + "secretManager": { + "description": "Secrets in Secret Manager and associated secret environment variable.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1SecretManagerSecret" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Source": { + "description": "Location of the source in a supported storage service.", + "id": "GoogleDevtoolsCloudbuildV1Source", + "properties": { + "connectedRepository": { + "$ref": "GoogleDevtoolsCloudbuildV1ConnectedRepository", + "description": "Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource." + }, + "gitSource": { + "$ref": "GoogleDevtoolsCloudbuildV1GitSource", + "description": "If provided, get the source from this Git repository." + }, + "repoSource": { + "$ref": "GoogleDevtoolsCloudbuildV1RepoSource", + "description": "If provided, get the source from this location in a Cloud Source Repository." + }, + "storageSource": { + "$ref": "GoogleDevtoolsCloudbuildV1StorageSource", + "description": "If provided, get the source from this location in Cloud Storage." + }, + "storageSourceManifest": { + "$ref": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", + "description": "If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher)." + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1SourceProvenance": { + "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.", + "id": "GoogleDevtoolsCloudbuildV1SourceProvenance", + "properties": { + "fileHashes": { + "additionalProperties": { + "$ref": "GoogleDevtoolsCloudbuildV1FileHashes" + }, + "description": "Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.", + "readOnly": true, + "type": "object" + }, + "resolvedConnectedRepository": { + "$ref": "GoogleDevtoolsCloudbuildV1ConnectedRepository", + "description": "Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.", + "readOnly": true + }, + "resolvedGitSource": { + "$ref": "GoogleDevtoolsCloudbuildV1GitSource", + "description": "Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.", + "readOnly": true + }, + "resolvedRepoSource": { + "$ref": "GoogleDevtoolsCloudbuildV1RepoSource", + "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved." + }, + "resolvedStorageSource": { + "$ref": "GoogleDevtoolsCloudbuildV1StorageSource", + "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved." + }, + "resolvedStorageSourceManifest": { + "$ref": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", + "description": "A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview." + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1StorageSource": { + "description": "Location of the source in an archive file in Cloud Storage.", + "id": "GoogleDevtoolsCloudbuildV1StorageSource", + "properties": { + "bucket": { + "description": "Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "type": "string" + }, + "generation": { + "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", + "format": "int64", + "type": "string" + }, + "object": { + "description": "Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", + "type": "string" + }, + "sourceFetcher": { + "description": "Optional. Option to specify the tool to fetch the source file for the build.", + "enum": [ + "SOURCE_FETCHER_UNSPECIFIED", + "GSUTIL", + "GCS_FETCHER" + ], + "enumDescriptions": [ + "Unspecified defaults to GSUTIL.", + "Use the \"gsutil\" tool to download the source file.", + "Use the Cloud Storage Fetcher tool to download the source file." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1StorageSourceManifest": { + "description": "Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).", + "id": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", + "properties": { + "bucket": { + "description": "Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "type": "string" + }, + "generation": { + "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", + "format": "int64", + "type": "string" + }, + "object": { + "description": "Cloud Storage object containing the source manifest. This object must be a JSON file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1TimeSpan": { + "description": "Start and end times for a build execution phase.", + "id": "GoogleDevtoolsCloudbuildV1TimeSpan", + "properties": { + "endTime": { + "description": "End of time span.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Start of time span.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact": { + "description": "A Maven artifact uploaded using the MavenArtifact directive.", + "id": "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact", + "properties": { + "fileHashes": { + "$ref": "GoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the Maven Artifact." + }, + "pushTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded artifact.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1UploadedNpmPackage": { + "description": "An npm package uploaded to Artifact Registry using the NpmPackage directive.", + "id": "GoogleDevtoolsCloudbuildV1UploadedNpmPackage", + "properties": { + "fileHashes": { + "$ref": "GoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the npm package." + }, + "pushTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded npm package.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1UploadedPythonPackage": { + "description": "Artifact uploaded using the PythonPackage directive.", + "id": "GoogleDevtoolsCloudbuildV1UploadedPythonPackage", + "properties": { + "fileHashes": { + "$ref": "GoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the Python Artifact." + }, + "pushTiming": { + "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded artifact.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Volume": { + "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.", + "id": "GoogleDevtoolsCloudbuildV1Volume", + "properties": { + "name": { + "description": "Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.", + "type": "string" + }, + "path": { + "description": "Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1Warning": { + "description": "A non-fatal problem encountered during the execution of the build.", + "id": "GoogleDevtoolsCloudbuildV1Warning", + "properties": { + "priority": { + "description": "The priority for this warning.", + "enum": [ + "PRIORITY_UNSPECIFIED", + "INFO", + "WARNING", + "ALERT" + ], + "enumDescriptions": [ + "Should not be used.", + "e.g. deprecation warnings and alternative feature highlights.", + "e.g. automated detection of possible issues with the build.", + "e.g. alerts that a feature used in the build is pending removal" + ], + "type": "string" + }, + "text": { + "description": "Explanation of the warning generated.", + "type": "string" + } + }, + "type": "object" + }, "GoogleIamV1AuditConfig": { "description": "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.", "id": "GoogleIamV1AuditConfig", diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 9f26f39d34f..7a03b9211dd 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -741,6 +741,831 @@ export namespace run_v1 { */ type?: string | null; } + /** + * ApprovalConfig describes configuration for manual approval of a build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1ApprovalConfig { + /** + * Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start. + */ + approvalRequired?: boolean | null; + } + /** + * ApprovalResult describes the decision and associated metadata of a manual approval of a build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1ApprovalResult { + /** + * Output only. The time when the approval decision was made. + */ + approvalTime?: string | null; + /** + * Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called. + */ + approverAccount?: string | null; + /** + * Optional. An optional comment for this manual approval result. + */ + comment?: string | null; + /** + * Required. The decision of this manual approval. + */ + decision?: string | null; + /** + * Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build. + */ + url?: string | null; + } + /** + * Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1ArtifactObjects { + /** + * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. + */ + location?: string | null; + /** + * Path globs used to match files in the build's workspace. + */ + paths?: string[] | null; + /** + * Output only. Stores timing information for pushing all artifact objects. + */ + timing?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + } + /** + * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Artifacts { + /** + * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. + */ + images?: string[] | null; + /** + * A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE. + */ + mavenArtifacts?: Schema$GoogleDevtoolsCloudbuildV1MavenArtifact[]; + /** + * A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. + */ + npmPackages?: Schema$GoogleDevtoolsCloudbuildV1NpmPackage[]; + /** + * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. + */ + objects?: Schema$GoogleDevtoolsCloudbuildV1ArtifactObjects; + /** + * A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. + */ + pythonPackages?: Schema$GoogleDevtoolsCloudbuildV1PythonPackage[]; + } + /** + * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Build { + /** + * Output only. Describes this build's approval configuration, status, and result. + */ + approval?: Schema$GoogleDevtoolsCloudbuildV1BuildApproval; + /** + * Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + */ + artifacts?: Schema$GoogleDevtoolsCloudbuildV1Artifacts; + /** + * Secrets and secret environment variables. + */ + availableSecrets?: Schema$GoogleDevtoolsCloudbuildV1Secrets; + /** + * Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. + */ + buildTriggerId?: string | null; + /** + * Output only. Time at which the request to create the build was received. + */ + createTime?: string | null; + /** + * Output only. Contains information about the build when status=FAILURE. + */ + failureInfo?: Schema$GoogleDevtoolsCloudbuildV1FailureInfo; + /** + * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. + */ + finishTime?: string | null; + /** + * Output only. Unique identifier of the build. + */ + id?: string | null; + /** + * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. + */ + images?: string[] | null; + /** + * Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket\}/log-${build_id\}.txt`. + */ + logsBucket?: string | null; + /** + * Output only. URL to logs for this build in Google Cloud Console. + */ + logUrl?: string | null; + /** + * Output only. The 'Build' name with format: `projects/{project\}/locations/{location\}/builds/{build\}`, where {build\} is a unique identifier generated by the service. + */ + name?: string | null; + /** + * Special options for this build. + */ + options?: Schema$GoogleDevtoolsCloudbuildV1BuildOptions; + /** + * Output only. ID of the project. + */ + projectId?: string | null; + /** + * TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. + */ + queueTtl?: string | null; + /** + * Output only. Results of the build. + */ + results?: Schema$GoogleDevtoolsCloudbuildV1Results; + /** + * Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets + */ + secrets?: Schema$GoogleDevtoolsCloudbuildV1Secret[]; + /** + * IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT\}`. ACCOUNT can be email address or uniqueId of the service account. + */ + serviceAccount?: string | null; + /** + * The location of the source files to build. + */ + source?: Schema$GoogleDevtoolsCloudbuildV1Source; + /** + * Output only. A permanent fixed identifier for source. + */ + sourceProvenance?: Schema$GoogleDevtoolsCloudbuildV1SourceProvenance; + /** + * Output only. Time at which execution of the build was started. + */ + startTime?: string | null; + /** + * Output only. Status of the build. + */ + status?: string | null; + /** + * Output only. Customer-readable message about the current status. + */ + statusDetail?: string | null; + /** + * Required. The operations to be performed on the workspace. + */ + steps?: Schema$GoogleDevtoolsCloudbuildV1BuildStep[]; + /** + * Substitutions data for `Build` resource. + */ + substitutions?: {[key: string]: string} | null; + /** + * Tags for annotation of a `Build`. These are not docker tags. + */ + tags?: string[] | null; + /** + * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes. + */ + timeout?: string | null; + /** + * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included. + */ + timing?: {[key: string]: Schema$GoogleDevtoolsCloudbuildV1TimeSpan} | null; + /** + * Output only. Non-fatal problems encountered during the execution of the build. + */ + warnings?: Schema$GoogleDevtoolsCloudbuildV1Warning[]; + } + /** + * BuildApproval describes a build's approval configuration, state, and result. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuildApproval { + /** + * Output only. Configuration for manual approval of this build. + */ + config?: Schema$GoogleDevtoolsCloudbuildV1ApprovalConfig; + /** + * Output only. Result of manual approval for this Build. + */ + result?: Schema$GoogleDevtoolsCloudbuildV1ApprovalResult; + /** + * Output only. The state of this build's approval. + */ + state?: string | null; + } + /** + * Metadata for build operations. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuildOperationMetadata { + /** + * The build that the operation is tracking. + */ + build?: Schema$GoogleDevtoolsCloudbuildV1Build; + } + /** + * Optional arguments to enable specific features of builds. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuildOptions { + /** + * Option to include built-in and custom substitutions as env variables for all build steps. + */ + automapSubstitutions?: boolean | null; + /** + * Optional. Option to specify how default logs buckets are setup. + */ + defaultLogsBucketBehavior?: string | null; + /** + * Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error. + */ + diskSizeGb?: string | null; + /** + * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + */ + dynamicSubstitutions?: boolean | null; + /** + * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + */ + env?: string[] | null; + /** + * Option to specify the logging mode, which determines if and where build logs are stored. + */ + logging?: string | null; + /** + * Option to define build log streaming behavior to Cloud Storage. + */ + logStreamingOption?: string | null; + /** + * Compute Engine machine type on which to run the build. + */ + machineType?: string | null; + /** + * Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. + */ + pool?: Schema$GoogleDevtoolsCloudbuildV1PoolOption; + /** + * Requested verifiability options. + */ + requestedVerifyOption?: string | null; + /** + * A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. + */ + secretEnv?: string[] | null; + /** + * Requested hash for SourceProvenance. + */ + sourceProvenanceHash?: string[] | null; + /** + * Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. + */ + substitutionOption?: string | null; + /** + * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. + */ + volumes?: Schema$GoogleDevtoolsCloudbuildV1Volume[]; + /** + * This field deprecated; please use `pool.name` instead. + */ + workerPool?: string | null; + } + /** + * A step in the build pipeline. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuildStep { + /** + * Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence. + */ + allowExitCodes?: number[] | null; + /** + * Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field. + */ + allowFailure?: boolean | null; + /** + * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. + */ + args?: string[] | null; + /** + * Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption. + */ + automapSubstitutions?: boolean | null; + /** + * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. + */ + dir?: string | null; + /** + * Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. + */ + entrypoint?: string | null; + /** + * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + */ + env?: string[] | null; + /** + * Output only. Return code from running the step. + */ + exitCode?: number | null; + /** + * Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. + */ + id?: string | null; + /** + * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. + */ + name?: string | null; + /** + * Output only. Stores timing information for pulling this build step's builder image only. + */ + pullTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. + */ + script?: string | null; + /** + * A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. + */ + secretEnv?: string[] | null; + /** + * Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. + */ + status?: string | null; + /** + * Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. + */ + timeout?: string | null; + /** + * Output only. Stores timing information for executing this build step. + */ + timing?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. + */ + volumes?: Schema$GoogleDevtoolsCloudbuildV1Volume[]; + /** + * The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. + */ + waitFor?: string[] | null; + } + /** + * An image built by the pipeline. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuiltImage { + /** + * Docker Registry 2.0 digest. + */ + digest?: string | null; + /** + * Name used to push the container image to Google Container Registry, as presented to `docker push`. + */ + name?: string | null; + /** + * Output only. Stores timing information for pushing the specified image. + */ + pushTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + } + /** + * Location of the source in a 2nd-gen Google Cloud Build repository resource. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1ConnectedRepository { + /** + * Directory, relative to the source root, in which to run the build. + */ + dir?: string | null; + /** + * Required. Name of the Google Cloud Build repository, formatted as `projects/x/locations/x/connections/x/repositories/x`. + */ + repository?: string | null; + /** + * The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. + */ + revision?: string | null; + } + /** + * A fatal problem encountered during the execution of the build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1FailureInfo { + /** + * Explains the failure issue in more detail using hard-coded text. + */ + detail?: string | null; + /** + * The name of the failure. + */ + type?: string | null; + } + /** + * Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1FileHashes { + /** + * Collection of file hashes. + */ + fileHash?: Schema$GoogleDevtoolsCloudbuildV1Hash[]; + } + /** + * Location of the source in any accessible Git repository. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1GitSource { + /** + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + */ + dir?: string | null; + /** + * The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch. + */ + revision?: string | null; + /** + * Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote. + */ + url?: string | null; + } + /** + * Container message for hash values. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Hash { + /** + * The type of hash that was performed. + */ + type?: string | null; + /** + * The hash value. + */ + value?: string | null; + } + /** + * Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1InlineSecret { + /** + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + */ + envMap?: {[key: string]: string} | null; + /** + * Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/x/locations/x/keyRings/x/cryptoKeys/x + */ + kmsKeyName?: string | null; + } + /** + * A Maven artifact to upload to Artifact Registry upon successful completion of all build steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1MavenArtifact { + /** + * Maven `artifactId` value used when uploading the artifact to Artifact Registry. + */ + artifactId?: string | null; + /** + * Maven `groupId` value used when uploading the artifact to Artifact Registry. + */ + groupId?: string | null; + /** + * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + */ + path?: string | null; + /** + * Artifact Registry repository, in the form "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix. + */ + repository?: string | null; + /** + * Maven `version` value used when uploading the artifact to Artifact Registry. + */ + version?: string | null; + } + /** + * Npm package to upload to Artifact Registry upon successful completion of all build steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1NpmPackage { + /** + * Path to the package.json. e.g. workspace/path/to/package + */ + packagePath?: string | null; + /** + * Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. + */ + repository?: string | null; + } + /** + * Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1PoolOption { + /** + * The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project\}/locations/{location\}/workerPools/{workerPoolId\} + */ + name?: string | null; + } + /** + * Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1PythonPackage { + /** + * Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/x`, and sometimes additionally an `.asc` file. + */ + paths?: string[] | null; + /** + * Artifact Registry repository, in the form "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix. + */ + repository?: string | null; + } + /** + * Location of the source in a Google Cloud Source Repository. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1RepoSource { + /** + * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + */ + branchName?: string | null; + /** + * Explicit commit SHA to build. + */ + commitSha?: string | null; + /** + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + */ + dir?: string | null; + /** + * Only trigger a build if the revision regex does NOT match the revision regex. + */ + invertRegex?: boolean | null; + /** + * ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. + */ + projectId?: string | null; + /** + * Name of the Cloud Source Repository. + */ + repoName?: string | null; + /** + * Substitutions to use in a triggered build. Should only be used with RunBuildTrigger + */ + substitutions?: {[key: string]: string} | null; + /** + * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + */ + tagName?: string | null; + } + /** + * Artifacts created by the build pipeline. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Results { + /** + * Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage. + */ + artifactManifest?: string | null; + /** + * Time to push all non-container artifacts to Cloud Storage. + */ + artifactTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * List of build step digests, in the order corresponding to build step indices. + */ + buildStepImages?: string[] | null; + /** + * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. + */ + buildStepOutputs?: string[] | null; + /** + * Container images that were built as a part of the build. + */ + images?: Schema$GoogleDevtoolsCloudbuildV1BuiltImage[]; + /** + * Maven artifacts uploaded to Artifact Registry at the end of the build. + */ + mavenArtifacts?: Schema$GoogleDevtoolsCloudbuildV1UploadedMavenArtifact[]; + /** + * Npm packages uploaded to Artifact Registry at the end of the build. + */ + npmPackages?: Schema$GoogleDevtoolsCloudbuildV1UploadedNpmPackage[]; + /** + * Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage. + */ + numArtifacts?: string | null; + /** + * Python artifacts uploaded to Artifact Registry at the end of the build. + */ + pythonPackages?: Schema$GoogleDevtoolsCloudbuildV1UploadedPythonPackage[]; + } + /** + * Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Secret { + /** + * Cloud KMS key name to use to decrypt these envs. + */ + kmsKeyName?: string | null; + /** + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + */ + secretEnv?: {[key: string]: string} | null; + } + /** + * Pairs a secret environment variable with a SecretVersion in Secret Manager. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1SecretManagerSecret { + /** + * Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. + */ + env?: string | null; + /** + * Resource name of the SecretVersion. In format: projects/x/secrets/x/versions/x + */ + versionName?: string | null; + } + /** + * Secrets and secret environment variables. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Secrets { + /** + * Secrets encrypted with KMS key and the associated secret environment variable. + */ + inline?: Schema$GoogleDevtoolsCloudbuildV1InlineSecret[]; + /** + * Secrets in Secret Manager and associated secret environment variable. + */ + secretManager?: Schema$GoogleDevtoolsCloudbuildV1SecretManagerSecret[]; + } + /** + * Location of the source in a supported storage service. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Source { + /** + * Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource. + */ + connectedRepository?: Schema$GoogleDevtoolsCloudbuildV1ConnectedRepository; + /** + * If provided, get the source from this Git repository. + */ + gitSource?: Schema$GoogleDevtoolsCloudbuildV1GitSource; + /** + * If provided, get the source from this location in a Cloud Source Repository. + */ + repoSource?: Schema$GoogleDevtoolsCloudbuildV1RepoSource; + /** + * If provided, get the source from this location in Cloud Storage. + */ + storageSource?: Schema$GoogleDevtoolsCloudbuildV1StorageSource; + /** + * If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + */ + storageSourceManifest?: Schema$GoogleDevtoolsCloudbuildV1StorageSourceManifest; + } + /** + * Provenance of the source. Ways to find the original source, or verify that some source was used for this build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1SourceProvenance { + /** + * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. + */ + fileHashes?: { + [key: string]: Schema$GoogleDevtoolsCloudbuildV1FileHashes; + } | null; + /** + * Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved. + */ + resolvedConnectedRepository?: Schema$GoogleDevtoolsCloudbuildV1ConnectedRepository; + /** + * Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved. + */ + resolvedGitSource?: Schema$GoogleDevtoolsCloudbuildV1GitSource; + /** + * A copy of the build's `source.repo_source`, if exists, with any revisions resolved. + */ + resolvedRepoSource?: Schema$GoogleDevtoolsCloudbuildV1RepoSource; + /** + * A copy of the build's `source.storage_source`, if exists, with any generations resolved. + */ + resolvedStorageSource?: Schema$GoogleDevtoolsCloudbuildV1StorageSource; + /** + * A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview. + */ + resolvedStorageSourceManifest?: Schema$GoogleDevtoolsCloudbuildV1StorageSourceManifest; + } + /** + * Location of the source in an archive file in Cloud Storage. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1StorageSource { + /** + * Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + */ + bucket?: string | null; + /** + * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. + */ + generation?: string | null; + /** + * Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build. + */ + object?: string | null; + /** + * Optional. Option to specify the tool to fetch the source file for the build. + */ + sourceFetcher?: string | null; + } + /** + * Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + */ + export interface Schema$GoogleDevtoolsCloudbuildV1StorageSourceManifest { + /** + * Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + */ + bucket?: string | null; + /** + * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. + */ + generation?: string | null; + /** + * Cloud Storage object containing the source manifest. This object must be a JSON file. + */ + object?: string | null; + } + /** + * Start and end times for a build execution phase. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1TimeSpan { + /** + * End of time span. + */ + endTime?: string | null; + /** + * Start of time span. + */ + startTime?: string | null; + } + /** + * A Maven artifact uploaded using the MavenArtifact directive. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1UploadedMavenArtifact { + /** + * Hash types and values of the Maven Artifact. + */ + fileHashes?: Schema$GoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded artifact. + */ + uri?: string | null; + } + /** + * An npm package uploaded to Artifact Registry using the NpmPackage directive. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1UploadedNpmPackage { + /** + * Hash types and values of the npm package. + */ + fileHashes?: Schema$GoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded npm package. + */ + uri?: string | null; + } + /** + * Artifact uploaded using the PythonPackage directive. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1UploadedPythonPackage { + /** + * Hash types and values of the Python Artifact. + */ + fileHashes?: Schema$GoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded artifact. + */ + uri?: string | null; + } + /** + * Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Volume { + /** + * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. + */ + name?: string | null; + /** + * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. + */ + path?: string | null; + } + /** + * A non-fatal problem encountered during the execution of the build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Warning { + /** + * The priority for this warning. + */ + priority?: string | null; + /** + * Explanation of the warning generated. + */ + text?: string | null; + } /** * The response message for Operations.ListOperations. */ diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 9ac247b8646..9ad9d7d5773 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -1193,7 +1193,7 @@ export namespace run_v2 { */ export interface Schema$GoogleCloudRunV2ServiceScaling { /** - * total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. (ALPHA) + * total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. (BETA) */ minInstanceCount?: number | null; } @@ -1507,6 +1507,831 @@ export namespace run_v2 { */ networkInterfaces?: Schema$GoogleCloudRunV2NetworkInterface[]; } + /** + * ApprovalConfig describes configuration for manual approval of a build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1ApprovalConfig { + /** + * Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start. + */ + approvalRequired?: boolean | null; + } + /** + * ApprovalResult describes the decision and associated metadata of a manual approval of a build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1ApprovalResult { + /** + * Output only. The time when the approval decision was made. + */ + approvalTime?: string | null; + /** + * Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called. + */ + approverAccount?: string | null; + /** + * Optional. An optional comment for this manual approval result. + */ + comment?: string | null; + /** + * Required. The decision of this manual approval. + */ + decision?: string | null; + /** + * Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build. + */ + url?: string | null; + } + /** + * Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1ArtifactObjects { + /** + * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. + */ + location?: string | null; + /** + * Path globs used to match files in the build's workspace. + */ + paths?: string[] | null; + /** + * Output only. Stores timing information for pushing all artifact objects. + */ + timing?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + } + /** + * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Artifacts { + /** + * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. + */ + images?: string[] | null; + /** + * A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE. + */ + mavenArtifacts?: Schema$GoogleDevtoolsCloudbuildV1MavenArtifact[]; + /** + * A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. + */ + npmPackages?: Schema$GoogleDevtoolsCloudbuildV1NpmPackage[]; + /** + * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. + */ + objects?: Schema$GoogleDevtoolsCloudbuildV1ArtifactObjects; + /** + * A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. + */ + pythonPackages?: Schema$GoogleDevtoolsCloudbuildV1PythonPackage[]; + } + /** + * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Build { + /** + * Output only. Describes this build's approval configuration, status, and result. + */ + approval?: Schema$GoogleDevtoolsCloudbuildV1BuildApproval; + /** + * Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + */ + artifacts?: Schema$GoogleDevtoolsCloudbuildV1Artifacts; + /** + * Secrets and secret environment variables. + */ + availableSecrets?: Schema$GoogleDevtoolsCloudbuildV1Secrets; + /** + * Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. + */ + buildTriggerId?: string | null; + /** + * Output only. Time at which the request to create the build was received. + */ + createTime?: string | null; + /** + * Output only. Contains information about the build when status=FAILURE. + */ + failureInfo?: Schema$GoogleDevtoolsCloudbuildV1FailureInfo; + /** + * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. + */ + finishTime?: string | null; + /** + * Output only. Unique identifier of the build. + */ + id?: string | null; + /** + * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. + */ + images?: string[] | null; + /** + * Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket\}/log-${build_id\}.txt`. + */ + logsBucket?: string | null; + /** + * Output only. URL to logs for this build in Google Cloud Console. + */ + logUrl?: string | null; + /** + * Output only. The 'Build' name with format: `projects/{project\}/locations/{location\}/builds/{build\}`, where {build\} is a unique identifier generated by the service. + */ + name?: string | null; + /** + * Special options for this build. + */ + options?: Schema$GoogleDevtoolsCloudbuildV1BuildOptions; + /** + * Output only. ID of the project. + */ + projectId?: string | null; + /** + * TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. + */ + queueTtl?: string | null; + /** + * Output only. Results of the build. + */ + results?: Schema$GoogleDevtoolsCloudbuildV1Results; + /** + * Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets + */ + secrets?: Schema$GoogleDevtoolsCloudbuildV1Secret[]; + /** + * IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT\}`. ACCOUNT can be email address or uniqueId of the service account. + */ + serviceAccount?: string | null; + /** + * The location of the source files to build. + */ + source?: Schema$GoogleDevtoolsCloudbuildV1Source; + /** + * Output only. A permanent fixed identifier for source. + */ + sourceProvenance?: Schema$GoogleDevtoolsCloudbuildV1SourceProvenance; + /** + * Output only. Time at which execution of the build was started. + */ + startTime?: string | null; + /** + * Output only. Status of the build. + */ + status?: string | null; + /** + * Output only. Customer-readable message about the current status. + */ + statusDetail?: string | null; + /** + * Required. The operations to be performed on the workspace. + */ + steps?: Schema$GoogleDevtoolsCloudbuildV1BuildStep[]; + /** + * Substitutions data for `Build` resource. + */ + substitutions?: {[key: string]: string} | null; + /** + * Tags for annotation of a `Build`. These are not docker tags. + */ + tags?: string[] | null; + /** + * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes. + */ + timeout?: string | null; + /** + * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included. + */ + timing?: {[key: string]: Schema$GoogleDevtoolsCloudbuildV1TimeSpan} | null; + /** + * Output only. Non-fatal problems encountered during the execution of the build. + */ + warnings?: Schema$GoogleDevtoolsCloudbuildV1Warning[]; + } + /** + * BuildApproval describes a build's approval configuration, state, and result. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuildApproval { + /** + * Output only. Configuration for manual approval of this build. + */ + config?: Schema$GoogleDevtoolsCloudbuildV1ApprovalConfig; + /** + * Output only. Result of manual approval for this Build. + */ + result?: Schema$GoogleDevtoolsCloudbuildV1ApprovalResult; + /** + * Output only. The state of this build's approval. + */ + state?: string | null; + } + /** + * Metadata for build operations. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuildOperationMetadata { + /** + * The build that the operation is tracking. + */ + build?: Schema$GoogleDevtoolsCloudbuildV1Build; + } + /** + * Optional arguments to enable specific features of builds. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuildOptions { + /** + * Option to include built-in and custom substitutions as env variables for all build steps. + */ + automapSubstitutions?: boolean | null; + /** + * Optional. Option to specify how default logs buckets are setup. + */ + defaultLogsBucketBehavior?: string | null; + /** + * Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error. + */ + diskSizeGb?: string | null; + /** + * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + */ + dynamicSubstitutions?: boolean | null; + /** + * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + */ + env?: string[] | null; + /** + * Option to specify the logging mode, which determines if and where build logs are stored. + */ + logging?: string | null; + /** + * Option to define build log streaming behavior to Cloud Storage. + */ + logStreamingOption?: string | null; + /** + * Compute Engine machine type on which to run the build. + */ + machineType?: string | null; + /** + * Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. + */ + pool?: Schema$GoogleDevtoolsCloudbuildV1PoolOption; + /** + * Requested verifiability options. + */ + requestedVerifyOption?: string | null; + /** + * A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. + */ + secretEnv?: string[] | null; + /** + * Requested hash for SourceProvenance. + */ + sourceProvenanceHash?: string[] | null; + /** + * Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. + */ + substitutionOption?: string | null; + /** + * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. + */ + volumes?: Schema$GoogleDevtoolsCloudbuildV1Volume[]; + /** + * This field deprecated; please use `pool.name` instead. + */ + workerPool?: string | null; + } + /** + * A step in the build pipeline. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuildStep { + /** + * Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence. + */ + allowExitCodes?: number[] | null; + /** + * Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field. + */ + allowFailure?: boolean | null; + /** + * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. + */ + args?: string[] | null; + /** + * Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption. + */ + automapSubstitutions?: boolean | null; + /** + * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. + */ + dir?: string | null; + /** + * Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. + */ + entrypoint?: string | null; + /** + * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + */ + env?: string[] | null; + /** + * Output only. Return code from running the step. + */ + exitCode?: number | null; + /** + * Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. + */ + id?: string | null; + /** + * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. + */ + name?: string | null; + /** + * Output only. Stores timing information for pulling this build step's builder image only. + */ + pullTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. + */ + script?: string | null; + /** + * A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. + */ + secretEnv?: string[] | null; + /** + * Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. + */ + status?: string | null; + /** + * Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. + */ + timeout?: string | null; + /** + * Output only. Stores timing information for executing this build step. + */ + timing?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. + */ + volumes?: Schema$GoogleDevtoolsCloudbuildV1Volume[]; + /** + * The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. + */ + waitFor?: string[] | null; + } + /** + * An image built by the pipeline. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1BuiltImage { + /** + * Docker Registry 2.0 digest. + */ + digest?: string | null; + /** + * Name used to push the container image to Google Container Registry, as presented to `docker push`. + */ + name?: string | null; + /** + * Output only. Stores timing information for pushing the specified image. + */ + pushTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + } + /** + * Location of the source in a 2nd-gen Google Cloud Build repository resource. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1ConnectedRepository { + /** + * Directory, relative to the source root, in which to run the build. + */ + dir?: string | null; + /** + * Required. Name of the Google Cloud Build repository, formatted as `projects/x/locations/x/connections/x/repositories/x`. + */ + repository?: string | null; + /** + * The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. + */ + revision?: string | null; + } + /** + * A fatal problem encountered during the execution of the build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1FailureInfo { + /** + * Explains the failure issue in more detail using hard-coded text. + */ + detail?: string | null; + /** + * The name of the failure. + */ + type?: string | null; + } + /** + * Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1FileHashes { + /** + * Collection of file hashes. + */ + fileHash?: Schema$GoogleDevtoolsCloudbuildV1Hash[]; + } + /** + * Location of the source in any accessible Git repository. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1GitSource { + /** + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + */ + dir?: string | null; + /** + * The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch. + */ + revision?: string | null; + /** + * Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote. + */ + url?: string | null; + } + /** + * Container message for hash values. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Hash { + /** + * The type of hash that was performed. + */ + type?: string | null; + /** + * The hash value. + */ + value?: string | null; + } + /** + * Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1InlineSecret { + /** + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + */ + envMap?: {[key: string]: string} | null; + /** + * Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/x/locations/x/keyRings/x/cryptoKeys/x + */ + kmsKeyName?: string | null; + } + /** + * A Maven artifact to upload to Artifact Registry upon successful completion of all build steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1MavenArtifact { + /** + * Maven `artifactId` value used when uploading the artifact to Artifact Registry. + */ + artifactId?: string | null; + /** + * Maven `groupId` value used when uploading the artifact to Artifact Registry. + */ + groupId?: string | null; + /** + * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + */ + path?: string | null; + /** + * Artifact Registry repository, in the form "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix. + */ + repository?: string | null; + /** + * Maven `version` value used when uploading the artifact to Artifact Registry. + */ + version?: string | null; + } + /** + * Npm package to upload to Artifact Registry upon successful completion of all build steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1NpmPackage { + /** + * Path to the package.json. e.g. workspace/path/to/package + */ + packagePath?: string | null; + /** + * Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. + */ + repository?: string | null; + } + /** + * Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1PoolOption { + /** + * The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project\}/locations/{location\}/workerPools/{workerPoolId\} + */ + name?: string | null; + } + /** + * Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1PythonPackage { + /** + * Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/x`, and sometimes additionally an `.asc` file. + */ + paths?: string[] | null; + /** + * Artifact Registry repository, in the form "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix. + */ + repository?: string | null; + } + /** + * Location of the source in a Google Cloud Source Repository. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1RepoSource { + /** + * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + */ + branchName?: string | null; + /** + * Explicit commit SHA to build. + */ + commitSha?: string | null; + /** + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + */ + dir?: string | null; + /** + * Only trigger a build if the revision regex does NOT match the revision regex. + */ + invertRegex?: boolean | null; + /** + * ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. + */ + projectId?: string | null; + /** + * Name of the Cloud Source Repository. + */ + repoName?: string | null; + /** + * Substitutions to use in a triggered build. Should only be used with RunBuildTrigger + */ + substitutions?: {[key: string]: string} | null; + /** + * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + */ + tagName?: string | null; + } + /** + * Artifacts created by the build pipeline. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Results { + /** + * Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage. + */ + artifactManifest?: string | null; + /** + * Time to push all non-container artifacts to Cloud Storage. + */ + artifactTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * List of build step digests, in the order corresponding to build step indices. + */ + buildStepImages?: string[] | null; + /** + * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. + */ + buildStepOutputs?: string[] | null; + /** + * Container images that were built as a part of the build. + */ + images?: Schema$GoogleDevtoolsCloudbuildV1BuiltImage[]; + /** + * Maven artifacts uploaded to Artifact Registry at the end of the build. + */ + mavenArtifacts?: Schema$GoogleDevtoolsCloudbuildV1UploadedMavenArtifact[]; + /** + * Npm packages uploaded to Artifact Registry at the end of the build. + */ + npmPackages?: Schema$GoogleDevtoolsCloudbuildV1UploadedNpmPackage[]; + /** + * Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage. + */ + numArtifacts?: string | null; + /** + * Python artifacts uploaded to Artifact Registry at the end of the build. + */ + pythonPackages?: Schema$GoogleDevtoolsCloudbuildV1UploadedPythonPackage[]; + } + /** + * Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Secret { + /** + * Cloud KMS key name to use to decrypt these envs. + */ + kmsKeyName?: string | null; + /** + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + */ + secretEnv?: {[key: string]: string} | null; + } + /** + * Pairs a secret environment variable with a SecretVersion in Secret Manager. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1SecretManagerSecret { + /** + * Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. + */ + env?: string | null; + /** + * Resource name of the SecretVersion. In format: projects/x/secrets/x/versions/x + */ + versionName?: string | null; + } + /** + * Secrets and secret environment variables. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Secrets { + /** + * Secrets encrypted with KMS key and the associated secret environment variable. + */ + inline?: Schema$GoogleDevtoolsCloudbuildV1InlineSecret[]; + /** + * Secrets in Secret Manager and associated secret environment variable. + */ + secretManager?: Schema$GoogleDevtoolsCloudbuildV1SecretManagerSecret[]; + } + /** + * Location of the source in a supported storage service. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Source { + /** + * Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource. + */ + connectedRepository?: Schema$GoogleDevtoolsCloudbuildV1ConnectedRepository; + /** + * If provided, get the source from this Git repository. + */ + gitSource?: Schema$GoogleDevtoolsCloudbuildV1GitSource; + /** + * If provided, get the source from this location in a Cloud Source Repository. + */ + repoSource?: Schema$GoogleDevtoolsCloudbuildV1RepoSource; + /** + * If provided, get the source from this location in Cloud Storage. + */ + storageSource?: Schema$GoogleDevtoolsCloudbuildV1StorageSource; + /** + * If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + */ + storageSourceManifest?: Schema$GoogleDevtoolsCloudbuildV1StorageSourceManifest; + } + /** + * Provenance of the source. Ways to find the original source, or verify that some source was used for this build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1SourceProvenance { + /** + * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. + */ + fileHashes?: { + [key: string]: Schema$GoogleDevtoolsCloudbuildV1FileHashes; + } | null; + /** + * Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved. + */ + resolvedConnectedRepository?: Schema$GoogleDevtoolsCloudbuildV1ConnectedRepository; + /** + * Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved. + */ + resolvedGitSource?: Schema$GoogleDevtoolsCloudbuildV1GitSource; + /** + * A copy of the build's `source.repo_source`, if exists, with any revisions resolved. + */ + resolvedRepoSource?: Schema$GoogleDevtoolsCloudbuildV1RepoSource; + /** + * A copy of the build's `source.storage_source`, if exists, with any generations resolved. + */ + resolvedStorageSource?: Schema$GoogleDevtoolsCloudbuildV1StorageSource; + /** + * A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview. + */ + resolvedStorageSourceManifest?: Schema$GoogleDevtoolsCloudbuildV1StorageSourceManifest; + } + /** + * Location of the source in an archive file in Cloud Storage. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1StorageSource { + /** + * Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + */ + bucket?: string | null; + /** + * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. + */ + generation?: string | null; + /** + * Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build. + */ + object?: string | null; + /** + * Optional. Option to specify the tool to fetch the source file for the build. + */ + sourceFetcher?: string | null; + } + /** + * Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + */ + export interface Schema$GoogleDevtoolsCloudbuildV1StorageSourceManifest { + /** + * Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + */ + bucket?: string | null; + /** + * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. + */ + generation?: string | null; + /** + * Cloud Storage object containing the source manifest. This object must be a JSON file. + */ + object?: string | null; + } + /** + * Start and end times for a build execution phase. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1TimeSpan { + /** + * End of time span. + */ + endTime?: string | null; + /** + * Start of time span. + */ + startTime?: string | null; + } + /** + * A Maven artifact uploaded using the MavenArtifact directive. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1UploadedMavenArtifact { + /** + * Hash types and values of the Maven Artifact. + */ + fileHashes?: Schema$GoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded artifact. + */ + uri?: string | null; + } + /** + * An npm package uploaded to Artifact Registry using the NpmPackage directive. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1UploadedNpmPackage { + /** + * Hash types and values of the npm package. + */ + fileHashes?: Schema$GoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded npm package. + */ + uri?: string | null; + } + /** + * Artifact uploaded using the PythonPackage directive. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1UploadedPythonPackage { + /** + * Hash types and values of the Python Artifact. + */ + fileHashes?: Schema$GoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded artifact. + */ + uri?: string | null; + } + /** + * Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Volume { + /** + * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. + */ + name?: string | null; + /** + * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. + */ + path?: string | null; + } + /** + * A non-fatal problem encountered during the execution of the build. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Warning { + /** + * The priority for this warning. + */ + priority?: string | null; + /** + * Explanation of the warning generated. + */ + text?: 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. */ From a9269af282cae68664d53b19e5677f019827e679 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 65/78] feat(secretmanager): update the API #### secretmanager:v1 The following keys were added: - schemas.Secret.properties.customerManagedEncryption.$ref - schemas.Secret.properties.customerManagedEncryption.description - schemas.Secret.properties.versionDestroyTtl.description - schemas.Secret.properties.versionDestroyTtl.format - schemas.Secret.properties.versionDestroyTtl.type - schemas.SecretVersion.properties.customerManagedEncryption.$ref - schemas.SecretVersion.properties.customerManagedEncryption.description - schemas.SecretVersion.properties.customerManagedEncryption.readOnly - schemas.SecretVersion.properties.scheduledDestroyTime.description - schemas.SecretVersion.properties.scheduledDestroyTime.format - schemas.SecretVersion.properties.scheduledDestroyTime.readOnly - schemas.SecretVersion.properties.scheduledDestroyTime.type --- discovery/secretmanager-v1.json | 22 +- discovery/secretmanager-v1beta2.json | 1775 ++++++++++++ src/apis/secretmanager/index.ts | 16 +- src/apis/secretmanager/v1.ts | 16 + src/apis/secretmanager/v1beta2.ts | 3909 ++++++++++++++++++++++++++ 5 files changed, 5736 insertions(+), 2 deletions(-) create mode 100644 discovery/secretmanager-v1beta2.json create mode 100644 src/apis/secretmanager/v1beta2.ts diff --git a/discovery/secretmanager-v1.json b/discovery/secretmanager-v1.json index 500cda7557a..883b87bf31c 100644 --- a/discovery/secretmanager-v1.json +++ b/discovery/secretmanager-v1.json @@ -1108,7 +1108,7 @@ } } }, - "revision": "20240126", + "revision": "20240309", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -1539,6 +1539,10 @@ "readOnly": true, "type": "string" }, + "customerManagedEncryption": { + "$ref": "CustomerManagedEncryption", + "description": "Optional. The customer-managed encryption configuration of the Regionalised Secrets. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions." + }, "etag": { "description": "Optional. Etag of the currently stored Secret.", "type": "string" @@ -1587,6 +1591,11 @@ }, "description": "Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. Access by alias is only be supported on GetSecretVersion and AccessSecretVersion.", "type": "object" + }, + "versionDestroyTtl": { + "description": "Optional. Secret Version TTL after destruction request This is a part of the Delayed secret version destroy feature. For secret with TTL>0, version destruction doesn't happen immediately on calling destroy instead the version goes to a disabled state and destruction happens after the TTL expires.", + "format": "google-duration", + "type": "string" } }, "type": "object" @@ -1623,6 +1632,11 @@ "readOnly": true, "type": "string" }, + "customerManagedEncryption": { + "$ref": "CustomerManagedEncryptionStatus", + "description": "Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret.", + "readOnly": true + }, "destroyTime": { "description": "Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.", "format": "google-datetime", @@ -1643,6 +1657,12 @@ "$ref": "ReplicationStatus", "description": "The replication status of the SecretVersion." }, + "scheduledDestroyTime": { + "description": "Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduled_destroy_time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "state": { "description": "Output only. The current state of the SecretVersion.", "enum": [ diff --git a/discovery/secretmanager-v1beta2.json b/discovery/secretmanager-v1beta2.json new file mode 100644 index 00000000000..58b3e0b7a51 --- /dev/null +++ b/discovery/secretmanager-v1beta2.json @@ -0,0 +1,1775 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://secretmanager.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Secret Manager", + "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. ", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/secret-manager/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "secretmanager:v1beta2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://secretmanager.mtls.googleapis.com/", + "name": "secretmanager", + "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": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "secretmanager.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1beta2/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "secretmanager.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "secrets": { + "methods": { + "addVersion": { + "description": "Creates a new SecretVersion containing secret data and attaches it to an existing Secret.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:addVersion", + "httpMethod": "POST", + "id": "secretmanager.projects.locations.secrets.addVersion", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+parent}:addVersion", + "request": { + "$ref": "AddSecretVersionRequest" + }, + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Secret containing no SecretVersions.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets", + "httpMethod": "POST", + "id": "secretmanager.projects.locations.secrets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the project to associate with the Secret, in the format `projects/*` or `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "secretId": { + "description": "Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+parent}/secrets", + "request": { + "$ref": "Secret" + }, + "response": { + "$ref": "Secret" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Secret.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}", + "httpMethod": "DELETE", + "id": "secretmanager.projects.locations.secrets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the Secret to delete in the format `projects/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets metadata for a given Secret.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}", + "httpMethod": "GET", + "id": "secretmanager.projects.locations.secrets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Secret, in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "Secret" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:getIamPolicy", + "httpMethod": "GET", + "id": "secretmanager.projects.locations.secrets.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Secrets.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets", + "httpMethod": "GET", + "id": "secretmanager.projects.locations.secrets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secrets matching the filter. If filter is empty, all secrets are listed.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the project associated with the Secrets, in the format `projects/*` or `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+parent}/secrets", + "response": { + "$ref": "ListSecretsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates metadata of an existing Secret.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}", + "httpMethod": "PATCH", + "id": "secretmanager.projects.locations.secrets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the Secret in the format `projects/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Specifies the fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "request": { + "$ref": "Secret" + }, + "response": { + "$ref": "Secret" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:setIamPolicy", + "httpMethod": "POST", + "id": "secretmanager.projects.locations.secrets.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:testIamPermissions", + "httpMethod": "POST", + "id": "secretmanager.projects.locations.secrets.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "versions": { + "methods": { + "access": { + "description": "Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}:access", + "httpMethod": "GET", + "id": "secretmanager.projects.locations.secrets.versions.access", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:access", + "response": { + "$ref": "AccessSecretVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "destroy": { + "description": "Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}:destroy", + "httpMethod": "POST", + "id": "secretmanager.projects.locations.secrets.versions.destroy", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion to destroy in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:destroy", + "request": { + "$ref": "DestroySecretVersionRequest" + }, + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disable": { + "description": "Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}:disable", + "httpMethod": "POST", + "id": "secretmanager.projects.locations.secrets.versions.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion to disable in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:disable", + "request": { + "$ref": "DisableSecretVersionRequest" + }, + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enable": { + "description": "Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}:enable", + "httpMethod": "POST", + "id": "secretmanager.projects.locations.secrets.versions.enable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion to enable in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:enable", + "request": { + "$ref": "EnableSecretVersionRequest" + }, + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "secretmanager.projects.locations.secrets.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SecretVersions. This call does not return secret data.", + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions", + "httpMethod": "GET", + "id": "secretmanager.projects.locations.secrets.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secret versions matching the filter. If filter is empty, all secret versions are listed.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+parent}/versions", + "response": { + "$ref": "ListSecretVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "secrets": { + "methods": { + "addVersion": { + "description": "Creates a new SecretVersion containing secret data and attaches it to an existing Secret.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}:addVersion", + "httpMethod": "POST", + "id": "secretmanager.projects.secrets.addVersion", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+parent}:addVersion", + "request": { + "$ref": "AddSecretVersionRequest" + }, + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Secret containing no SecretVersions.", + "flatPath": "v1beta2/projects/{projectsId}/secrets", + "httpMethod": "POST", + "id": "secretmanager.projects.secrets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the project to associate with the Secret, in the format `projects/*` or `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "secretId": { + "description": "Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+parent}/secrets", + "request": { + "$ref": "Secret" + }, + "response": { + "$ref": "Secret" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Secret.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}", + "httpMethod": "DELETE", + "id": "secretmanager.projects.secrets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the Secret to delete in the format `projects/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets metadata for a given Secret.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}", + "httpMethod": "GET", + "id": "secretmanager.projects.secrets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Secret, in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "Secret" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}:getIamPolicy", + "httpMethod": "GET", + "id": "secretmanager.projects.secrets.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Secrets.", + "flatPath": "v1beta2/projects/{projectsId}/secrets", + "httpMethod": "GET", + "id": "secretmanager.projects.secrets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secrets matching the filter. If filter is empty, all secrets are listed.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the project associated with the Secrets, in the format `projects/*` or `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+parent}/secrets", + "response": { + "$ref": "ListSecretsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates metadata of an existing Secret.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}", + "httpMethod": "PATCH", + "id": "secretmanager.projects.secrets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the Secret in the format `projects/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Specifies the fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "request": { + "$ref": "Secret" + }, + "response": { + "$ref": "Secret" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}:setIamPolicy", + "httpMethod": "POST", + "id": "secretmanager.projects.secrets.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}:testIamPermissions", + "httpMethod": "POST", + "id": "secretmanager.projects.secrets.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "versions": { + "methods": { + "access": { + "description": "Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:access", + "httpMethod": "GET", + "id": "secretmanager.projects.secrets.versions.access", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:access", + "response": { + "$ref": "AccessSecretVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "destroy": { + "description": "Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:destroy", + "httpMethod": "POST", + "id": "secretmanager.projects.secrets.versions.destroy", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion to destroy in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:destroy", + "request": { + "$ref": "DestroySecretVersionRequest" + }, + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disable": { + "description": "Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:disable", + "httpMethod": "POST", + "id": "secretmanager.projects.secrets.versions.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion to disable in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:disable", + "request": { + "$ref": "DisableSecretVersionRequest" + }, + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enable": { + "description": "Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:enable", + "httpMethod": "POST", + "id": "secretmanager.projects.secrets.versions.enable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion to enable in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:enable", + "request": { + "$ref": "EnableSecretVersionRequest" + }, + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "secretmanager.projects.secrets.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "SecretVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SecretVersions. This call does not return secret data.", + "flatPath": "v1beta2/projects/{projectsId}/secrets/{secretsId}/versions", + "httpMethod": "GET", + "id": "secretmanager.projects.secrets.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secret versions matching the filter. If filter is empty, all secret versions are listed.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.", + "location": "path", + "pattern": "^projects/[^/]+/secrets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+parent}/versions", + "response": { + "$ref": "ListSecretVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20240309", + "rootUrl": "https://secretmanager.googleapis.com/", + "schemas": { + "AccessSecretVersionResponse": { + "description": "Response message for SecretManagerService.AccessSecretVersion.", + "id": "AccessSecretVersionResponse", + "properties": { + "name": { + "description": "The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.", + "type": "string" + }, + "payload": { + "$ref": "SecretPayload", + "description": "Secret payload" + } + }, + "type": "object" + }, + "AddSecretVersionRequest": { + "description": "Request message for SecretManagerService.AddSecretVersion.", + "id": "AddSecretVersionRequest", + "properties": { + "payload": { + "$ref": "SecretPayload", + "description": "Required. The secret payload of the SecretVersion." + } + }, + "type": "object" + }, + "AuditConfig": { + "description": "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.", + "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. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "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.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows 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" + }, + "Automatic": { + "description": "A replication policy that replicates the Secret payload without any restrictions.", + "id": "Automatic", + "properties": { + "customerManagedEncryption": { + "$ref": "CustomerManagedEncryption", + "description": "Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions." + } + }, + "type": "object" + }, + "AutomaticStatus": { + "description": "The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy.", + "id": "AutomaticStatus", + "properties": { + "customerManagedEncryption": { + "$ref": "CustomerManagedEncryptionStatus", + "description": "Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.", + "readOnly": true + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "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 principals 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)." + }, + "members": { + "description": "Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", + "type": "string" + } + }, + "type": "object" + }, + "CustomerManagedEncryption": { + "description": "Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).", + "id": "CustomerManagedEncryption", + "properties": { + "kmsKeyName": { + "description": "Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in `global`. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", + "type": "string" + } + }, + "type": "object" + }, + "CustomerManagedEncryptionStatus": { + "description": "Describes the status of customer-managed encryption.", + "id": "CustomerManagedEncryptionStatus", + "properties": { + "kmsKeyVersionName": { + "description": "Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.", + "type": "string" + } + }, + "type": "object" + }, + "DestroySecretVersionRequest": { + "description": "Request message for SecretManagerService.DestroySecretVersion.", + "id": "DestroySecretVersionRequest", + "properties": { + "etag": { + "description": "Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.", + "type": "string" + } + }, + "type": "object" + }, + "DisableSecretVersionRequest": { + "description": "Request message for SecretManagerService.DisableSecretVersion.", + "id": "DisableSecretVersionRequest", + "properties": { + "etag": { + "description": "Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "EnableSecretVersionRequest": { + "description": "Request message for SecretManagerService.EnableSecretVersion.", + "id": "EnableSecretVersionRequest", + "properties": { + "etag": { + "description": "Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.", + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "description": "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.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, 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 its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListSecretVersionsResponse": { + "description": "Response message for SecretManagerService.ListSecretVersions.", + "id": "ListSecretVersionsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page.", + "type": "string" + }, + "totalSize": { + "description": "The total number of SecretVersions but 0 when the ListSecretsRequest.filter field is set.", + "format": "int32", + "type": "integer" + }, + "versions": { + "description": "The list of SecretVersions sorted in reverse by create_time (newest first).", + "items": { + "$ref": "SecretVersion" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSecretsResponse": { + "description": "Response message for SecretManagerService.ListSecrets.", + "id": "ListSecretsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in ListSecretsRequest.page_token to retrieve the next page.", + "type": "string" + }, + "secrets": { + "description": "The list of Secrets sorted in reverse by create_time (newest first).", + "items": { + "$ref": "Secret" + }, + "type": "array" + }, + "totalSize": { + "description": "The total number of Secrets but 0 when the ListSecretsRequest.filter field is set.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Policy": { + "description": "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`, or principals, to a single `role`. Principals 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/).", + "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`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`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.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Replica": { + "description": "Represents a Replica for this Secret.", + "id": "Replica", + "properties": { + "customerManagedEncryption": { + "$ref": "CustomerManagedEncryption", + "description": "Optional. The customer-managed encryption configuration of the User-Managed Replica. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions." + }, + "location": { + "description": "The canonical IDs of the location to replicate data. For example: `\"us-east1\"`.", + "type": "string" + } + }, + "type": "object" + }, + "ReplicaStatus": { + "description": "Describes the status of a user-managed replica for the SecretVersion.", + "id": "ReplicaStatus", + "properties": { + "customerManagedEncryption": { + "$ref": "CustomerManagedEncryptionStatus", + "description": "Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.", + "readOnly": true + }, + "location": { + "description": "Output only. The canonical ID of the replica location. For example: `\"us-east1\"`.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Replication": { + "description": "A policy that defines the replication and encryption configuration of data.", + "id": "Replication", + "properties": { + "automatic": { + "$ref": "Automatic", + "description": "The Secret will automatically be replicated without any restrictions." + }, + "userManaged": { + "$ref": "UserManaged", + "description": "The Secret will only be replicated into the locations specified." + } + }, + "type": "object" + }, + "ReplicationStatus": { + "description": "The replication status of a SecretVersion.", + "id": "ReplicationStatus", + "properties": { + "automatic": { + "$ref": "AutomaticStatus", + "description": "Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy." + }, + "userManaged": { + "$ref": "UserManagedStatus", + "description": "Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy." + } + }, + "type": "object" + }, + "Rotation": { + "description": "The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation.", + "id": "Rotation", + "properties": { + "nextRotationTime": { + "description": "Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.", + "format": "google-datetime", + "type": "string" + }, + "rotationPeriod": { + "description": "Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "Secret": { + "description": "A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.", + "id": "Secret", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of annotation keys and values must be less than 16KiB.", + "type": "object" + }, + "createTime": { + "description": "Output only. The time at which the Secret was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customerManagedEncryption": { + "$ref": "CustomerManagedEncryption", + "description": "Optional. The customer-managed encryption configuration of the Regionalised Secrets. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions." + }, + "etag": { + "description": "Optional. Etag of the currently stored Secret.", + "type": "string" + }, + "expireTime": { + "description": "Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.", + "format": "google-datetime", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\\p{Ll}\\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource.", + "type": "object" + }, + "name": { + "description": "Output only. The resource name of the Secret in the format `projects/*/secrets/*`.", + "readOnly": true, + "type": "string" + }, + "replication": { + "$ref": "Replication", + "description": "Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created." + }, + "rotation": { + "$ref": "Rotation", + "description": "Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy." + }, + "topics": { + "description": "Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions.", + "items": { + "$ref": "Topic" + }, + "type": "array" + }, + "ttl": { + "description": "Input only. The TTL for the Secret.", + "format": "google-duration", + "type": "string" + }, + "versionAliases": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. Access by alias is only supported for GetSecretVersion and AccessSecretVersion.", + "type": "object" + }, + "versionDestroyTtl": { + "description": "Optional. Secret Version TTL after destruction request This is a part of the Delayed secret version destroy feature. For secret with TTL>0, version destruction doesn't happen immediately on calling destroy instead the version goes to a disabled state and destruction happens after the TTL expires.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "SecretPayload": { + "description": "A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion.", + "id": "SecretPayload", + "properties": { + "data": { + "description": "The secret data. Must be no larger than 64KiB.", + "format": "byte", + "type": "string" + }, + "dataCrc32c": { + "description": "Optional. If specified, SecretManagerService will verify the integrity of the received data on SecretManagerService.AddSecretVersion calls using the crc32c checksum and store it to include in future SecretManagerService.AccessSecretVersion responses. If a checksum is not provided in the SecretManagerService.AddSecretVersion request, the SecretManagerService will generate and store one for you. The CRC32C value is encoded as a Int64 for compatibility, and can be safely downconverted to uint32 in languages that support this type. https://cloud.google.com/apis/design/design_patterns#integer_types", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "SecretVersion": { + "description": "A secret version resource in the Secret Manager API.", + "id": "SecretVersion", + "properties": { + "clientSpecifiedPayloadChecksum": { + "description": "Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. The time at which the SecretVersion was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customerManagedEncryption": { + "$ref": "CustomerManagedEncryptionStatus", + "description": "Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret.", + "readOnly": true + }, + "destroyTime": { + "description": "Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. Etag of the currently stored SecretVersion.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.", + "readOnly": true, + "type": "string" + }, + "replicationStatus": { + "$ref": "ReplicationStatus", + "description": "The replication status of the SecretVersion." + }, + "scheduledDestroyTime": { + "description": "Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduled_destroy_time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the SecretVersion.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "DESTROYED" + ], + "enumDescriptions": [ + "Not specified. This value is unused and invalid.", + "The SecretVersion may be accessed.", + "The SecretVersion may not be accessed, but the secret data is still available and can be placed back into the ENABLED state.", + "The SecretVersion is destroyed and the secret data is no longer stored. A version may not leave this state once entered." + ], + "readOnly": true, + "type": "string" + } + }, + "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 the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." + }, + "updateMask": { + "description": "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\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "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 wildcards (such as `*` or `storage.*`) are not allowed. For more information see [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 allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Topic": { + "description": "A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.", + "id": "Topic", + "properties": { + "name": { + "description": "Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission.", + "type": "string" + } + }, + "type": "object" + }, + "UserManaged": { + "description": "A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas", + "id": "UserManaged", + "properties": { + "replicas": { + "description": "Required. The list of Replicas for this Secret. Cannot be empty.", + "items": { + "$ref": "Replica" + }, + "type": "array" + } + }, + "type": "object" + }, + "UserManagedStatus": { + "description": "The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy.", + "id": "UserManagedStatus", + "properties": { + "replicas": { + "description": "Output only. The list of replica statuses for the SecretVersion.", + "items": { + "$ref": "ReplicaStatus" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Secret Manager API", + "version": "v1beta2", + "version_module": true +} \ No newline at end of file diff --git a/src/apis/secretmanager/index.ts b/src/apis/secretmanager/index.ts index 8f48cab016d..52db841b617 100644 --- a/src/apis/secretmanager/index.ts +++ b/src/apis/secretmanager/index.ts @@ -16,10 +16,12 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {secretmanager_v1} from './v1'; import {secretmanager_v1beta1} from './v1beta1'; +import {secretmanager_v1beta2} from './v1beta2'; export const VERSIONS = { v1: secretmanager_v1.Secretmanager, v1beta1: secretmanager_v1beta1.Secretmanager, + v1beta2: secretmanager_v1beta2.Secretmanager, }; export function secretmanager(version: 'v1'): secretmanager_v1.Secretmanager; @@ -32,8 +34,17 @@ export function secretmanager( export function secretmanager( options: secretmanager_v1beta1.Options ): secretmanager_v1beta1.Secretmanager; +export function secretmanager( + version: 'v1beta2' +): secretmanager_v1beta2.Secretmanager; +export function secretmanager( + options: secretmanager_v1beta2.Options +): secretmanager_v1beta2.Secretmanager; export function secretmanager< - T = secretmanager_v1.Secretmanager | secretmanager_v1beta1.Secretmanager, + T = + | secretmanager_v1.Secretmanager + | secretmanager_v1beta1.Secretmanager + | secretmanager_v1beta2.Secretmanager, >( this: GoogleConfigurable, versionOrOptions: @@ -41,6 +52,8 @@ export function secretmanager< | secretmanager_v1.Options | 'v1beta1' | secretmanager_v1beta1.Options + | 'v1beta2' + | secretmanager_v1beta2.Options ) { return getAPI('secretmanager', versionOrOptions, VERSIONS, this); } @@ -49,6 +62,7 @@ const auth = new AuthPlus(); export {auth}; export {secretmanager_v1}; export {secretmanager_v1beta1}; +export {secretmanager_v1beta2}; export { AuthPlus, GlobalOptions, diff --git a/src/apis/secretmanager/v1.ts b/src/apis/secretmanager/v1.ts index 0c4c509a542..2b8e3d50abc 100644 --- a/src/apis/secretmanager/v1.ts +++ b/src/apis/secretmanager/v1.ts @@ -447,6 +447,10 @@ export namespace secretmanager_v1 { * Output only. The time at which the Secret was created. */ createTime?: string | null; + /** + * Optional. The customer-managed encryption configuration of the Regionalised Secrets. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. + */ + customerManagedEncryption?: Schema$CustomerManagedEncryption; /** * Optional. Etag of the currently stored Secret. */ @@ -483,6 +487,10 @@ export namespace secretmanager_v1 { * Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. Access by alias is only be supported on GetSecretVersion and AccessSecretVersion. */ versionAliases?: {[key: string]: string} | null; + /** + * Optional. Secret Version TTL after destruction request This is a part of the Delayed secret version destroy feature. For secret with TTL\>0, version destruction doesn't happen immediately on calling destroy instead the version goes to a disabled state and destruction happens after the TTL expires. + */ + versionDestroyTtl?: string | null; } /** * A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion. @@ -509,6 +517,10 @@ export namespace secretmanager_v1 { * Output only. The time at which the SecretVersion was created. */ createTime?: string | null; + /** + * Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret. + */ + customerManagedEncryption?: Schema$CustomerManagedEncryptionStatus; /** * Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. */ @@ -525,6 +537,10 @@ export namespace secretmanager_v1 { * The replication status of the SecretVersion. */ replicationStatus?: Schema$ReplicationStatus; + /** + * Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduled_destroy_time. + */ + scheduledDestroyTime?: string | null; /** * Output only. The current state of the SecretVersion. */ diff --git a/src/apis/secretmanager/v1beta2.ts b/src/apis/secretmanager/v1beta2.ts new file mode 100644 index 00000000000..036ccf3627e --- /dev/null +++ b/src/apis/secretmanager/v1beta2.ts @@ -0,0 +1,3909 @@ +// 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/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, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace secretmanager_v1beta2 { + export interface Options extends GlobalOptions { + version: 'v1beta2'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * 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; + } + + /** + * Secret Manager API + * + * Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const secretmanager = google.secretmanager('v1beta2'); + * ``` + */ + export class Secretmanager { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Response message for SecretManagerService.AccessSecretVersion. + */ + export interface Schema$AccessSecretVersionResponse { + /** + * The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. + */ + name?: string | null; + /** + * Secret payload + */ + payload?: Schema$SecretPayload; + } + /** + * Request message for SecretManagerService.AddSecretVersion. + */ + export interface Schema$AddSecretVersionRequest { + /** + * Required. The secret payload of the SecretVersion. + */ + payload?: Schema$SecretPayload; + } + /** + * 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; + } + /** + * A replication policy that replicates the Secret payload without any restrictions. + */ + export interface Schema$Automatic { + /** + * Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. + */ + customerManagedEncryption?: Schema$CustomerManagedEncryption; + } + /** + * The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. + */ + export interface Schema$AutomaticStatus { + /** + * Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. + */ + customerManagedEncryption?: Schema$CustomerManagedEncryptionStatus; + } + /** + * Associates `members`, or principals, 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 principals 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 principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + */ + members?: string[] | null; + /** + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + */ + role?: string | null; + } + /** + * Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). + */ + export interface Schema$CustomerManagedEncryption { + /** + * Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in `global`. The expected format is `projects/x/locations/x/keyRings/x/cryptoKeys/x`. + */ + kmsKeyName?: string | null; + } + /** + * Describes the status of customer-managed encryption. + */ + export interface Schema$CustomerManagedEncryptionStatus { + /** + * Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/x/locations/x/keyRings/x/cryptoKeys/x/versions/x`. + */ + kmsKeyVersionName?: string | null; + } + /** + * Request message for SecretManagerService.DestroySecretVersion. + */ + export interface Schema$DestroySecretVersionRequest { + /** + * Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds. + */ + etag?: string | null; + } + /** + * Request message for SecretManagerService.DisableSecretVersion. + */ + export interface Schema$DisableSecretVersionRequest { + /** + * Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds. + */ + etag?: string | null; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * Request message for SecretManagerService.EnableSecretVersion. + */ + export interface Schema$EnableSecretVersionRequest { + /** + * Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds. + */ + etag?: 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; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * Response message for SecretManagerService.ListSecrets. + */ + export interface Schema$ListSecretsResponse { + /** + * A token to retrieve the next page of results. Pass this value in ListSecretsRequest.page_token to retrieve the next page. + */ + nextPageToken?: string | null; + /** + * The list of Secrets sorted in reverse by create_time (newest first). + */ + secrets?: Schema$Secret[]; + /** + * The total number of Secrets but 0 when the ListSecretsRequest.filter field is set. + */ + totalSize?: number | null; + } + /** + * Response message for SecretManagerService.ListSecretVersions. + */ + export interface Schema$ListSecretVersionsResponse { + /** + * A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page. + */ + nextPageToken?: string | null; + /** + * The total number of SecretVersions but 0 when the ListSecretsRequest.filter field is set. + */ + totalSize?: number | null; + /** + * The list of SecretVersions sorted in reverse by create_time (newest first). + */ + versions?: Schema$SecretVersion[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + 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`, or principals, to a single `role`. Principals 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`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + */ + 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; + } + /** + * Represents a Replica for this Secret. + */ + export interface Schema$Replica { + /** + * Optional. The customer-managed encryption configuration of the User-Managed Replica. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. + */ + customerManagedEncryption?: Schema$CustomerManagedEncryption; + /** + * The canonical IDs of the location to replicate data. For example: `"us-east1"`. + */ + location?: string | null; + } + /** + * Describes the status of a user-managed replica for the SecretVersion. + */ + export interface Schema$ReplicaStatus { + /** + * Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. + */ + customerManagedEncryption?: Schema$CustomerManagedEncryptionStatus; + /** + * Output only. The canonical ID of the replica location. For example: `"us-east1"`. + */ + location?: string | null; + } + /** + * A policy that defines the replication and encryption configuration of data. + */ + export interface Schema$Replication { + /** + * The Secret will automatically be replicated without any restrictions. + */ + automatic?: Schema$Automatic; + /** + * The Secret will only be replicated into the locations specified. + */ + userManaged?: Schema$UserManaged; + } + /** + * The replication status of a SecretVersion. + */ + export interface Schema$ReplicationStatus { + /** + * Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy. + */ + automatic?: Schema$AutomaticStatus; + /** + * Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy. + */ + userManaged?: Schema$UserManagedStatus; + } + /** + * The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. + */ + export interface Schema$Rotation { + /** + * Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. + */ + nextRotationTime?: string | null; + /** + * Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. + */ + rotationPeriod?: string | null; + } + /** + * A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data. + */ + export interface Schema$Secret { + /** + * Optional. Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of annotation keys and values must be less than 16KiB. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. The time at which the Secret was created. + */ + createTime?: string | null; + /** + * Optional. The customer-managed encryption configuration of the Regionalised Secrets. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. + */ + customerManagedEncryption?: Schema$CustomerManagedEncryption; + /** + * Optional. Etag of the currently stored Secret. + */ + etag?: string | null; + /** + * Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. + */ + expireTime?: string | null; + /** + * The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll\}\p{Lo\}{0,62\}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll\}\p{Lo\}\p{N\}_-]{0,63\}` No more than 64 labels can be assigned to a given resource. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The resource name of the Secret in the format `projects/x/secrets/x`. + */ + name?: string | null; + /** + * Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. + */ + replication?: Schema$Replication; + /** + * Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + */ + rotation?: Schema$Rotation; + /** + * Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. + */ + topics?: Schema$Topic[]; + /** + * Input only. The TTL for the Secret. + */ + ttl?: string | null; + /** + * Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. Access by alias is only supported for GetSecretVersion and AccessSecretVersion. + */ + versionAliases?: {[key: string]: string} | null; + /** + * Optional. Secret Version TTL after destruction request This is a part of the Delayed secret version destroy feature. For secret with TTL\>0, version destruction doesn't happen immediately on calling destroy instead the version goes to a disabled state and destruction happens after the TTL expires. + */ + versionDestroyTtl?: string | null; + } + /** + * A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion. + */ + export interface Schema$SecretPayload { + /** + * The secret data. Must be no larger than 64KiB. + */ + data?: string | null; + /** + * Optional. If specified, SecretManagerService will verify the integrity of the received data on SecretManagerService.AddSecretVersion calls using the crc32c checksum and store it to include in future SecretManagerService.AccessSecretVersion responses. If a checksum is not provided in the SecretManagerService.AddSecretVersion request, the SecretManagerService will generate and store one for you. The CRC32C value is encoded as a Int64 for compatibility, and can be safely downconverted to uint32 in languages that support this type. https://cloud.google.com/apis/design/design_patterns#integer_types + */ + dataCrc32c?: string | null; + } + /** + * A secret version resource in the Secret Manager API. + */ + export interface Schema$SecretVersion { + /** + * Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion. + */ + clientSpecifiedPayloadChecksum?: boolean | null; + /** + * Output only. The time at which the SecretVersion was created. + */ + createTime?: string | null; + /** + * Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret. + */ + customerManagedEncryption?: Schema$CustomerManagedEncryptionStatus; + /** + * Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. + */ + destroyTime?: string | null; + /** + * Output only. Etag of the currently stored SecretVersion. + */ + etag?: string | null; + /** + * Output only. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. + */ + name?: string | null; + /** + * The replication status of the SecretVersion. + */ + replicationStatus?: Schema$ReplicationStatus; + /** + * Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduled_destroy_time. + */ + scheduledDestroyTime?: string | null; + /** + * Output only. The current state of the SecretVersion. + */ + state?: string | null; + } + /** + * 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 Google Cloud 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; + } + /** + * 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; + } + /** + * A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. + */ + export interface Schema$Topic { + /** + * Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/x/topics/x`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + */ + name?: string | null; + } + /** + * A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas + */ + export interface Schema$UserManaged { + /** + * Required. The list of Replicas for this Secret. Cannot be empty. + */ + replicas?: Schema$Replica[]; + } + /** + * The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. + */ + export interface Schema$UserManagedStatus { + /** + * Output only. The list of replica statuses for the SecretVersion. + */ + replicas?: Schema$ReplicaStatus[]; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + secrets: Resource$Projects$Secrets; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.secrets = new Resource$Projects$Secrets(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + secrets: Resource$Projects$Locations$Secrets; + constructor(context: APIRequestContext) { + this.context = context; + this.secrets = new Resource$Projects$Locations$Secrets(this.context); + } + + /** + * Gets information about a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Secrets { + context: APIRequestContext; + versions: Resource$Projects$Locations$Secrets$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.versions = new Resource$Projects$Locations$Secrets$Versions( + this.context + ); + } + + /** + * Creates a new SecretVersion containing secret data and attaches it to an existing Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addVersion( + params: Params$Resource$Projects$Locations$Secrets$Addversion, + options: StreamMethodOptions + ): GaxiosPromise; + addVersion( + params?: Params$Resource$Projects$Locations$Secrets$Addversion, + options?: MethodOptions + ): GaxiosPromise; + addVersion( + params: Params$Resource$Projects$Locations$Secrets$Addversion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addVersion( + params: Params$Resource$Projects$Locations$Secrets$Addversion, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addVersion( + params: Params$Resource$Projects$Locations$Secrets$Addversion, + callback: BodyResponseCallback + ): void; + addVersion(callback: BodyResponseCallback): void; + addVersion( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Addversion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Addversion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Addversion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}:addVersion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new Secret containing no SecretVersions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Secrets$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Secrets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Secrets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Secrets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Secrets$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Secrets$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Secrets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Secrets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Secrets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Secrets$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets metadata for a given Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Secrets$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Secrets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Secrets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Secrets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Secrets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Secrets$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Secrets$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Secrets$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Secrets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Secrets$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Secrets. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Secrets$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Secrets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Secrets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Secrets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Secrets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates metadata of an existing Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Secrets$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Secrets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Secrets$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Secrets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Secrets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Secrets$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Secrets$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Secrets$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Secrets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Secrets$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Secrets$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Secrets$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Secrets$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Secrets$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Secrets$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Secrets$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Secrets$Addversion + extends StandardParameters { + /** + * Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/x/secrets/x` or `projects/x/locations/x/secrets/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddSecretVersionRequest; + } + export interface Params$Resource$Projects$Locations$Secrets$Create + extends StandardParameters { + /** + * Required. The resource name of the project to associate with the Secret, in the format `projects/x` or `projects/x/locations/x`. + */ + parent?: string; + /** + * Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters. + */ + secretId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Locations$Secrets$Delete + extends StandardParameters { + /** + * Optional. Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds. + */ + etag?: string; + /** + * Required. The resource name of the Secret to delete in the format `projects/x/secrets/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Secrets$Get + extends StandardParameters { + /** + * Required. The resource name of the Secret, in the format `projects/x/secrets/x` or `projects/x/locations/x/secrets/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Secrets$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Secrets$List + extends StandardParameters { + /** + * Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secrets matching the filter. If filter is empty, all secrets are listed. + */ + filter?: string; + /** + * Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + */ + pageSize?: number; + /** + * Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token. + */ + pageToken?: string; + /** + * Required. The resource name of the project associated with the Secrets, in the format `projects/x` or `projects/x/locations/x` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Secrets$Patch + extends StandardParameters { + /** + * Output only. The resource name of the Secret in the format `projects/x/secrets/x`. + */ + name?: string; + /** + * Required. Specifies the fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Locations$Secrets$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Secrets$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Secrets$Versions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Accesses a SecretVersion. This call returns the secret data. `projects/x/secrets/x/versions/latest` is an alias to the most recently created SecretVersion. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + access( + params: Params$Resource$Projects$Locations$Secrets$Versions$Access, + options: StreamMethodOptions + ): GaxiosPromise; + access( + params?: Params$Resource$Projects$Locations$Secrets$Versions$Access, + options?: MethodOptions + ): GaxiosPromise; + access( + params: Params$Resource$Projects$Locations$Secrets$Versions$Access, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + access( + params: Params$Resource$Projects$Locations$Secrets$Versions$Access, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + access( + params: Params$Resource$Projects$Locations$Secrets$Versions$Access, + callback: BodyResponseCallback + ): void; + access( + callback: BodyResponseCallback + ): void; + access( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Versions$Access + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Versions$Access; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Secrets$Versions$Access; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}:access').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + destroy( + params: Params$Resource$Projects$Locations$Secrets$Versions$Destroy, + options: StreamMethodOptions + ): GaxiosPromise; + destroy( + params?: Params$Resource$Projects$Locations$Secrets$Versions$Destroy, + options?: MethodOptions + ): GaxiosPromise; + destroy( + params: Params$Resource$Projects$Locations$Secrets$Versions$Destroy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + destroy( + params: Params$Resource$Projects$Locations$Secrets$Versions$Destroy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + destroy( + params: Params$Resource$Projects$Locations$Secrets$Versions$Destroy, + callback: BodyResponseCallback + ): void; + destroy(callback: BodyResponseCallback): void; + destroy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Versions$Destroy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Versions$Destroy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Secrets$Versions$Destroy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}:destroy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + disable( + params: Params$Resource$Projects$Locations$Secrets$Versions$Disable, + options: StreamMethodOptions + ): GaxiosPromise; + disable( + params?: Params$Resource$Projects$Locations$Secrets$Versions$Disable, + options?: MethodOptions + ): GaxiosPromise; + disable( + params: Params$Resource$Projects$Locations$Secrets$Versions$Disable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Secrets$Versions$Disable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Secrets$Versions$Disable, + callback: BodyResponseCallback + ): void; + disable(callback: BodyResponseCallback): void; + disable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Versions$Disable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Versions$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Secrets$Versions$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + enable( + params: Params$Resource$Projects$Locations$Secrets$Versions$Enable, + options: StreamMethodOptions + ): GaxiosPromise; + enable( + params?: Params$Resource$Projects$Locations$Secrets$Versions$Enable, + options?: MethodOptions + ): GaxiosPromise; + enable( + params: Params$Resource$Projects$Locations$Secrets$Versions$Enable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Locations$Secrets$Versions$Enable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Locations$Secrets$Versions$Enable, + callback: BodyResponseCallback + ): void; + enable(callback: BodyResponseCallback): void; + enable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Versions$Enable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Versions$Enable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Secrets$Versions$Enable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}:enable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets metadata for a SecretVersion. `projects/x/secrets/x/versions/latest` is an alias to the most recently created SecretVersion. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Secrets$Versions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Secrets$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Secrets$Versions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Secrets$Versions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Secrets$Versions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Versions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Versions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Versions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists SecretVersions. This call does not return secret data. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Secrets$Versions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Secrets$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Secrets$Versions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Secrets$Versions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Secrets$Versions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Versions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Secrets$Versions$Access + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. `projects/x/secrets/x/versions/latest` or `projects/x/locations/x/secrets/x/versions/latest` is an alias to the most recently created SecretVersion. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Secrets$Versions$Destroy + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion to destroy in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DestroySecretVersionRequest; + } + export interface Params$Resource$Projects$Locations$Secrets$Versions$Disable + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion to disable in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisableSecretVersionRequest; + } + export interface Params$Resource$Projects$Locations$Secrets$Versions$Enable + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion to enable in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EnableSecretVersionRequest; + } + export interface Params$Resource$Projects$Locations$Secrets$Versions$Get + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. `projects/x/secrets/x/versions/latest` or `projects/x/locations/x/secrets/x/versions/latest` is an alias to the most recently created SecretVersion. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Secrets$Versions$List + extends StandardParameters { + /** + * Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secret versions matching the filter. If filter is empty, all secret versions are listed. + */ + filter?: string; + /** + * Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + */ + pageSize?: number; + /** + * Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][]. + */ + pageToken?: string; + /** + * Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/x/secrets/x` or `projects/x/locations/x/secrets/x`. + */ + parent?: string; + } + + export class Resource$Projects$Secrets { + context: APIRequestContext; + versions: Resource$Projects$Secrets$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.versions = new Resource$Projects$Secrets$Versions(this.context); + } + + /** + * Creates a new SecretVersion containing secret data and attaches it to an existing Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addVersion( + params: Params$Resource$Projects$Secrets$Addversion, + options: StreamMethodOptions + ): GaxiosPromise; + addVersion( + params?: Params$Resource$Projects$Secrets$Addversion, + options?: MethodOptions + ): GaxiosPromise; + addVersion( + params: Params$Resource$Projects$Secrets$Addversion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addVersion( + params: Params$Resource$Projects$Secrets$Addversion, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addVersion( + params: Params$Resource$Projects$Secrets$Addversion, + callback: BodyResponseCallback + ): void; + addVersion(callback: BodyResponseCallback): void; + addVersion( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Addversion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Addversion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Addversion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}:addVersion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new Secret containing no SecretVersions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Secrets$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Secrets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Secrets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Secrets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Secrets$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Secrets$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Secrets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Secrets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Secrets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Secrets$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets metadata for a given Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Secrets$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Secrets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Secrets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Secrets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Secrets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Secrets$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Secrets$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Secrets$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Secrets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Secrets$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Secrets. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Secrets$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Secrets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Secrets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Secrets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Secrets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates metadata of an existing Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Secrets$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Secrets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Secrets$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Secrets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Secrets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Secrets$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Secrets$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Secrets$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Secrets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Secrets$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Secrets$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Secrets$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Secrets$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Secrets$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Secrets$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Secrets$Addversion + extends StandardParameters { + /** + * Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/x/secrets/x` or `projects/x/locations/x/secrets/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Create + extends StandardParameters { + /** + * Required. The resource name of the project to associate with the Secret, in the format `projects/x` or `projects/x/locations/x`. + */ + parent?: string; + /** + * Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters. + */ + secretId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Secrets$Delete + extends StandardParameters { + /** + * Optional. Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds. + */ + etag?: string; + /** + * Required. The resource name of the Secret to delete in the format `projects/x/secrets/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Get + extends StandardParameters { + /** + * Required. The resource name of the Secret, in the format `projects/x/secrets/x` or `projects/x/locations/x/secrets/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. 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; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Secrets$List + extends StandardParameters { + /** + * Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secrets matching the filter. If filter is empty, all secrets are listed. + */ + filter?: string; + /** + * Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + */ + pageSize?: number; + /** + * Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token. + */ + pageToken?: string; + /** + * Required. The resource name of the project associated with the Secrets, in the format `projects/x` or `projects/x/locations/x` + */ + parent?: string; + } + export interface Params$Resource$Projects$Secrets$Patch + extends StandardParameters { + /** + * Output only. The resource name of the Secret in the format `projects/x/secrets/x`. + */ + name?: string; + /** + * Required. Specifies the fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Secrets$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Secrets$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Secrets$Versions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Accesses a SecretVersion. This call returns the secret data. `projects/x/secrets/x/versions/latest` is an alias to the most recently created SecretVersion. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + access( + params: Params$Resource$Projects$Secrets$Versions$Access, + options: StreamMethodOptions + ): GaxiosPromise; + access( + params?: Params$Resource$Projects$Secrets$Versions$Access, + options?: MethodOptions + ): GaxiosPromise; + access( + params: Params$Resource$Projects$Secrets$Versions$Access, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + access( + params: Params$Resource$Projects$Secrets$Versions$Access, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + access( + params: Params$Resource$Projects$Secrets$Versions$Access, + callback: BodyResponseCallback + ): void; + access( + callback: BodyResponseCallback + ): void; + access( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Access + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Access; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Access; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}:access').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + destroy( + params: Params$Resource$Projects$Secrets$Versions$Destroy, + options: StreamMethodOptions + ): GaxiosPromise; + destroy( + params?: Params$Resource$Projects$Secrets$Versions$Destroy, + options?: MethodOptions + ): GaxiosPromise; + destroy( + params: Params$Resource$Projects$Secrets$Versions$Destroy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + destroy( + params: Params$Resource$Projects$Secrets$Versions$Destroy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + destroy( + params: Params$Resource$Projects$Secrets$Versions$Destroy, + callback: BodyResponseCallback + ): void; + destroy(callback: BodyResponseCallback): void; + destroy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Destroy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Destroy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Destroy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}:destroy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + disable( + params: Params$Resource$Projects$Secrets$Versions$Disable, + options: StreamMethodOptions + ): GaxiosPromise; + disable( + params?: Params$Resource$Projects$Secrets$Versions$Disable, + options?: MethodOptions + ): GaxiosPromise; + disable( + params: Params$Resource$Projects$Secrets$Versions$Disable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Secrets$Versions$Disable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Secrets$Versions$Disable, + callback: BodyResponseCallback + ): void; + disable(callback: BodyResponseCallback): void; + disable( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Disable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + enable( + params: Params$Resource$Projects$Secrets$Versions$Enable, + options: StreamMethodOptions + ): GaxiosPromise; + enable( + params?: Params$Resource$Projects$Secrets$Versions$Enable, + options?: MethodOptions + ): GaxiosPromise; + enable( + params: Params$Resource$Projects$Secrets$Versions$Enable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Secrets$Versions$Enable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Secrets$Versions$Enable, + callback: BodyResponseCallback + ): void; + enable(callback: BodyResponseCallback): void; + enable( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Enable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Enable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Enable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}:enable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets metadata for a SecretVersion. `projects/x/secrets/x/versions/latest` is an alias to the most recently created SecretVersion. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Secrets$Versions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Secrets$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Secrets$Versions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Secrets$Versions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Secrets$Versions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists SecretVersions. This call does not return secret data. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Secrets$Versions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Secrets$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Secrets$Versions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Secrets$Versions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Secrets$Versions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Secrets$Versions$Access + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. `projects/x/secrets/x/versions/latest` or `projects/x/locations/x/secrets/x/versions/latest` is an alias to the most recently created SecretVersion. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Versions$Destroy + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion to destroy in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DestroySecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Disable + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion to disable in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisableSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Enable + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion to enable in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EnableSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Get + extends StandardParameters { + /** + * Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x`. `projects/x/secrets/x/versions/latest` or `projects/x/locations/x/secrets/x/versions/latest` is an alias to the most recently created SecretVersion. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Versions$List + extends StandardParameters { + /** + * Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secret versions matching the filter. If filter is empty, all secret versions are listed. + */ + filter?: string; + /** + * Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + */ + pageSize?: number; + /** + * Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][]. + */ + pageToken?: string; + /** + * Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/x/secrets/x` or `projects/x/locations/x/secrets/x`. + */ + parent?: string; + } +} From b9c0c7c6374ea63327b26bb4a5655e91af920913 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:53 +0000 Subject: [PATCH 66/78] feat(serviceusage): update the API #### serviceusage:v1beta1 The following keys were added: - schemas.QuotaBucket.properties.rolloutInfo.$ref - schemas.QuotaBucket.properties.rolloutInfo.description - schemas.RolloutInfo.description - schemas.RolloutInfo.id - schemas.RolloutInfo.properties.defaultLimitOngoingRollout.description - schemas.RolloutInfo.properties.defaultLimitOngoingRollout.type - schemas.RolloutInfo.type --- discovery/serviceusage-v1beta1.json | 17 ++++++++++++++++- src/apis/serviceusage/v1beta1.ts | 13 +++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 1271a8b72a4..c45f1f7c03c 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20240220", + "revision": "20240310", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -3662,6 +3662,10 @@ "producerQuotaPolicy": { "$ref": "ProducerQuotaPolicy", "description": "Producer policy inherited from the closet ancestor of the current consumer." + }, + "rolloutInfo": { + "$ref": "RolloutInfo", + "description": "Rollout information of this quota bucket. This field is present only if the effective limit will change due to the ongoing rollout of the service config." } }, "type": "object" @@ -3780,6 +3784,17 @@ }, "type": "object" }, + "RolloutInfo": { + "description": "[Output only] Rollout information of a quota.", + "id": "RolloutInfo", + "properties": { + "defaultLimitOngoingRollout": { + "description": "Whether there is an ongoing rollout for the default limit or not.", + "type": "boolean" + } + }, + "type": "object" + }, "RubySettings": { "description": "Settings for Ruby client libraries.", "id": "RubySettings", diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 38cab1c64d6..911a6eccba4 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -1969,6 +1969,10 @@ export namespace serviceusage_v1beta1 { * Producer policy inherited from the closet ancestor of the current consumer. */ producerQuotaPolicy?: Schema$ProducerQuotaPolicy; + /** + * Rollout information of this quota bucket. This field is present only if the effective limit will change due to the ongoing rollout of the service config. + */ + rolloutInfo?: Schema$RolloutInfo; } /** * `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. @@ -2061,6 +2065,15 @@ export namespace serviceusage_v1beta1 { */ removedValues?: string[] | null; } + /** + * [Output only] Rollout information of a quota. + */ + export interface Schema$RolloutInfo { + /** + * Whether there is an ongoing rollout for the default limit or not. + */ + defaultLimitOngoingRollout?: boolean | null; + } /** * Settings for Ruby client libraries. */ From 2f1749cf582745263fbf4efe15f993f177aa2a93 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 67/78] feat(slides): update the API #### slides:v1 The following keys were added: - schemas.PageElement.properties.speakerSpotlight.$ref - schemas.PageElement.properties.speakerSpotlight.description - schemas.SpeakerSpotlight.description - schemas.SpeakerSpotlight.id - schemas.SpeakerSpotlight.properties.speakerSpotlightProperties.$ref - schemas.SpeakerSpotlight.properties.speakerSpotlightProperties.description - schemas.SpeakerSpotlight.type - schemas.SpeakerSpotlightProperties.description - schemas.SpeakerSpotlightProperties.id - schemas.SpeakerSpotlightProperties.properties.outline.$ref - schemas.SpeakerSpotlightProperties.properties.outline.description - schemas.SpeakerSpotlightProperties.properties.shadow.$ref - schemas.SpeakerSpotlightProperties.properties.shadow.description - schemas.SpeakerSpotlightProperties.type --- discovery/slides-v1.json | 32 +++++++++++++++++++++++++++++++- src/apis/slides/v1.ts | 26 ++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 1 deletion(-) diff --git a/discovery/slides-v1.json b/discovery/slides-v1.json index 0a2a06f9c64..ced20e9f96a 100644 --- a/discovery/slides-v1.json +++ b/discovery/slides-v1.json @@ -313,7 +313,7 @@ } } }, - "revision": "20230705", + "revision": "20240305", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { @@ -2130,6 +2130,10 @@ "$ref": "Size", "description": "The size of the page element." }, + "speakerSpotlight": { + "$ref": "SpeakerSpotlight", + "description": "A Speaker Spotlight." + }, "table": { "$ref": "Table", "description": "A table page element." @@ -3506,6 +3510,32 @@ }, "type": "object" }, + "SpeakerSpotlight": { + "description": "A PageElement kind representing a Speaker Spotlight.", + "id": "SpeakerSpotlight", + "properties": { + "speakerSpotlightProperties": { + "$ref": "SpeakerSpotlightProperties", + "description": "The properties of the Speaker Spotlight." + } + }, + "type": "object" + }, + "SpeakerSpotlightProperties": { + "description": "The properties of the SpeakerSpotlight.", + "id": "SpeakerSpotlightProperties", + "properties": { + "outline": { + "$ref": "Outline", + "description": "The outline of the Speaker Spotlight. If not set, it has no outline." + }, + "shadow": { + "$ref": "Shadow", + "description": "The shadow of the Speaker Spotlight. If not set, it has no shadow." + } + }, + "type": "object" + }, "StretchedPictureFill": { "description": "The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container.", "id": "StretchedPictureFill", diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index 104f668bcf6..0d0d5c726e5 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -1119,6 +1119,10 @@ export namespace slides_v1 { * The size of the page element. */ size?: Schema$Size; + /** + * A Speaker Spotlight. + */ + speakerSpotlight?: Schema$SpeakerSpotlight; /** * A table page element. */ @@ -1869,6 +1873,28 @@ export namespace slides_v1 { */ color?: Schema$OpaqueColor; } + /** + * A PageElement kind representing a Speaker Spotlight. + */ + export interface Schema$SpeakerSpotlight { + /** + * The properties of the Speaker Spotlight. + */ + speakerSpotlightProperties?: Schema$SpeakerSpotlightProperties; + } + /** + * The properties of the SpeakerSpotlight. + */ + export interface Schema$SpeakerSpotlightProperties { + /** + * The outline of the Speaker Spotlight. If not set, it has no outline. + */ + outline?: Schema$Outline; + /** + * The shadow of the Speaker Spotlight. If not set, it has no shadow. + */ + shadow?: Schema$Shadow; + } /** * The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container. */ From 420bebbe23f63ffec76bb92674798f4eb2c1f219 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 68/78] feat(spanner): update the API #### spanner:v1 The following keys were added: - schemas.BatchWriteRequest.properties.excludeTxnFromChangeStreams.description - schemas.BatchWriteRequest.properties.excludeTxnFromChangeStreams.type - schemas.Session.properties.multiplexed.description - schemas.Session.properties.multiplexed.type - schemas.TransactionOptions.properties.excludeTxnFromChangeStreams.description - schemas.TransactionOptions.properties.excludeTxnFromChangeStreams.type --- discovery/spanner-v1.json | 14 +++++++++++++- src/apis/spanner/v1.ts | 12 ++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index 49f37cc0263..db54add1e24 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -2729,7 +2729,7 @@ } } }, - "revision": "20240207", + "revision": "20240307", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { @@ -2944,6 +2944,10 @@ "description": "The request for BatchWrite.", "id": "BatchWriteRequest", "properties": { + "excludeTxnFromChangeStreams": { + "description": "Optional. When `exclude_txn_from_change_streams` is set to `true`: * Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, mutations from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions.", + "type": "boolean" + }, "mutationGroups": { "description": "Required. The groups of mutations to be applied.", "items": { @@ -5555,6 +5559,10 @@ "description": "The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels.", "type": "object" }, + "multiplexed": { + "description": "Optional. If true, specifies a multiplexed session. A multiplexed session may be used for multiple, concurrent read-only operations but can not be used for read-write transactions, partitioned reads, or partitioned queries. Multiplexed sessions can be created via CreateSession but not via BatchCreateSessions. Multiplexed sessions may not be deleted nor listed.", + "type": "boolean" + }, "name": { "description": "Output only. The name of the session. This is always system-assigned.", "readOnly": true, @@ -5709,6 +5717,10 @@ "description": "Transactions: Each session can have at most one active transaction at a time (note that standalone reads and queries use a transaction internally and do count towards the one transaction limit). After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. Transaction modes: Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. Snapshot read-only transactions provide guaranteed consistency across several reads, but do not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past, or configured to perform a strong read (where Spanner will select a timestamp such that the read is guaranteed to see the effects of all transactions that have committed before the start of the read). Snapshot read-only transactions do not need to be committed. Queries on change streams must be performed with the snapshot read-only transaction mode, specifying a strong read. Please see TransactionOptions.ReadOnly.strong for more details. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read-write data in a single database. They may, however, read-write data in different tables within that database. Locking read-write transactions: Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. Semantics: Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. Retrying aborted transactions: When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Under some circumstances (for example, many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of time spent retrying. Idle transactions: A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. If an idle transaction is aborted, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (for example, `SELECT 1`) prevents the transaction from becoming idle. Snapshot read-only transactions: Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transactions, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. Strong: Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. Queries on change streams (see below for more details) must also specify the strong read timestamp bound. See TransactionOptions.ReadOnly.strong. Exact staleness: These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp less than or equal to the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a \"negotiation phase\" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. Bounded staleness: Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. Old read timestamps and garbage collection: Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as \"version GC\". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. You can configure and extend the `VERSION_RETENTION_PERIOD` of a database up to a period as long as one week, which allows Cloud Spanner to perform reads up to one week in the past. Querying change Streams: A Change Stream is a schema object that can be configured to watch data changes on the entire database, a set of tables, or a set of columns in a database. When a change stream is created, Spanner automatically defines a corresponding SQL Table-Valued Function (TVF) that can be used to query the change records in the associated change stream using the ExecuteStreamingSql API. The name of the TVF for a change stream is generated from the name of the change stream: READ_. All queries on change stream TVFs must be executed using the ExecuteStreamingSql API with a single-use read-only transaction with a strong read-only timestamp_bound. The change stream TVF allows users to specify the start_timestamp and end_timestamp for the time range of interest. All change records within the retention period is accessible using the strong read-only timestamp_bound. All other TransactionOptions are invalid for change stream queries. In addition, if TransactionOptions.read_only.return_read_timestamp is set to true, a special value of 2^63 - 2 will be returned in the Transaction message that describes the transaction, instead of a valid read timestamp. This special value should be discarded and not used for any subsequent queries. Please see https://cloud.google.com/spanner/docs/change-streams for more details on how to query the change stream TVFs. Partitioned DML transactions: Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table.", "id": "TransactionOptions", "properties": { + "excludeTxnFromChangeStreams": { + "description": "When `exclude_txn_from_change_streams` is set to `true`: * Mutations from this transaction will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Mutations from this transaction will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, mutations from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. `exclude_txn_from_change_streams` may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an `INVALID_ARGUMENT` error.", + "type": "boolean" + }, "partitionedDml": { "$ref": "PartitionedDml", "description": "Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource." diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index dbdbc925d03..9be1d1663e6 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -273,6 +273,10 @@ export namespace spanner_v1 { * The request for BatchWrite. */ export interface Schema$BatchWriteRequest { + /** + * Optional. When `exclude_txn_from_change_streams` is set to `true`: * Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, mutations from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions. + */ + excludeTxnFromChangeStreams?: boolean | null; /** * Required. The groups of mutations to be applied. */ @@ -2108,6 +2112,10 @@ export namespace spanner_v1 { * The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. */ labels?: {[key: string]: string} | null; + /** + * Optional. If true, specifies a multiplexed session. A multiplexed session may be used for multiple, concurrent read-only operations but can not be used for read-write transactions, partitioned reads, or partitioned queries. Multiplexed sessions can be created via CreateSession but not via BatchCreateSessions. Multiplexed sessions may not be deleted nor listed. + */ + multiplexed?: boolean | null; /** * Output only. The name of the session. This is always system-assigned. */ @@ -2213,6 +2221,10 @@ export namespace spanner_v1 { * Transactions: Each session can have at most one active transaction at a time (note that standalone reads and queries use a transaction internally and do count towards the one transaction limit). After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. Transaction modes: Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. Snapshot read-only transactions provide guaranteed consistency across several reads, but do not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past, or configured to perform a strong read (where Spanner will select a timestamp such that the read is guaranteed to see the effects of all transactions that have committed before the start of the read). Snapshot read-only transactions do not need to be committed. Queries on change streams must be performed with the snapshot read-only transaction mode, specifying a strong read. Please see TransactionOptions.ReadOnly.strong for more details. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read-write data in a single database. They may, however, read-write data in different tables within that database. Locking read-write transactions: Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. Semantics: Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. Retrying aborted transactions: When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Under some circumstances (for example, many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of time spent retrying. Idle transactions: A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. If an idle transaction is aborted, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (for example, `SELECT 1`) prevents the transaction from becoming idle. Snapshot read-only transactions: Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transactions, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. Strong: Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. Queries on change streams (see below for more details) must also specify the strong read timestamp bound. See TransactionOptions.ReadOnly.strong. Exact staleness: These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp less than or equal to the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. Bounded staleness: Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. Old read timestamps and garbage collection: Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. You can configure and extend the `VERSION_RETENTION_PERIOD` of a database up to a period as long as one week, which allows Cloud Spanner to perform reads up to one week in the past. Querying change Streams: A Change Stream is a schema object that can be configured to watch data changes on the entire database, a set of tables, or a set of columns in a database. When a change stream is created, Spanner automatically defines a corresponding SQL Table-Valued Function (TVF) that can be used to query the change records in the associated change stream using the ExecuteStreamingSql API. The name of the TVF for a change stream is generated from the name of the change stream: READ_. All queries on change stream TVFs must be executed using the ExecuteStreamingSql API with a single-use read-only transaction with a strong read-only timestamp_bound. The change stream TVF allows users to specify the start_timestamp and end_timestamp for the time range of interest. All change records within the retention period is accessible using the strong read-only timestamp_bound. All other TransactionOptions are invalid for change stream queries. In addition, if TransactionOptions.read_only.return_read_timestamp is set to true, a special value of 2^63 - 2 will be returned in the Transaction message that describes the transaction, instead of a valid read timestamp. This special value should be discarded and not used for any subsequent queries. Please see https://cloud.google.com/spanner/docs/change-streams for more details on how to query the change stream TVFs. Partitioned DML transactions: Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table. */ export interface Schema$TransactionOptions { + /** + * When `exclude_txn_from_change_streams` is set to `true`: * Mutations from this transaction will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Mutations from this transaction will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, mutations from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. `exclude_txn_from_change_streams` may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an `INVALID_ARGUMENT` error. + */ + excludeTxnFromChangeStreams?: boolean | null; /** * Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource. */ From f17c99aed62a4d186e4d56756b9fa24b038552e8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 69/78] feat(sqladmin): update the API #### sqladmin:v1beta4 The following keys were added: - resources.instances.methods.acquireSsrsLease.description - resources.instances.methods.acquireSsrsLease.flatPath - resources.instances.methods.acquireSsrsLease.httpMethod - resources.instances.methods.acquireSsrsLease.id - resources.instances.methods.acquireSsrsLease.parameterOrder - resources.instances.methods.acquireSsrsLease.parameters.instance.description - resources.instances.methods.acquireSsrsLease.parameters.instance.location - resources.instances.methods.acquireSsrsLease.parameters.instance.required - resources.instances.methods.acquireSsrsLease.parameters.instance.type - resources.instances.methods.acquireSsrsLease.parameters.project.description - resources.instances.methods.acquireSsrsLease.parameters.project.location - resources.instances.methods.acquireSsrsLease.parameters.project.required - resources.instances.methods.acquireSsrsLease.parameters.project.type - resources.instances.methods.acquireSsrsLease.path - resources.instances.methods.acquireSsrsLease.request.$ref - resources.instances.methods.acquireSsrsLease.response.$ref - resources.instances.methods.acquireSsrsLease.scopes - resources.instances.methods.releaseSsrsLease.description - resources.instances.methods.releaseSsrsLease.flatPath - resources.instances.methods.releaseSsrsLease.httpMethod - resources.instances.methods.releaseSsrsLease.id - resources.instances.methods.releaseSsrsLease.parameterOrder - resources.instances.methods.releaseSsrsLease.parameters.instance.description - resources.instances.methods.releaseSsrsLease.parameters.instance.location - resources.instances.methods.releaseSsrsLease.parameters.instance.required - resources.instances.methods.releaseSsrsLease.parameters.instance.type - resources.instances.methods.releaseSsrsLease.parameters.project.description - resources.instances.methods.releaseSsrsLease.parameters.project.location - resources.instances.methods.releaseSsrsLease.parameters.project.required - resources.instances.methods.releaseSsrsLease.parameters.project.type - resources.instances.methods.releaseSsrsLease.path - resources.instances.methods.releaseSsrsLease.response.$ref - resources.instances.methods.releaseSsrsLease.scopes - schemas.AcquireSsrsLeaseContext.description - schemas.AcquireSsrsLeaseContext.id - schemas.AcquireSsrsLeaseContext.properties.duration.description - schemas.AcquireSsrsLeaseContext.properties.duration.format - schemas.AcquireSsrsLeaseContext.properties.duration.type - schemas.AcquireSsrsLeaseContext.properties.reportDatabase.description - schemas.AcquireSsrsLeaseContext.properties.reportDatabase.type - schemas.AcquireSsrsLeaseContext.properties.serviceLogin.description - schemas.AcquireSsrsLeaseContext.properties.serviceLogin.type - schemas.AcquireSsrsLeaseContext.properties.setupLogin.description - schemas.AcquireSsrsLeaseContext.properties.setupLogin.type - schemas.AcquireSsrsLeaseContext.type - schemas.InstancesAcquireSsrsLeaseRequest.description - schemas.InstancesAcquireSsrsLeaseRequest.id - schemas.InstancesAcquireSsrsLeaseRequest.properties.acquireSsrsLeaseContext.$ref - schemas.InstancesAcquireSsrsLeaseRequest.properties.acquireSsrsLeaseContext.description - schemas.InstancesAcquireSsrsLeaseRequest.type - schemas.Operation.properties.acquireSsrsLeaseContext.$ref - schemas.Operation.properties.acquireSsrsLeaseContext.description - schemas.Settings.properties.enableGoogleMlIntegration.description - schemas.Settings.properties.enableGoogleMlIntegration.type - schemas.SqlInstancesAcquireSsrsLeaseResponse.description - schemas.SqlInstancesAcquireSsrsLeaseResponse.id - schemas.SqlInstancesAcquireSsrsLeaseResponse.properties.operationId.description - schemas.SqlInstancesAcquireSsrsLeaseResponse.properties.operationId.type - schemas.SqlInstancesAcquireSsrsLeaseResponse.type - schemas.SqlInstancesReleaseSsrsLeaseResponse.description - schemas.SqlInstancesReleaseSsrsLeaseResponse.id - schemas.SqlInstancesReleaseSsrsLeaseResponse.properties.operationId.description - schemas.SqlInstancesReleaseSsrsLeaseResponse.properties.operationId.type - schemas.SqlInstancesReleaseSsrsLeaseResponse.type - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.syncParallelLevel.description - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.syncParallelLevel.enum - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.syncParallelLevel.enumDescriptions - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.syncParallelLevel.type The following keys were changed: - schemas.ConnectSettings.properties.databaseVersion.enum - schemas.ConnectSettings.properties.databaseVersion.enumDeprecated - schemas.ConnectSettings.properties.databaseVersion.enumDescriptions - schemas.DatabaseInstance.properties.databaseVersion.enum - schemas.DatabaseInstance.properties.databaseVersion.enumDeprecated - schemas.DatabaseInstance.properties.databaseVersion.enumDescriptions - schemas.Flag.properties.appliesTo.items.enum - schemas.Flag.properties.appliesTo.items.enumDeprecated - schemas.Flag.properties.appliesTo.items.enumDescriptions - schemas.Operation.properties.operationType.enum - schemas.Operation.properties.operationType.enumDeprecated - schemas.Operation.properties.operationType.enumDescriptions #### sqladmin:v1 The following keys were added: - resources.instances.methods.acquireSsrsLease.description - resources.instances.methods.acquireSsrsLease.flatPath - resources.instances.methods.acquireSsrsLease.httpMethod - resources.instances.methods.acquireSsrsLease.id - resources.instances.methods.acquireSsrsLease.parameterOrder - resources.instances.methods.acquireSsrsLease.parameters.instance.description - resources.instances.methods.acquireSsrsLease.parameters.instance.location - resources.instances.methods.acquireSsrsLease.parameters.instance.required - resources.instances.methods.acquireSsrsLease.parameters.instance.type - resources.instances.methods.acquireSsrsLease.parameters.project.description - resources.instances.methods.acquireSsrsLease.parameters.project.location - resources.instances.methods.acquireSsrsLease.parameters.project.required - resources.instances.methods.acquireSsrsLease.parameters.project.type - resources.instances.methods.acquireSsrsLease.path - resources.instances.methods.acquireSsrsLease.request.$ref - resources.instances.methods.acquireSsrsLease.response.$ref - resources.instances.methods.acquireSsrsLease.scopes - resources.instances.methods.releaseSsrsLease.description - resources.instances.methods.releaseSsrsLease.flatPath - resources.instances.methods.releaseSsrsLease.httpMethod - resources.instances.methods.releaseSsrsLease.id - resources.instances.methods.releaseSsrsLease.parameterOrder - resources.instances.methods.releaseSsrsLease.parameters.instance.description - resources.instances.methods.releaseSsrsLease.parameters.instance.location - resources.instances.methods.releaseSsrsLease.parameters.instance.required - resources.instances.methods.releaseSsrsLease.parameters.instance.type - resources.instances.methods.releaseSsrsLease.parameters.project.description - resources.instances.methods.releaseSsrsLease.parameters.project.location - resources.instances.methods.releaseSsrsLease.parameters.project.required - resources.instances.methods.releaseSsrsLease.parameters.project.type - resources.instances.methods.releaseSsrsLease.path - resources.instances.methods.releaseSsrsLease.response.$ref - resources.instances.methods.releaseSsrsLease.scopes - schemas.AcquireSsrsLeaseContext.description - schemas.AcquireSsrsLeaseContext.id - schemas.AcquireSsrsLeaseContext.properties.duration.description - schemas.AcquireSsrsLeaseContext.properties.duration.format - schemas.AcquireSsrsLeaseContext.properties.duration.type - schemas.AcquireSsrsLeaseContext.properties.reportDatabase.description - schemas.AcquireSsrsLeaseContext.properties.reportDatabase.type - schemas.AcquireSsrsLeaseContext.properties.serviceLogin.description - schemas.AcquireSsrsLeaseContext.properties.serviceLogin.type - schemas.AcquireSsrsLeaseContext.properties.setupLogin.description - schemas.AcquireSsrsLeaseContext.properties.setupLogin.type - schemas.AcquireSsrsLeaseContext.type - schemas.InstancesAcquireSsrsLeaseRequest.description - schemas.InstancesAcquireSsrsLeaseRequest.id - schemas.InstancesAcquireSsrsLeaseRequest.properties.acquireSsrsLeaseContext.$ref - schemas.InstancesAcquireSsrsLeaseRequest.properties.acquireSsrsLeaseContext.description - schemas.InstancesAcquireSsrsLeaseRequest.type - schemas.Operation.properties.acquireSsrsLeaseContext.$ref - schemas.Operation.properties.acquireSsrsLeaseContext.description - schemas.Settings.properties.enableGoogleMlIntegration.description - schemas.Settings.properties.enableGoogleMlIntegration.type - schemas.SqlInstancesAcquireSsrsLeaseResponse.description - schemas.SqlInstancesAcquireSsrsLeaseResponse.id - schemas.SqlInstancesAcquireSsrsLeaseResponse.properties.operationId.description - schemas.SqlInstancesAcquireSsrsLeaseResponse.properties.operationId.type - schemas.SqlInstancesAcquireSsrsLeaseResponse.type - schemas.SqlInstancesReleaseSsrsLeaseResponse.description - schemas.SqlInstancesReleaseSsrsLeaseResponse.id - schemas.SqlInstancesReleaseSsrsLeaseResponse.properties.operationId.description - schemas.SqlInstancesReleaseSsrsLeaseResponse.properties.operationId.type - schemas.SqlInstancesReleaseSsrsLeaseResponse.type - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.syncParallelLevel.description - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.syncParallelLevel.enum - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.syncParallelLevel.enumDescriptions - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.syncParallelLevel.type The following keys were changed: - schemas.ConnectSettings.properties.databaseVersion.enum - schemas.ConnectSettings.properties.databaseVersion.enumDeprecated - schemas.ConnectSettings.properties.databaseVersion.enumDescriptions - schemas.DatabaseInstance.properties.databaseVersion.enum - schemas.DatabaseInstance.properties.databaseVersion.enumDeprecated - schemas.DatabaseInstance.properties.databaseVersion.enumDescriptions - schemas.Flag.properties.appliesTo.items.enum - schemas.Flag.properties.appliesTo.items.enumDeprecated - schemas.Flag.properties.appliesTo.items.enumDescriptions - schemas.Operation.properties.operationType.enum - schemas.Operation.properties.operationType.enumDeprecated - schemas.Operation.properties.operationType.enumDescriptions --- discovery/sqladmin-v1.json | 196 +++++++++++++++++++++- discovery/sqladmin-v1beta4.json | 196 +++++++++++++++++++++- src/apis/sqladmin/v1.ts | 279 ++++++++++++++++++++++++++++++++ src/apis/sqladmin/v1beta4.ts | 279 ++++++++++++++++++++++++++++++++ 4 files changed, 944 insertions(+), 6 deletions(-) diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 60b7f5a0f16..3a29c429291 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -608,6 +608,41 @@ }, "instances": { "methods": { + "acquireSsrsLease": { + "description": "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", + "flatPath": "v1/projects/{project}/instances/{instance}/acquireSsrsLease", + "httpMethod": "POST", + "id": "sql.instances.acquireSsrsLease", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id).", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance (Example: project-id).", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/acquireSsrsLease", + "request": { + "$ref": "InstancesAcquireSsrsLeaseRequest" + }, + "response": { + "$ref": "SqlInstancesAcquireSsrsLeaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "addServerCa": { "description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", "flatPath": "v1/projects/{project}/instances/{instance}/addServerCa", @@ -1120,6 +1155,38 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, + "releaseSsrsLease": { + "description": "Release a lease for the setup of SQL Server Reporting Services (SSRS).", + "flatPath": "v1/projects/{project}/instances/{instance}/releaseSsrsLease", + "httpMethod": "POST", + "id": "sql.instances.releaseSsrsLease", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. The Cloud SQL instance ID. This doesn't include the project ID. The instance ID contains lowercase letters, numbers, and hyphens, and it must start with a letter. This ID can have a maximum length of 98 characters.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. The project ID that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/releaseSsrsLease", + "response": { + "$ref": "SqlInstancesReleaseSsrsLeaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "resetSslConfig": { "description": "Deletes all client certificates and generates a new server SSL certificate for the instance.", "flatPath": "v1/projects/{project}/instances/{instance}/resetSslConfig", @@ -2200,7 +2267,7 @@ } } }, - "revision": "20240219", + "revision": "20240304", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2227,6 +2294,30 @@ }, "type": "object" }, + "AcquireSsrsLeaseContext": { + "description": "Acquire SSRS lease context.", + "id": "AcquireSsrsLeaseContext", + "properties": { + "duration": { + "description": "Lease duration needed for SSRS setup.", + "format": "google-duration", + "type": "string" + }, + "reportDatabase": { + "description": "The report database to be used for SSRS setup.", + "type": "string" + }, + "serviceLogin": { + "description": "The username to be used as the service login to connect to the report database for SSRS setup.", + "type": "string" + }, + "setupLogin": { + "description": "The username to be used as the setup login to connect to the database server for SSRS setup.", + "type": "string" + } + }, + "type": "object" + }, "AdvancedMachineFeatures": { "description": "Specifies options for controlling advanced machine features.", "id": "AdvancedMachineFeatures", @@ -2650,6 +2741,10 @@ "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -2696,6 +2791,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2728,6 +2827,10 @@ "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -2924,6 +3027,10 @@ "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -2970,6 +3077,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3002,6 +3113,10 @@ "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3618,6 +3733,10 @@ "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3664,6 +3783,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3696,6 +3819,10 @@ "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3996,6 +4123,17 @@ }, "type": "object" }, + "InstancesAcquireSsrsLeaseRequest": { + "description": "Request to acquire a lease for SSRS.", + "id": "InstancesAcquireSsrsLeaseRequest", + "properties": { + "acquireSsrsLeaseContext": { + "$ref": "AcquireSsrsLeaseContext", + "description": "Contains details about the acquire SSRS lease operation." + } + }, + "type": "object" + }, "InstancesCloneRequest": { "description": "Database instance clone request.", "id": "InstancesCloneRequest", @@ -4419,6 +4557,10 @@ "description": "An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.", "id": "Operation", "properties": { + "acquireSsrsLeaseContext": { + "$ref": "AcquireSsrsLeaseContext", + "description": "The context for acquire SSRS lease operation, if applicable." + }, "apiWarning": { "$ref": "ApiWarning", "description": "An Admin API warning message." @@ -4498,7 +4640,9 @@ "LOG_CLEANUP", "AUTO_RESTART", "REENCRYPT", - "SWITCHOVER" + "SWITCHOVER", + "ACQUIRE_SSRS_LEASE", + "RELEASE_SSRS_LEASE" ], "enumDeprecated": [ false, @@ -4539,6 +4683,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -4580,7 +4726,9 @@ "Recovers logs from an instance's old data disk.", "Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery.", "Re-encrypts CMEK instances with latest key version.", - "Switches over to replica instance from primary." + "Switches over to replica instance from primary.", + "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", + "Release a lease for the setup of SQL Server Reporting Services (SSRS)." ], "type": "string" }, @@ -5062,6 +5210,10 @@ ], "type": "string" }, + "enableGoogleMlIntegration": { + "description": "Optional. Configuration to enable Cloud SQL Vertex AI Integration", + "type": "boolean" + }, "insightsConfig": { "$ref": "InsightsConfig", "description": "Insights configuration, for now relevant only for Postgres." @@ -5279,6 +5431,17 @@ }, "type": "object" }, + "SqlInstancesAcquireSsrsLeaseResponse": { + "description": "Response for the acquire SSRS lease request.", + "id": "SqlInstancesAcquireSsrsLeaseResponse", + "properties": { + "operationId": { + "description": "The unique identifier for this operation.", + "type": "string" + } + }, + "type": "object" + }, "SqlInstancesGetDiskShrinkConfigResponse": { "description": "Instance get disk shrink config response.", "id": "SqlInstancesGetDiskShrinkConfigResponse", @@ -5315,6 +5478,17 @@ }, "type": "object" }, + "SqlInstancesReleaseSsrsLeaseResponse": { + "description": "Response for the release SSRS lease request.", + "id": "SqlInstancesReleaseSsrsLeaseResponse", + "properties": { + "operationId": { + "description": "The unique identifier for this operation.", + "type": "string" + } + }, + "type": "object" + }, "SqlInstancesRescheduleMaintenanceRequestBody": { "description": "Reschedule options for maintenance windows.", "id": "SqlInstancesRescheduleMaintenanceRequestBody", @@ -5399,6 +5573,22 @@ ], "type": "string" }, + "syncParallelLevel": { + "description": "Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL.", + "enum": [ + "EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED", + "MIN", + "OPTIMAL", + "MAX" + ], + "enumDescriptions": [ + "Unknown sync parallel level. Will be defaulted to OPTIMAL.", + "Minimal parallel level.", + "Optimal parallel level.", + "Maximum parallel level." + ], + "type": "string" + }, "verifyConnectionOnly": { "description": "Flag to enable verifying connection only", "type": "boolean" diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 20ee9e30d03..50d4583ca9f 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -608,6 +608,41 @@ }, "instances": { "methods": { + "acquireSsrsLease": { + "description": "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", + "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/acquireSsrsLease", + "httpMethod": "POST", + "id": "sql.instances.acquireSsrsLease", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id).", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. ID of the project that contains the instance (Example: project-id).", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/projects/{project}/instances/{instance}/acquireSsrsLease", + "request": { + "$ref": "InstancesAcquireSsrsLeaseRequest" + }, + "response": { + "$ref": "SqlInstancesAcquireSsrsLeaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "addServerCa": { "description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa", @@ -1120,6 +1155,38 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, + "releaseSsrsLease": { + "description": "Release a lease for the setup of SQL Server Reporting Services (SSRS).", + "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/releaseSsrsLease", + "httpMethod": "POST", + "id": "sql.instances.releaseSsrsLease", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. The Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id).", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. The ID of the project that contains the instance (Example: project-id).", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/projects/{project}/instances/{instance}/releaseSsrsLease", + "response": { + "$ref": "SqlInstancesReleaseSsrsLeaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "resetSslConfig": { "description": "Deletes all client certificates and generates a new server SSL certificate for the instance.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig", @@ -2200,7 +2267,7 @@ } } }, - "revision": "20240219", + "revision": "20240304", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2227,6 +2294,30 @@ }, "type": "object" }, + "AcquireSsrsLeaseContext": { + "description": "Acquire SSRS lease context.", + "id": "AcquireSsrsLeaseContext", + "properties": { + "duration": { + "description": "Lease duration needed for the SSRS setup.", + "format": "google-duration", + "type": "string" + }, + "reportDatabase": { + "description": "The report database to be used for the SSRS setup.", + "type": "string" + }, + "serviceLogin": { + "description": "The username to be used as the service login to connect to the report database for SSRS setup.", + "type": "string" + }, + "setupLogin": { + "description": "The username to be used as the setup login to connect to the database server for SSRS setup.", + "type": "string" + } + }, + "type": "object" + }, "AdvancedMachineFeatures": { "description": "Specifies options for controlling advanced machine features.", "id": "AdvancedMachineFeatures", @@ -2650,6 +2741,10 @@ "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -2696,6 +2791,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2728,6 +2827,10 @@ "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -2924,6 +3027,10 @@ "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -2970,6 +3077,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3002,6 +3113,10 @@ "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3619,6 +3734,10 @@ "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3665,6 +3784,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3697,6 +3820,10 @@ "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3997,6 +4124,17 @@ }, "type": "object" }, + "InstancesAcquireSsrsLeaseRequest": { + "description": "Request to acquire an SSRS lease for an instance.", + "id": "InstancesAcquireSsrsLeaseRequest", + "properties": { + "acquireSsrsLeaseContext": { + "$ref": "AcquireSsrsLeaseContext", + "description": "Contains details about the acquire SSRS lease operation." + } + }, + "type": "object" + }, "InstancesCloneRequest": { "description": "Database instance clone request.", "id": "InstancesCloneRequest", @@ -4420,6 +4558,10 @@ "description": "An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.", "id": "Operation", "properties": { + "acquireSsrsLeaseContext": { + "$ref": "AcquireSsrsLeaseContext", + "description": "The context for acquire SSRS lease operation, if applicable." + }, "apiWarning": { "$ref": "ApiWarning", "description": "An Admin API warning message." @@ -4499,7 +4641,9 @@ "LOG_CLEANUP", "AUTO_RESTART", "REENCRYPT", - "SWITCHOVER" + "SWITCHOVER", + "ACQUIRE_SSRS_LEASE", + "RELEASE_SSRS_LEASE" ], "enumDeprecated": [ false, @@ -4540,6 +4684,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -4581,7 +4727,9 @@ "Recovers logs from an instance's old data disk.", "Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery.", "Re-encrypts CMEK instances with latest key version.", - "Switches over to replica instance from primary." + "Switches over to replica instance from primary.", + "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", + "Release a lease for the setup of SQL Server Reporting Services (SSRS)." ], "type": "string" }, @@ -5063,6 +5211,10 @@ ], "type": "string" }, + "enableGoogleMlIntegration": { + "description": "Optional. Configuration to enable Cloud SQL Vertex AI Integration", + "type": "boolean" + }, "insightsConfig": { "$ref": "InsightsConfig", "description": "Insights configuration, for now relevant only for Postgres." @@ -5280,6 +5432,17 @@ }, "type": "object" }, + "SqlInstancesAcquireSsrsLeaseResponse": { + "description": "Acquire SSRS lease response.", + "id": "SqlInstancesAcquireSsrsLeaseResponse", + "properties": { + "operationId": { + "description": "The unique identifier for this operation.", + "type": "string" + } + }, + "type": "object" + }, "SqlInstancesGetDiskShrinkConfigResponse": { "description": "Instance get disk shrink config response.", "id": "SqlInstancesGetDiskShrinkConfigResponse", @@ -5316,6 +5479,17 @@ }, "type": "object" }, + "SqlInstancesReleaseSsrsLeaseResponse": { + "description": "The response for the release of the SSRS lease.", + "id": "SqlInstancesReleaseSsrsLeaseResponse", + "properties": { + "operationId": { + "description": "The operation ID.", + "type": "string" + } + }, + "type": "object" + }, "SqlInstancesRescheduleMaintenanceRequestBody": { "description": "Reschedule options for maintenance windows.", "id": "SqlInstancesRescheduleMaintenanceRequestBody", @@ -5398,6 +5572,22 @@ ], "type": "string" }, + "syncParallelLevel": { + "description": "Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL.", + "enum": [ + "EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED", + "MIN", + "OPTIMAL", + "MAX" + ], + "enumDescriptions": [ + "Unknown sync parallel level. Will be defaulted to OPTIMAL.", + "Minimal parallel level.", + "Optimal parallel level.", + "Maximum parallel level." + ], + "type": "string" + }, "verifyConnectionOnly": { "description": "Flag to enable verifying connection only", "type": "boolean" diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index 13bff4c1cd5..b5cb77f05ea 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -163,6 +163,27 @@ export namespace sqladmin_v1 { */ value?: string | null; } + /** + * Acquire SSRS lease context. + */ + export interface Schema$AcquireSsrsLeaseContext { + /** + * Lease duration needed for SSRS setup. + */ + duration?: string | null; + /** + * The report database to be used for SSRS setup. + */ + reportDatabase?: string | null; + /** + * The username to be used as the service login to connect to the report database for SSRS setup. + */ + serviceLogin?: string | null; + /** + * The username to be used as the setup login to connect to the database server for SSRS setup. + */ + setupLogin?: string | null; + } /** * Specifies options for controlling advanced machine features. */ @@ -1066,6 +1087,15 @@ export namespace sqladmin_v1 { */ region?: string | null; } + /** + * Request to acquire a lease for SSRS. + */ + export interface Schema$InstancesAcquireSsrsLeaseRequest { + /** + * Contains details about the acquire SSRS lease operation. + */ + acquireSsrsLeaseContext?: Schema$AcquireSsrsLeaseContext; + } /** * Database instance clone request. */ @@ -1390,6 +1420,10 @@ export namespace sqladmin_v1 { * An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. */ export interface Schema$Operation { + /** + * The context for acquire SSRS lease operation, if applicable. + */ + acquireSsrsLeaseContext?: Schema$AcquireSsrsLeaseContext; /** * An Admin API warning message. */ @@ -1741,6 +1775,10 @@ export namespace sqladmin_v1 { * Optional. The edition of the instance. */ edition?: string | null; + /** + * Optional. Configuration to enable Cloud SQL Vertex AI Integration + */ + enableGoogleMlIntegration?: boolean | null; /** * Insights configuration, for now relevant only for Postgres. */ @@ -1832,6 +1870,15 @@ export namespace sqladmin_v1 { */ type?: string | null; } + /** + * Response for the acquire SSRS lease request. + */ + export interface Schema$SqlInstancesAcquireSsrsLeaseResponse { + /** + * The unique identifier for this operation. + */ + operationId?: string | null; + } /** * Instance get disk shrink config response. */ @@ -1862,6 +1909,15 @@ export namespace sqladmin_v1 { */ latestRecoveryTime?: string | null; } + /** + * Response for the release SSRS lease request. + */ + export interface Schema$SqlInstancesReleaseSsrsLeaseResponse { + /** + * The unique identifier for this operation. + */ + operationId?: string | null; + } /** * Reschedule options for maintenance windows. */ @@ -1908,6 +1964,10 @@ export namespace sqladmin_v1 { * External sync mode */ syncMode?: string | null; + /** + * Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL. + */ + syncParallelLevel?: string | null; /** * Flag to enable verifying connection only */ @@ -3639,6 +3699,102 @@ export namespace sqladmin_v1 { this.context = context; } + /** + * Acquire a lease for the setup of SQL Server Reporting Services (SSRS). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + acquireSsrsLease( + params: Params$Resource$Instances$Acquiressrslease, + options: StreamMethodOptions + ): GaxiosPromise; + acquireSsrsLease( + params?: Params$Resource$Instances$Acquiressrslease, + options?: MethodOptions + ): GaxiosPromise; + acquireSsrsLease( + params: Params$Resource$Instances$Acquiressrslease, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + acquireSsrsLease( + params: Params$Resource$Instances$Acquiressrslease, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + acquireSsrsLease( + params: Params$Resource$Instances$Acquiressrslease, + callback: BodyResponseCallback + ): void; + acquireSsrsLease( + callback: BodyResponseCallback + ): void; + acquireSsrsLease( + paramsOrCallback?: + | Params$Resource$Instances$Acquiressrslease + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Acquiressrslease; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Acquiressrslease; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/acquireSsrsLease' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. * @@ -4940,6 +5096,102 @@ export namespace sqladmin_v1 { } } + /** + * Release a lease for the setup of SQL Server Reporting Services (SSRS). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + releaseSsrsLease( + params: Params$Resource$Instances$Releasessrslease, + options: StreamMethodOptions + ): GaxiosPromise; + releaseSsrsLease( + params?: Params$Resource$Instances$Releasessrslease, + options?: MethodOptions + ): GaxiosPromise; + releaseSsrsLease( + params: Params$Resource$Instances$Releasessrslease, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + releaseSsrsLease( + params: Params$Resource$Instances$Releasessrslease, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + releaseSsrsLease( + params: Params$Resource$Instances$Releasessrslease, + callback: BodyResponseCallback + ): void; + releaseSsrsLease( + callback: BodyResponseCallback + ): void; + releaseSsrsLease( + paramsOrCallback?: + | Params$Resource$Instances$Releasessrslease + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Releasessrslease; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Releasessrslease; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/releaseSsrsLease' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Deletes all client certificates and generates a new server SSL certificate for the instance. * @@ -5720,6 +5972,22 @@ export namespace sqladmin_v1 { } } + export interface Params$Resource$Instances$Acquiressrslease + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id). + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance (Example: project-id). + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesAcquireSsrsLeaseRequest; + } export interface Params$Resource$Instances$Addserverca extends StandardParameters { /** @@ -5929,6 +6197,17 @@ export namespace sqladmin_v1 { */ requestBody?: Schema$InstancesReencryptRequest; } + export interface Params$Resource$Instances$Releasessrslease + extends StandardParameters { + /** + * Required. The Cloud SQL instance ID. This doesn't include the project ID. The instance ID contains lowercase letters, numbers, and hyphens, and it must start with a letter. This ID can have a maximum length of 98 characters. + */ + instance?: string; + /** + * Required. The project ID that contains the instance. + */ + project?: string; + } export interface Params$Resource$Instances$Resetsslconfig extends StandardParameters { /** diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index f58d59fe772..e8425aa237b 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -163,6 +163,27 @@ export namespace sqladmin_v1beta4 { */ value?: string | null; } + /** + * Acquire SSRS lease context. + */ + export interface Schema$AcquireSsrsLeaseContext { + /** + * Lease duration needed for the SSRS setup. + */ + duration?: string | null; + /** + * The report database to be used for the SSRS setup. + */ + reportDatabase?: string | null; + /** + * The username to be used as the service login to connect to the report database for SSRS setup. + */ + serviceLogin?: string | null; + /** + * The username to be used as the setup login to connect to the database server for SSRS setup. + */ + setupLogin?: string | null; + } /** * Specifies options for controlling advanced machine features. */ @@ -1069,6 +1090,15 @@ export namespace sqladmin_v1beta4 { */ region?: string | null; } + /** + * Request to acquire an SSRS lease for an instance. + */ + export interface Schema$InstancesAcquireSsrsLeaseRequest { + /** + * Contains details about the acquire SSRS lease operation. + */ + acquireSsrsLeaseContext?: Schema$AcquireSsrsLeaseContext; + } /** * Database instance clone request. */ @@ -1393,6 +1423,10 @@ export namespace sqladmin_v1beta4 { * An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. */ export interface Schema$Operation { + /** + * The context for acquire SSRS lease operation, if applicable. + */ + acquireSsrsLeaseContext?: Schema$AcquireSsrsLeaseContext; /** * An Admin API warning message. */ @@ -1744,6 +1778,10 @@ export namespace sqladmin_v1beta4 { * Optional. The edition of the instance. */ edition?: string | null; + /** + * Optional. Configuration to enable Cloud SQL Vertex AI Integration + */ + enableGoogleMlIntegration?: boolean | null; /** * Insights configuration, for now relevant only for Postgres. */ @@ -1835,6 +1873,15 @@ export namespace sqladmin_v1beta4 { */ type?: string | null; } + /** + * Acquire SSRS lease response. + */ + export interface Schema$SqlInstancesAcquireSsrsLeaseResponse { + /** + * The unique identifier for this operation. + */ + operationId?: string | null; + } /** * Instance get disk shrink config response. */ @@ -1865,6 +1912,15 @@ export namespace sqladmin_v1beta4 { */ latestRecoveryTime?: string | null; } + /** + * The response for the release of the SSRS lease. + */ + export interface Schema$SqlInstancesReleaseSsrsLeaseResponse { + /** + * The operation ID. + */ + operationId?: string | null; + } /** * Reschedule options for maintenance windows. */ @@ -1905,6 +1961,10 @@ export namespace sqladmin_v1beta4 { * External sync mode */ syncMode?: string | null; + /** + * Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL. + */ + syncParallelLevel?: string | null; /** * Flag to enable verifying connection only */ @@ -3640,6 +3700,102 @@ export namespace sqladmin_v1beta4 { this.context = context; } + /** + * Acquire a lease for the setup of SQL Server Reporting Services (SSRS). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + acquireSsrsLease( + params: Params$Resource$Instances$Acquiressrslease, + options: StreamMethodOptions + ): GaxiosPromise; + acquireSsrsLease( + params?: Params$Resource$Instances$Acquiressrslease, + options?: MethodOptions + ): GaxiosPromise; + acquireSsrsLease( + params: Params$Resource$Instances$Acquiressrslease, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + acquireSsrsLease( + params: Params$Resource$Instances$Acquiressrslease, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + acquireSsrsLease( + params: Params$Resource$Instances$Acquiressrslease, + callback: BodyResponseCallback + ): void; + acquireSsrsLease( + callback: BodyResponseCallback + ): void; + acquireSsrsLease( + paramsOrCallback?: + | Params$Resource$Instances$Acquiressrslease + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Acquiressrslease; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Acquiressrslease; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/acquireSsrsLease' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. * @@ -4945,6 +5101,102 @@ export namespace sqladmin_v1beta4 { } } + /** + * Release a lease for the setup of SQL Server Reporting Services (SSRS). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + releaseSsrsLease( + params: Params$Resource$Instances$Releasessrslease, + options: StreamMethodOptions + ): GaxiosPromise; + releaseSsrsLease( + params?: Params$Resource$Instances$Releasessrslease, + options?: MethodOptions + ): GaxiosPromise; + releaseSsrsLease( + params: Params$Resource$Instances$Releasessrslease, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + releaseSsrsLease( + params: Params$Resource$Instances$Releasessrslease, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + releaseSsrsLease( + params: Params$Resource$Instances$Releasessrslease, + callback: BodyResponseCallback + ): void; + releaseSsrsLease( + callback: BodyResponseCallback + ): void; + releaseSsrsLease( + paramsOrCallback?: + | Params$Resource$Instances$Releasessrslease + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Releasessrslease; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Releasessrslease; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/releaseSsrsLease' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Deletes all client certificates and generates a new server SSL certificate for the instance. * @@ -5727,6 +5979,22 @@ export namespace sqladmin_v1beta4 { } } + export interface Params$Resource$Instances$Acquiressrslease + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id). + */ + instance?: string; + /** + * Required. ID of the project that contains the instance (Example: project-id). + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesAcquireSsrsLeaseRequest; + } export interface Params$Resource$Instances$Addserverca extends StandardParameters { /** @@ -5936,6 +6204,17 @@ export namespace sqladmin_v1beta4 { */ requestBody?: Schema$InstancesReencryptRequest; } + export interface Params$Resource$Instances$Releasessrslease + extends StandardParameters { + /** + * Required. The Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id). + */ + instance?: string; + /** + * Required. The ID of the project that contains the instance (Example: project-id). + */ + project?: string; + } export interface Params$Resource$Instances$Resetsslconfig extends StandardParameters { /** From 7c5e1b3a32459c1cc9b72f7c6055115c7c451176 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 70/78] feat(storage)!: update the API BREAKING CHANGE: This release has breaking changes. #### storage:v1 The following keys were deleted: - resources.objects.methods.restore.request.$ref --- discovery/storage-v1.json | 7 ++----- src/apis/storage/v1.ts | 5 ----- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index da16b2a878d..81192115bc3 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -33,7 +33,7 @@ "description": "Regional Endpoint" } ], - "etag": "\"38323435363539393136323237323334303838\"", + "etag": "\"37303437343235343136323638383931333233\"", "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" @@ -3212,9 +3212,6 @@ } }, "path": "b/{bucket}/o/{object}/restore", - "request": { - "$ref": "Object" - }, "response": { "$ref": "Object" }, @@ -4040,7 +4037,7 @@ } } }, - "revision": "20240217", + "revision": "20240307", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 0db7873e34b..dd1c13e1db9 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -8599,11 +8599,6 @@ export namespace storage_v1 { * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Object; } export interface Params$Resource$Objects$Rewrite extends StandardParameters { /** From e2ad916923bebb3224bfda4ee26a8c0b9a5b0139 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 71/78] feat(storagetransfer)!: update the API BREAKING CHANGE: This release has breaking changes. #### storagetransfer:v1 The following keys were deleted: - schemas.BatchTaskSpec.id - schemas.BatchTaskSpec.properties.deleteObjectTaskSpec.$ref - schemas.BatchTaskSpec.properties.listTaskSpec.$ref - schemas.BatchTaskSpec.properties.metadataTaskSpec.$ref - schemas.BatchTaskSpec.type - schemas.DeleteObjectTaskSpec.id - schemas.DeleteObjectTaskSpec.properties.generation.format - schemas.DeleteObjectTaskSpec.properties.generation.type - schemas.DeleteObjectTaskSpec.properties.hardDeleteVersionedObject.type - schemas.DeleteObjectTaskSpec.properties.name.type - schemas.DeleteObjectTaskSpec.properties.size.format - schemas.DeleteObjectTaskSpec.properties.size.type - schemas.DeleteObjectTaskSpec.type - schemas.ListTaskSpec.id - schemas.ListTaskSpec.properties.manifest.$ref - schemas.ListTaskSpec.properties.objectPrefixes.$ref - schemas.ListTaskSpec.type - schemas.Manifest.id - schemas.Manifest.properties.manifestLocation.type - schemas.Manifest.properties.root.type - schemas.Manifest.type - schemas.MetadataTaskSpec.id - schemas.MetadataTaskSpec.properties.bucketName.type - schemas.MetadataTaskSpec.properties.generation.format - schemas.MetadataTaskSpec.properties.generation.type - schemas.MetadataTaskSpec.properties.key.type - schemas.MetadataTaskSpec.properties.size.format - schemas.MetadataTaskSpec.properties.size.type - schemas.MetadataTaskSpec.type - schemas.ObjectPrefix.id - schemas.ObjectPrefix.properties.bucketName.type - schemas.ObjectPrefix.properties.objectPrefix.type - schemas.ObjectPrefix.type - schemas.ObjectPrefixes.id - schemas.ObjectPrefixes.properties.objectPrefixes.items.$ref - schemas.ObjectPrefixes.properties.objectPrefixes.type - schemas.ObjectPrefixes.type The following keys were added: - schemas.ReplicationSpec.description - schemas.ReplicationSpec.id - schemas.ReplicationSpec.properties.gcsDataSink.$ref - schemas.ReplicationSpec.properties.gcsDataSink.description - schemas.ReplicationSpec.properties.gcsDataSource.$ref - schemas.ReplicationSpec.properties.gcsDataSource.description - schemas.ReplicationSpec.properties.objectConditions.$ref - schemas.ReplicationSpec.properties.objectConditions.description - schemas.ReplicationSpec.properties.transferOptions.$ref - schemas.ReplicationSpec.properties.transferOptions.description - schemas.ReplicationSpec.type - schemas.TransferJob.properties.replicationSpec.$ref - schemas.TransferJob.properties.replicationSpec.description The following keys were changed: - resources.transferOperations.methods.list.parameters.filter.description - schemas.AwsS3Data.properties.cloudfrontDomain.description - schemas.AwsS3Data.properties.credentialsSecret.description - schemas.AzureBlobStorageData.properties.credentialsSecret.description - schemas.GcsData.properties.managedFolderTransferEnabled.description --- discovery/storagetransfer-v1.json | 142 +++++++----------------------- src/apis/storagetransfer/v1.ts | 67 +++++++------- 2 files changed, 63 insertions(+), 146 deletions(-) diff --git a/discovery/storagetransfer-v1.json b/discovery/storagetransfer-v1.json index 78f9e81737b..f3602e0929a 100644 --- a/discovery/storagetransfer-v1.json +++ b/discovery/storagetransfer-v1.json @@ -541,7 +541,7 @@ ], "parameters": { "filter": { - "description": "Required. A list of query parameters specified as JSON text in the form of: `{\"projectId\":\"my_project_id\", \"jobNames\":[\"jobid1\",\"jobid2\",...], \"operationNames\":[\"opid1\",\"opid2\",...], \"transferStatuses\":[\"status1\",\"status2\",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is required. `jobNames`, `operationNames`, and `transferStatuses` are optional. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.", + "description": "Required. A list of query parameters specified as JSON text in the form of: `{\"projectId\":\"my_project_id\", \"jobNames\":[\"jobid1\",\"jobid2\",...], \"jobNamePattern\": \"job_name_pattern\", \"operationNames\":[\"opid1\",\"opid2\",...], \"operationNamePattern\": \"operation_name_pattern\", \"minCreationTime\": \"min_creation_time\", \"maxCreationTime\": \"max_creation_time\", \"transferStatuses\":[\"status1\",\"status2\",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is the only argument that is required. If specified, `jobNamePattern` and `operationNamePattern` must match the full job or operation name respectively. '*' is a wildcard matching 0 or more characters. `minCreationTime` and `maxCreationTime` should be timestamps encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.", "location": "query", "required": true, "type": "string" @@ -632,7 +632,7 @@ } } }, - "revision": "20240217", + "revision": "20240311", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -726,11 +726,11 @@ "type": "string" }, "cloudfrontDomain": { - "description": "Optional. Cloudfront domain name pointing to this bucket (as origin), to use when fetching. Format: `https://{id}.cloudfront.net` or any valid custom domain `https://...`", + "description": "Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching. See [Transfer from S3 via CloudFront](https://cloud.google.com/storage-transfer/docs/s3-cloudfront) for more information. Format: `https://{id}.cloudfront.net` or any valid custom domain. Must begin with `https://`.", "type": "string" }, "credentialsSecret": { - "description": "Optional. The Resource name of a secret in Secret Manager. AWS credentials must be stored in Secret Manager in JSON format: { \"access_key_id\": \"ACCESS_KEY_ID\", \"secret_access_key\": \"SECRET_ACCESS_KEY\" } GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Amazon S3] (https://cloud.google.com/storage-transfer/docs/source-amazon-s3#secret_manager) for more information. If `credentials_secret` is specified, do not specify role_arn or aws_access_key. This feature is in [preview](https://cloud.google.com/terms/service-terms#1). Format: `projects/{project_number}/secrets/{secret_name}`", + "description": "Optional. The Resource name of a secret in Secret Manager. AWS credentials must be stored in Secret Manager in JSON format: { \"access_key_id\": \"ACCESS_KEY_ID\", \"secret_access_key\": \"SECRET_ACCESS_KEY\" } GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Amazon S3] (https://cloud.google.com/storage-transfer/docs/source-amazon-s3#secret_manager) for more information. If `credentials_secret` is specified, do not specify role_arn or aws_access_key. Format: `projects/{project_number}/secrets/{secret_name}`", "type": "string" }, "path": { @@ -757,7 +757,7 @@ "type": "string" }, "credentialsSecret": { - "description": "Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { \"sas_token\" : \"SAS_TOKEN\" } GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify azure_credentials. This feature is in [preview](https://cloud.google.com/terms/service-terms#1). Format: `projects/{project_number}/secrets/{secret_name}`", + "description": "Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { \"sas_token\" : \"SAS_TOKEN\" } GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify azure_credentials. Format: `projects/{project_number}/secrets/{secret_name}`", "type": "string" }, "path": { @@ -794,21 +794,6 @@ }, "type": "object" }, - "BatchTaskSpec": { - "id": "BatchTaskSpec", - "properties": { - "deleteObjectTaskSpec": { - "$ref": "DeleteObjectTaskSpec" - }, - "listTaskSpec": { - "$ref": "ListTaskSpec" - }, - "metadataTaskSpec": { - "$ref": "MetadataTaskSpec" - } - }, - "type": "object" - }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -837,26 +822,6 @@ }, "type": "object" }, - "DeleteObjectTaskSpec": { - "id": "DeleteObjectTaskSpec", - "properties": { - "generation": { - "format": "int64", - "type": "string" - }, - "hardDeleteVersionedObject": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "size": { - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -972,7 +937,7 @@ "type": "string" }, "managedFolderTransferEnabled": { - "description": "Transfer managed folders is in public preview. This option is only applicable to the Cloud Storage source bucket. If set to true: - The source managed folder will be transferred to the destination bucket - The destination managed folder will always be overwritten, other OVERWRITE options will not be supported", + "description": "Preview. Enables the transfer of managed folders between Cloud Storage buckets. Set this option on the gcs_data_source. If set to true: - Managed folders in the source bucket are transferred to the destination bucket. - Managed folders in the destination bucket are overwritten. Other OVERWRITE options are not supported. See [Transfer Cloud Storage managed folders](/storage-transfer/docs/managed-folders).", "type": "boolean" }, "path": { @@ -1055,18 +1020,6 @@ }, "type": "object" }, - "ListTaskSpec": { - "id": "ListTaskSpec", - "properties": { - "manifest": { - "$ref": "Manifest" - }, - "objectPrefixes": { - "$ref": "ObjectPrefixes" - } - }, - "type": "object" - }, "ListTransferJobsResponse": { "description": "Response from ListTransferJobs.", "id": "ListTransferJobsResponse", @@ -1132,18 +1085,6 @@ }, "type": "object" }, - "Manifest": { - "id": "Manifest", - "properties": { - "manifestLocation": { - "type": "string" - }, - "root": { - "type": "string" - } - }, - "type": "object" - }, "MetadataOptions": { "description": "Specifies the metadata options for running a transfer.", "id": "MetadataOptions", @@ -1285,26 +1226,6 @@ }, "type": "object" }, - "MetadataTaskSpec": { - "id": "MetadataTaskSpec", - "properties": { - "bucketName": { - "type": "string" - }, - "generation": { - "format": "int64", - "type": "string" - }, - "key": { - "type": "string" - }, - "size": { - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, "NotificationConfig": { "description": "Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`: * `\"eventType\"`: one of the EventType values * `\"payloadFormat\"`: one of the PayloadFormat values * `\"projectId\"`: the project_id of the `TransferOperation` * `\"transferJobName\"`: the transfer_job_name of the `TransferOperation` * `\"transferOperationName\"`: the name of the `TransferOperation` The `PubsubMessage.data` contains a TransferOperation resource formatted according to the specified `PayloadFormat`.", "id": "NotificationConfig", @@ -1390,30 +1311,6 @@ }, "type": "object" }, - "ObjectPrefix": { - "id": "ObjectPrefix", - "properties": { - "bucketName": { - "type": "string" - }, - "objectPrefix": { - "type": "string" - } - }, - "type": "object" - }, - "ObjectPrefixes": { - "id": "ObjectPrefixes", - "properties": { - "objectPrefixes": { - "items": { - "$ref": "ObjectPrefix" - }, - "type": "array" - } - }, - "type": "object" - }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -1466,6 +1363,29 @@ }, "type": "object" }, + "ReplicationSpec": { + "description": "Specifies the configuration for running a replication job.", + "id": "ReplicationSpec", + "properties": { + "gcsDataSink": { + "$ref": "GcsData", + "description": "Specifies cloud Storage data sink." + }, + "gcsDataSource": { + "$ref": "GcsData", + "description": "Specifies cloud Storage data source." + }, + "objectConditions": { + "$ref": "ObjectConditions", + "description": "Specifies the object conditions to only include objects that satisfy these conditions in the set of data source objects. Object conditions based on objects' \"last modification time\" do not exclude objects in a data sink." + }, + "transferOptions": { + "$ref": "TransferOptions", + "description": "Specifies the actions to be performed on the object during replication. Delete options are not supported for replication and when specified, the request fails with an INVALID_ARGUMENT error." + } + }, + "type": "object" + }, "ResumeTransferOperationRequest": { "description": "Request passed to ResumeTransferOperation.", "id": "ResumeTransferOperationRequest", @@ -1790,6 +1710,10 @@ "description": "The ID of the Google Cloud project that owns the job.", "type": "string" }, + "replicationSpec": { + "$ref": "ReplicationSpec", + "description": "Replication specification." + }, "schedule": { "$ref": "Schedule", "description": "Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule." diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index b09813365c8..51c98df5c59 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -204,11 +204,11 @@ export namespace storagetransfer_v1 { */ bucketName?: string | null; /** - * Optional. Cloudfront domain name pointing to this bucket (as origin), to use when fetching. Format: `https://{id\}.cloudfront.net` or any valid custom domain `https://...` + * Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching. See [Transfer from S3 via CloudFront](https://cloud.google.com/storage-transfer/docs/s3-cloudfront) for more information. Format: `https://{id\}.cloudfront.net` or any valid custom domain. Must begin with `https://`. */ cloudfrontDomain?: string | null; /** - * Optional. The Resource name of a secret in Secret Manager. AWS credentials must be stored in Secret Manager in JSON format: { "access_key_id": "ACCESS_KEY_ID", "secret_access_key": "SECRET_ACCESS_KEY" \} GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Amazon S3] (https://cloud.google.com/storage-transfer/docs/source-amazon-s3#secret_manager) for more information. If `credentials_secret` is specified, do not specify role_arn or aws_access_key. This feature is in [preview](https://cloud.google.com/terms/service-terms#1). Format: `projects/{project_number\}/secrets/{secret_name\}` + * Optional. The Resource name of a secret in Secret Manager. AWS credentials must be stored in Secret Manager in JSON format: { "access_key_id": "ACCESS_KEY_ID", "secret_access_key": "SECRET_ACCESS_KEY" \} GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Amazon S3] (https://cloud.google.com/storage-transfer/docs/source-amazon-s3#secret_manager) for more information. If `credentials_secret` is specified, do not specify role_arn or aws_access_key. Format: `projects/{project_number\}/secrets/{secret_name\}` */ credentialsSecret?: string | null; /** @@ -233,7 +233,7 @@ export namespace storagetransfer_v1 { */ container?: string | null; /** - * Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" \} GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify azure_credentials. This feature is in [preview](https://cloud.google.com/terms/service-terms#1). Format: `projects/{project_number\}/secrets/{secret_name\}` + * Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" \} GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify azure_credentials. Format: `projects/{project_number\}/secrets/{secret_name\}` */ credentialsSecret?: string | null; /** @@ -263,11 +263,6 @@ export namespace storagetransfer_v1 { */ limitMbps?: string | null; } - export interface Schema$BatchTaskSpec { - deleteObjectTaskSpec?: Schema$DeleteObjectTaskSpec; - listTaskSpec?: Schema$ListTaskSpec; - metadataTaskSpec?: Schema$MetadataTaskSpec; - } /** * The request message for Operations.CancelOperation. */ @@ -289,12 +284,6 @@ export namespace storagetransfer_v1 { */ year?: number | null; } - export interface Schema$DeleteObjectTaskSpec { - generation?: string | null; - hardDeleteVersionedObject?: boolean | null; - name?: string | null; - size?: string | null; - } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -355,7 +344,7 @@ export namespace storagetransfer_v1 { */ bucketName?: string | null; /** - * Transfer managed folders is in public preview. This option is only applicable to the Cloud Storage source bucket. If set to true: - The source managed folder will be transferred to the destination bucket - The destination managed folder will always be overwritten, other OVERWRITE options will not be supported + * Preview. Enables the transfer of managed folders between Cloud Storage buckets. Set this option on the gcs_data_source. If set to true: - Managed folders in the source bucket are transferred to the destination bucket. - Managed folders in the destination bucket are overwritten. Other OVERWRITE options are not supported. See [Transfer Cloud Storage managed folders](/storage-transfer/docs/managed-folders). */ managedFolderTransferEnabled?: boolean | null; /** @@ -420,10 +409,6 @@ export namespace storagetransfer_v1 { */ operations?: Schema$Operation[]; } - export interface Schema$ListTaskSpec { - manifest?: Schema$Manifest; - objectPrefixes?: Schema$ObjectPrefixes; - } /** * Response from ListTransferJobs. */ @@ -454,10 +439,6 @@ export namespace storagetransfer_v1 { */ logActionStates?: string[] | null; } - export interface Schema$Manifest { - manifestLocation?: string | null; - root?: string | null; - } /** * Specifies the metadata options for running a transfer. */ @@ -499,12 +480,6 @@ export namespace storagetransfer_v1 { */ uid?: string | null; } - export interface Schema$MetadataTaskSpec { - bucketName?: string | null; - generation?: string | null; - key?: string | null; - size?: string | null; - } /** * Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` contains a TransferOperation resource formatted according to the specified `PayloadFormat`. */ @@ -551,13 +526,6 @@ export namespace storagetransfer_v1 { */ minTimeElapsedSinceLastModification?: string | null; } - export interface Schema$ObjectPrefix { - bucketName?: string | null; - objectPrefix?: string | null; - } - export interface Schema$ObjectPrefixes { - objectPrefixes?: Schema$ObjectPrefix[]; - } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -596,6 +564,27 @@ export namespace storagetransfer_v1 { */ rootDirectory?: string | null; } + /** + * Specifies the configuration for running a replication job. + */ + export interface Schema$ReplicationSpec { + /** + * Specifies cloud Storage data sink. + */ + gcsDataSink?: Schema$GcsData; + /** + * Specifies cloud Storage data source. + */ + gcsDataSource?: Schema$GcsData; + /** + * Specifies the object conditions to only include objects that satisfy these conditions in the set of data source objects. Object conditions based on objects' "last modification time" do not exclude objects in a data sink. + */ + objectConditions?: Schema$ObjectConditions; + /** + * Specifies the actions to be performed on the object during replication. Delete options are not supported for replication and when specified, the request fails with an INVALID_ARGUMENT error. + */ + transferOptions?: Schema$TransferOptions; + } /** * Request passed to ResumeTransferOperation. */ @@ -826,6 +815,10 @@ export namespace storagetransfer_v1 { * The ID of the Google Cloud project that owns the job. */ projectId?: string | null; + /** + * Replication specification. + */ + replicationSpec?: Schema$ReplicationSpec; /** * Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule. */ @@ -2677,7 +2670,7 @@ export namespace storagetransfer_v1 { export interface Params$Resource$Transferoperations$List extends StandardParameters { /** - * Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "operationNames":["opid1","opid2",...], "transferStatuses":["status1","status2",...]\}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is required. `jobNames`, `operationNames`, and `transferStatuses` are optional. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED. + * Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]\}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is the only argument that is required. If specified, `jobNamePattern` and `operationNamePattern` must match the full job or operation name respectively. '*' is a wildcard matching 0 or more characters. `minCreationTime` and `maxCreationTime` should be timestamps encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED. */ filter?: string; /** From 0ea62529dcc3df79d8f7b9008ab595e332b39ffa Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 72/78] feat(tasks): update the API #### tasks:v1 The following keys were added: - schemas.Task.properties.webViewLink.description - schemas.Task.properties.webViewLink.type --- discovery/tasks-v1.json | 6 +++++- src/apis/tasks/v1.ts | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/discovery/tasks-v1.json b/discovery/tasks-v1.json index 03d419d5582..8f2f86a9432 100644 --- a/discovery/tasks-v1.json +++ b/discovery/tasks-v1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20240225", + "revision": "20240312", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "Task": { @@ -648,6 +648,10 @@ "updated": { "description": "Last modification time of the task (as a RFC 3339 timestamp).", "type": "string" + }, + "webViewLink": { + "description": "An absolute link to the task in the Google Tasks Web UI. This field is read-only.", + "type": "string" } }, "type": "object" diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index ddd4c1a7dec..5eaaa1c4586 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -187,6 +187,10 @@ export namespace tasks_v1 { * Last modification time of the task (as a RFC 3339 timestamp). */ updated?: string | null; + /** + * An absolute link to the task in the Google Tasks Web UI. This field is read-only. + */ + webViewLink?: string | null; } export interface Schema$TaskList { /** From fb7c2ceebc99af5409ffc4788ebce5c0ca593cc1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 73/78] fix(walletobjects): update the API #### walletobjects:v1 The following keys were changed: - schemas.CallbackOptions.properties.updateRequestUrl.description - schemas.CallbackOptions.properties.url.description --- discovery/walletobjects-v1.json | 6 +++--- src/apis/walletobjects/v1.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/discovery/walletobjects-v1.json b/discovery/walletobjects-v1.json index eeae691e439..9e6ed5cd532 100644 --- a/discovery/walletobjects-v1.json +++ b/discovery/walletobjects-v1.json @@ -2681,7 +2681,7 @@ } } }, - "revision": "20240222", + "revision": "20240313", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -3153,11 +3153,11 @@ "properties": { "updateRequestUrl": { "deprecated": true, - "description": "URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. Deprecated.", + "description": "URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.", "type": "string" }, "url": { - "description": "The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables.", + "description": "The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.", "type": "string" } }, diff --git a/src/apis/walletobjects/v1.ts b/src/apis/walletobjects/v1.ts index c636c46cedd..613cc1e149f 100644 --- a/src/apis/walletobjects/v1.ts +++ b/src/apis/walletobjects/v1.ts @@ -370,11 +370,11 @@ export namespace walletobjects_v1 { } export interface Schema$CallbackOptions { /** - * URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. Deprecated. + * URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated. */ updateRequestUrl?: string | null; /** - * The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. + * The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. */ url?: string | null; } From d8ded700cad0e17213350a233351586e8450df4c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 74/78] feat(workloadmanager): update the API #### workloadmanager:v1 The following keys were added: - schemas.SapComponent.properties.haHosts.description - schemas.SapComponent.properties.haHosts.items.type - schemas.SapComponent.properties.haHosts.type - schemas.SapComponent.properties.topologyType.description - schemas.SapComponent.properties.topologyType.enum - schemas.SapComponent.properties.topologyType.enumDescriptions - schemas.SapComponent.properties.topologyType.type --- discovery/workloadmanager-v1.json | 23 ++++++++++++++++++++++- src/apis/workloadmanager/v1.ts | 8 ++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index 10c67fa8ce9..1f7bab8cf6e 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -838,7 +838,7 @@ } } }, - "revision": "20240208", + "revision": "20240228", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "APILayerServer": { @@ -1826,6 +1826,13 @@ "description": "The component of sap workload", "id": "SapComponent", "properties": { + "haHosts": { + "description": "A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.", + "items": { + "type": "string" + }, + "type": "array" + }, "resources": { "description": "Output only. resources in the component", "items": { @@ -1838,6 +1845,20 @@ "description": "Output only. sid is the sap component identificator", "readOnly": true, "type": "string" + }, + "topologyType": { + "description": "The detected topology of the component.", + "enum": [ + "TOPOLOGY_TYPE_UNSPECIFIED", + "TOPOLOGY_SCALE_UP", + "TOPOLOGY_SCALE_OUT" + ], + "enumDescriptions": [ + "Unspecified topology.", + "A scale-up single node system.", + "A scale-out multi-node system." + ], + "type": "string" } }, "type": "object" diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index 40d49404fe9..386a0c5b84a 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -796,6 +796,10 @@ export namespace workloadmanager_v1 { * The component of sap workload */ export interface Schema$SapComponent { + /** + * A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA. + */ + haHosts?: string[] | null; /** * Output only. resources in the component */ @@ -804,6 +808,10 @@ export namespace workloadmanager_v1 { * Output only. sid is the sap component identificator */ sid?: string | null; + /** + * The detected topology of the component. + */ + topologyType?: string | null; } /** * The schema of SAP system discovery data. From e26e7bc4f8638a0408abd7bc336ececf2acdf886 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 75/78] feat(workstations): update the API #### workstations:v1beta The following keys were added: - schemas.BoostConfig.description - schemas.BoostConfig.id - schemas.BoostConfig.properties.accelerators.description - schemas.BoostConfig.properties.accelerators.items.$ref - schemas.BoostConfig.properties.accelerators.type - schemas.BoostConfig.properties.id.description - schemas.BoostConfig.properties.id.type - schemas.BoostConfig.properties.machineType.description - schemas.BoostConfig.properties.machineType.type - schemas.BoostConfig.properties.poolSize.description - schemas.BoostConfig.properties.poolSize.format - schemas.BoostConfig.properties.poolSize.type - schemas.BoostConfig.type - schemas.GceInstance.properties.boostConfigs.description - schemas.GceInstance.properties.boostConfigs.items.$ref - schemas.GceInstance.properties.boostConfigs.type - schemas.StartWorkstationRequest.properties.boostConfig.description - schemas.StartWorkstationRequest.properties.boostConfig.type The following keys were changed: - schemas.GceInstance.properties.enableNestedVirtualization.description - schemas.GceRegionalPersistentDisk.description - schemas.WorkstationConfig.properties.disableTcpConnections.description #### workstations:v1 The following keys were added: - schemas.Accelerator.description - schemas.Accelerator.id - schemas.Accelerator.properties.count.description - schemas.Accelerator.properties.count.format - schemas.Accelerator.properties.count.type - schemas.Accelerator.properties.type.description - schemas.Accelerator.properties.type.type - schemas.Accelerator.type - schemas.EphemeralDirectory.description - schemas.EphemeralDirectory.id - schemas.EphemeralDirectory.properties.gcePd.$ref - schemas.EphemeralDirectory.properties.gcePd.description - schemas.EphemeralDirectory.properties.mountPath.description - schemas.EphemeralDirectory.properties.mountPath.type - schemas.EphemeralDirectory.type - schemas.GceInstance.properties.accelerators.description - schemas.GceInstance.properties.accelerators.items.$ref - schemas.GceInstance.properties.accelerators.type - schemas.GceInstance.properties.disableSsh.description - schemas.GceInstance.properties.disableSsh.type - schemas.GcePersistentDisk.description - schemas.GcePersistentDisk.id - schemas.GcePersistentDisk.properties.diskType.description - schemas.GcePersistentDisk.properties.diskType.type - schemas.GcePersistentDisk.properties.readOnly.description - schemas.GcePersistentDisk.properties.readOnly.type - schemas.GcePersistentDisk.properties.sourceImage.description - schemas.GcePersistentDisk.properties.sourceImage.type - schemas.GcePersistentDisk.properties.sourceSnapshot.description - schemas.GcePersistentDisk.properties.sourceSnapshot.type - schemas.GcePersistentDisk.type - schemas.WorkstationConfig.properties.ephemeralDirectories.description - schemas.WorkstationConfig.properties.ephemeralDirectories.items.$ref - schemas.WorkstationConfig.properties.ephemeralDirectories.type The following keys were changed: - schemas.GceInstance.properties.enableNestedVirtualization.description - schemas.GceRegionalPersistentDisk.description - schemas.WorkstationConfig.properties.disableTcpConnections.description --- discovery/workstations-v1.json | 80 ++++++++++++++++++++++++++++-- discovery/workstations-v1beta.json | 46 +++++++++++++++-- src/apis/workstations/v1.ts | 65 ++++++++++++++++++++++-- src/apis/workstations/v1beta.ts | 35 +++++++++++-- 4 files changed, 212 insertions(+), 14 deletions(-) diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index f136b5d5b15..3ebd189eaae 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -1195,9 +1195,25 @@ } } }, - "revision": "20240130", + "revision": "20240301", "rootUrl": "https://workstations.googleapis.com/", "schemas": { + "Accelerator": { + "description": "An accelerator card attached to the instance.", + "id": "Accelerator", + "properties": { + "count": { + "description": "Optional. Number of accelerator cards exposed to the instance.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "Optional. Type of accelerator resource to attach to the instance, for example, `\"nvidia-tesla-p100\"`.", + "type": "string" + } + }, + "type": "object" + }, "AuditConfig": { "description": "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.", "id": "AuditConfig", @@ -1341,6 +1357,21 @@ }, "type": "object" }, + "EphemeralDirectory": { + "description": "An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.", + "id": "EphemeralDirectory", + "properties": { + "gcePd": { + "$ref": "GcePersistentDisk", + "description": "An EphemeralDirectory backed by a Compute Engine persistent disk." + }, + "mountPath": { + "description": "Required. Location of this directory in the running workstation.", + "type": "string" + } + }, + "type": "object" + }, "Expr": { "description": "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.", "id": "Expr", @@ -1379,6 +1410,13 @@ "description": "A runtime using a Compute Engine instance.", "id": "GceInstance", "properties": { + "accelerators": { + "description": "Optional. A list of the type and count of accelerator cards attached to the instance.", + "items": { + "$ref": "Accelerator" + }, + "type": "array" + }, "bootDiskSizeGb": { "description": "Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.", "format": "int32", @@ -1392,8 +1430,12 @@ "description": "Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses).", "type": "boolean" }, + "disableSsh": { + "description": "Optional. Whether to disable SSH access to the VM.", + "type": "boolean" + }, "enableNestedVirtualization": { - "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", + "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", "type": "boolean" }, "machineType": { @@ -1436,8 +1478,31 @@ }, "type": "object" }, + "GcePersistentDisk": { + "description": "An EphemeralDirectory is backed by a Compute Engine persistent disk.", + "id": "GcePersistentDisk", + "properties": { + "diskType": { + "description": "Optional. Type of the disk to use. Defaults to `\"pd-standard\"`.", + "type": "string" + }, + "readOnly": { + "description": "Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.", + "type": "boolean" + }, + "sourceImage": { + "description": "Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.", + "type": "string" + }, + "sourceSnapshot": { + "description": "Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.", + "type": "string" + } + }, + "type": "object" + }, "GceRegionalPersistentDisk": { - "description": "A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.", + "description": "A Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.", "id": "GceRegionalPersistentDisk", "properties": { "diskType": { @@ -2247,7 +2312,7 @@ "type": "string" }, "disableTcpConnections": { - "description": "Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections via a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain tcp connections, such as ssh. When enabled, all communication must occur over https or wss.", + "description": "Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS.", "type": "boolean" }, "displayName": { @@ -2262,6 +2327,13 @@ "$ref": "CustomerEncryptionKey", "description": "Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created." }, + "ephemeralDirectories": { + "description": "Optional. Ephemeral directories which won't persist across workstation sessions.", + "items": { + "$ref": "EphemeralDirectory" + }, + "type": "array" + }, "etag": { "description": "Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.", "type": "string" diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index 08b0fb4b404..c2bd3fc9969 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -1127,7 +1127,7 @@ } } }, - "revision": "20240130", + "revision": "20240301", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1216,6 +1216,33 @@ }, "type": "object" }, + "BoostConfig": { + "description": "A configuration that workstations can boost to.", + "id": "BoostConfig", + "properties": { + "accelerators": { + "description": "Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`.", + "items": { + "$ref": "Accelerator" + }, + "type": "array" + }, + "id": { + "description": "Optional. Required. The id to be used for the boost config.", + "type": "string" + }, + "machineType": { + "description": "Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`.", + "type": "string" + }, + "poolSize": { + "description": "Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -1349,6 +1376,13 @@ }, "type": "array" }, + "boostConfigs": { + "description": "Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use.", + "items": { + "$ref": "BoostConfig" + }, + "type": "array" + }, "bootDiskSizeGb": { "description": "Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.", "format": "int32", @@ -1367,7 +1401,7 @@ "type": "boolean" }, "enableNestedVirtualization": { - "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", + "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", "type": "boolean" }, "machineType": { @@ -1434,7 +1468,7 @@ "type": "object" }, "GceRegionalPersistentDisk": { - "description": "A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.", + "description": "A Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.", "id": "GceRegionalPersistentDisk", "properties": { "diskType": { @@ -1872,6 +1906,10 @@ "description": "Request message for StartWorkstation.", "id": "StartWorkstationRequest", "properties": { + "boostConfig": { + "description": "Optional. If set, the workstation starts using the boost configuration with the specified ID.", + "type": "string" + }, "etag": { "description": "Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.", "type": "string" @@ -2192,7 +2230,7 @@ "type": "string" }, "disableTcpConnections": { - "description": "Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections via a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain tcp connections, such as ssh. When enabled, all communication must occur over https or wss.", + "description": "Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS.", "type": "boolean" }, "displayName": { diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index fbcd4061f38..9e3d88aaf34 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -124,6 +124,19 @@ export namespace workstations_v1 { } } + /** + * An accelerator card attached to the instance. + */ + export interface Schema$Accelerator { + /** + * Optional. Number of accelerator cards exposed to the instance. + */ + count?: number | null; + /** + * Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. + */ + type?: 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. */ @@ -222,6 +235,19 @@ export namespace workstations_v1 { */ domain?: string | null; } + /** + * An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation. + */ + export interface Schema$EphemeralDirectory { + /** + * An EphemeralDirectory backed by a Compute Engine persistent disk. + */ + gcePd?: Schema$GcePersistentDisk; + /** + * Required. Location of this directory in the running workstation. + */ + mountPath?: 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. */ @@ -256,6 +282,10 @@ export namespace workstations_v1 { * A runtime using a Compute Engine instance. */ export interface Schema$GceInstance { + /** + * Optional. A list of the type and count of accelerator cards attached to the instance. + */ + accelerators?: Schema$Accelerator[]; /** * Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. */ @@ -269,7 +299,11 @@ export namespace workstations_v1 { */ disablePublicIpAddresses?: boolean | null; /** - * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + * Optional. Whether to disable SSH access to the VM. + */ + disableSsh?: boolean | null; + /** + * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. */ enableNestedVirtualization?: boolean | null; /** @@ -302,7 +336,28 @@ export namespace workstations_v1 { tags?: string[] | null; } /** - * A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory. + * An EphemeralDirectory is backed by a Compute Engine persistent disk. + */ + export interface Schema$GcePersistentDisk { + /** + * Optional. Type of the disk to use. Defaults to `"pd-standard"`. + */ + diskType?: string | null; + /** + * Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set. + */ + readOnly?: boolean | null; + /** + * Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable. + */ + sourceImage?: string | null; + /** + * Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable. + */ + sourceSnapshot?: string | null; + } + /** + * A Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory. */ export interface Schema$GceRegionalPersistentDisk { /** @@ -885,7 +940,7 @@ export namespace workstations_v1 { */ deleteTime?: string | null; /** - * Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections via a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain tcp connections, such as ssh. When enabled, all communication must occur over https or wss. + * Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. */ disableTcpConnections?: boolean | null; /** @@ -900,6 +955,10 @@ export namespace workstations_v1 { * Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. */ encryptionKey?: Schema$CustomerEncryptionKey; + /** + * Optional. Ephemeral directories which won't persist across workstation sessions. + */ + ephemeralDirectories?: Schema$EphemeralDirectory[]; /** * Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. */ diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index 6bf51455b71..59493d86005 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -180,6 +180,27 @@ export namespace workstations_v1beta { */ role?: string | null; } + /** + * A configuration that workstations can boost to. + */ + export interface Schema$BoostConfig { + /** + * Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`. + */ + accelerators?: Schema$Accelerator[]; + /** + * Optional. Required. The id to be used for the boost config. + */ + id?: string | null; + /** + * Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. + */ + machineType?: string | null; + /** + * Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. + */ + poolSize?: number | null; + } /** * The request message for Operations.CancelOperation. */ @@ -286,6 +307,10 @@ export namespace workstations_v1beta { * Optional. A list of the type and count of accelerator cards attached to the instance. */ accelerators?: Schema$Accelerator[]; + /** + * Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. + */ + boostConfigs?: Schema$BoostConfig[]; /** * Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. */ @@ -303,7 +328,7 @@ export namespace workstations_v1beta { */ disableSsh?: boolean | null; /** - * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. */ enableNestedVirtualization?: boolean | null; /** @@ -357,7 +382,7 @@ export namespace workstations_v1beta { sourceSnapshot?: string | null; } /** - * A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory. + * A Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory. */ export interface Schema$GceRegionalPersistentDisk { /** @@ -678,6 +703,10 @@ export namespace workstations_v1beta { * Request message for StartWorkstation. */ export interface Schema$StartWorkstationRequest { + /** + * Optional. If set, the workstation starts using the boost configuration with the specified ID. + */ + boostConfig?: string | null; /** * Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */ @@ -902,7 +931,7 @@ export namespace workstations_v1beta { */ deleteTime?: string | null; /** - * Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections via a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain tcp connections, such as ssh. When enabled, all communication must occur over https or wss. + * Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. */ disableTcpConnections?: boolean | null; /** From b0cfa8e1b29ab4c822ee7e5c8881186940c6a05e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 76/78] feat(youtube): update the API #### youtube:v3 The following keys were added: - resources.playlistImages.methods.update.mediaUpload.accept - resources.playlistImages.methods.update.mediaUpload.maxSize - resources.playlistImages.methods.update.mediaUpload.protocols.resumable.multipart - resources.playlistImages.methods.update.mediaUpload.protocols.resumable.path - resources.playlistImages.methods.update.mediaUpload.protocols.simple.multipart - resources.playlistImages.methods.update.mediaUpload.protocols.simple.path - resources.playlistImages.methods.update.supportsMediaUpload - schemas.ChannelSettings.properties.moderateComments.deprecated - schemas.LiveChatMessageListResponse.properties.activePollItem.$ref - schemas.LiveChatMessageListResponse.properties.activePollItem.description --- discovery/youtube-v3.json | 28 ++++++++++++++++++++++++++-- src/apis/youtube/v3.ts | 23 +++++++++++++++++++++++ 2 files changed, 49 insertions(+), 2 deletions(-) diff --git a/discovery/youtube-v3.json b/discovery/youtube-v3.json index 0835fbdf1e3..b964a971414 100644 --- a/discovery/youtube-v3.json +++ b/discovery/youtube-v3.json @@ -2313,6 +2313,24 @@ "flatPath": "youtube/v3/playlistImages", "httpMethod": "PUT", "id": "youtube.playlistImages.update", + "mediaUpload": { + "accept": [ + "image/jpeg", + "image/png", + "application/octet-stream" + ], + "maxSize": "2097152", + "protocols": { + "resumable": { + "multipart": true, + "path": "/resumable/upload/youtube/v3/playlistImages" + }, + "simple": { + "multipart": true, + "path": "/upload/youtube/v3/playlistImages" + } + } + }, "parameterOrder": [], "parameters": { "onBehalfOfContentOwner": { @@ -2338,7 +2356,8 @@ "https://www.googleapis.com/auth/youtube", "https://www.googleapis.com/auth/youtube.force-ssl", "https://www.googleapis.com/auth/youtubepartner" - ] + ], + "supportsMediaUpload": true } } }, @@ -4018,7 +4037,7 @@ } } }, - "revision": "20240226", + "revision": "20240312", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -5337,6 +5356,7 @@ "type": "string" }, "moderateComments": { + "deprecated": true, "description": "Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.", "type": "boolean" }, @@ -8725,6 +8745,10 @@ "LiveChatMessageListResponse": { "id": "LiveChatMessageListResponse", "properties": { + "activePollItem": { + "$ref": "LiveChatMessage", + "description": "Set when there is an active poll." + }, "etag": { "description": "Etag of this resource.", "type": "string" diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index b18e3325c91..a799ba0052b 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -2418,6 +2418,10 @@ export namespace youtube_v3 { deletedMessageId?: string | null; } export interface Schema$LiveChatMessageListResponse { + /** + * Set when there is an active poll. + */ + activePollItem?: Schema$LiveChatMessage; /** * Etag of this resource. */ @@ -10010,6 +10014,10 @@ export namespace youtube_v3 { options ), params, + mediaUrl: (rootUrl + '/upload/youtube/v3/playlistImages').replace( + /([^:]\/)\/+/g, + '$1' + ), requiredParams: [], pathParams: [], context: this.context, @@ -10113,6 +10121,21 @@ export namespace youtube_v3 { * Request body metadata */ requestBody?: Schema$PlaylistImage; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; } export class Resource$Playlistitems { From ce9aead7b30538e3e5790d05b24253fd238d38bb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 14 Mar 2024 01:29:54 +0000 Subject: [PATCH 77/78] feat: regenerate index files --- discovery/adsense-v2.json | 3 +- discovery/androidpublisher-v3.json | 6 +- discovery/apigee-v1.json | 452 ++++++++++++++++++++++++- discovery/bigquerydatatransfer-v1.json | 29 +- discovery/checks-v1alpha.json | 8 +- discovery/dataflow-v1b3.json | 7 +- discovery/index.json | 45 +++ discovery/integrations-v1alpha.json | 57 +++- discovery/people-v1.json | 74 ++-- discovery/vault-v1.json | 18 +- discovery/workspaceevents-v1.json | 36 +- src/apis/index.ts | 6 + src/index.ts | 3 + 13 files changed, 689 insertions(+), 55 deletions(-) diff --git a/discovery/adsense-v2.json b/discovery/adsense-v2.json index a8b47d747a5..03d8bbd0c02 100644 --- a/discovery/adsense-v2.json +++ b/discovery/adsense-v2.json @@ -17,6 +17,7 @@ "description": "The AdSense Management API allows publishers to access their inventory and run earnings and performance reports.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/adsense/management/", + "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -1844,7 +1845,7 @@ } } }, - "revision": "20231018", + "revision": "20240313", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index f0e91524f6a..373ba60e1ed 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -4726,7 +4726,7 @@ } } }, - "revision": "20240222", + "revision": "20240313", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -7745,12 +7745,12 @@ "enum": [ "EXTERNAL_TRANSACTION_PROGRAM_UNSPECIFIED", "USER_CHOICE_BILLING", - "ALTERTNATIVE_BILLING_ONLY" + "ALTERNATIVE_BILLING_ONLY" ], "enumDescriptions": [ "Unspecified transaction program. Not used.", "User choice billing, where a user may choose between Google Play Billing developer-managed billing.", - "Alternatively billing only, where users may only use developer-manager billing." + "Alternative billing only, where users may only use developer-manager billing." ], "type": "string" } diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 72b10dbbfe6..b1d1f5b96f0 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -9776,6 +9776,205 @@ ] } } + }, + "apidocs": { + "methods": { + "create": { + "description": "Creates a new catalog item.", + "flatPath": "v1/organizations/{organizationsId}/sites/{sitesId}/apidocs", + "httpMethod": "POST", + "id": "apigee.organizations.sites.apidocs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`", + "location": "path", + "pattern": "^organizations/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apidocs", + "request": { + "$ref": "GoogleCloudApigeeV1ApiDoc" + }, + "response": { + "$ref": "GoogleCloudApigeeV1ApiDocResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a catalog item.", + "flatPath": "v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}", + "httpMethod": "DELETE", + "id": "apigee.organizations.sites.apidocs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`", + "location": "path", + "pattern": "^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1DeleteResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a catalog item.", + "flatPath": "v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}", + "httpMethod": "GET", + "id": "apigee.organizations.sites.apidocs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`", + "location": "path", + "pattern": "^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1ApiDocResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getDocumentation": { + "description": "Gets the documentation for the specified catalog item.", + "flatPath": "v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation", + "httpMethod": "GET", + "id": "apigee.organizations.sites.apidocs.getDocumentation", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`", + "location": "path", + "pattern": "^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+/documentation$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1ApiDocDocumentationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the catalog items associated with a portal.", + "flatPath": "v1/organizations/{organizationsId}/sites/{sitesId}/apidocs", + "httpMethod": "GET", + "id": "apigee.organizations.sites.apidocs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 25 books will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListApiDocs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`", + "location": "path", + "pattern": "^organizations/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apidocs", + "response": { + "$ref": "GoogleCloudApigeeV1ListApiDocsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates a catalog item.", + "flatPath": "v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}", + "httpMethod": "PUT", + "id": "apigee.organizations.sites.apidocs.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`", + "location": "path", + "pattern": "^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1ApiDoc" + }, + "response": { + "$ref": "GoogleCloudApigeeV1ApiDocResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateDocumentation": { + "description": "Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.", + "flatPath": "v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation", + "httpMethod": "PATCH", + "id": "apigee.organizations.sites.apidocs.updateDocumentation", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`", + "location": "path", + "pattern": "^organizations/[^/]+/sites/[^/]+/apidocs/[^/]+/documentation$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1ApiDocDocumentation" + }, + "response": { + "$ref": "GoogleCloudApigeeV1ApiDocDocumentationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } @@ -9814,7 +10013,7 @@ } } }, - "revision": "20240220", + "revision": "20240312", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -10153,6 +10352,167 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ApiDoc": { + "description": "`ApiDoc` represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.", + "id": "GoogleCloudApigeeV1ApiDoc", + "properties": { + "anonAllowed": { + "description": "Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.", + "type": "boolean" + }, + "apiProductName": { + "description": "Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.", + "type": "string" + }, + "categoryIds": { + "description": "Optional. The IDs of the API categories to which this catalog item belongs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Optional. Description of the catalog item. Max length is 10,000 characters.", + "type": "string" + }, + "edgeAPIProductName": { + "description": "Optional. Immutable. DEPRECATED: use the `apiProductName` field instead", + "type": "string" + }, + "graphqlEndpointUrl": { + "deprecated": true, + "description": "Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods", + "type": "string" + }, + "graphqlSchema": { + "deprecated": true, + "description": "Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods", + "type": "string" + }, + "graphqlSchemaDisplayName": { + "deprecated": true, + "description": "Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods", + "type": "string" + }, + "id": { + "description": "Output only. The ID of the catalog item.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "imageUrl": { + "description": "Optional. Location of the image used for the catalog item in the catalog. For portal files, this can have the format `/files/{filename}`. Max length is 2,083 characters.", + "type": "string" + }, + "modified": { + "description": "Output only. Time the catalog item was last modified in milliseconds since epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "published": { + "description": "Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.", + "type": "boolean" + }, + "requireCallbackUrl": { + "description": "Optional. Whether a callback URL is required when this catalog item's API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app's OAuth flow).", + "type": "boolean" + }, + "siteId": { + "description": "Output only. The ID of the parent portal.", + "readOnly": true, + "type": "string" + }, + "specId": { + "deprecated": true, + "description": "Optional. DEPRECATED: DO NOT USE", + "type": "string" + }, + "title": { + "description": "Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.", + "type": "string" + }, + "visibility": { + "description": "Optional. DEPRECATED: use the `published` field instead", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1ApiDocDocumentation": { + "description": "The documentation for a catalog item.", + "id": "GoogleCloudApigeeV1ApiDocDocumentation", + "properties": { + "graphqlDocumentation": { + "$ref": "GoogleCloudApigeeV1GraphqlDocumentation", + "description": "Optional. GraphQL documentation." + }, + "oasDocumentation": { + "$ref": "GoogleCloudApigeeV1OASDocumentation", + "description": "Optional. OpenAPI Specification documentation." + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1ApiDocDocumentationResponse": { + "description": "The catalog item documentation wrapped with response status, error_code, etc.", + "id": "GoogleCloudApigeeV1ApiDocDocumentationResponse", + "properties": { + "data": { + "$ref": "GoogleCloudApigeeV1ApiDocDocumentation", + "description": "Output only. The documentation resource.", + "readOnly": true + }, + "errorCode": { + "description": "Output only. Unique error code for the request, if any.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Output only. Description of the operation.", + "readOnly": true, + "type": "string" + }, + "requestId": { + "description": "Output only. Unique ID of the request.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. Status of the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1ApiDocResponse": { + "description": "The catalog item resource wrapped with response status, error_code, etc.", + "id": "GoogleCloudApigeeV1ApiDocResponse", + "properties": { + "data": { + "$ref": "GoogleCloudApigeeV1ApiDoc", + "description": "The catalog item resource." + }, + "errorCode": { + "description": "Unique error code for the request, if any.", + "type": "string" + }, + "message": { + "description": "Description of the operation.", + "type": "string" + }, + "requestId": { + "description": "Unique ID of the request.", + "type": "string" + }, + "status": { + "description": "Status of the operation.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ApiProduct": { "id": "GoogleCloudApigeeV1ApiProduct", "properties": { @@ -12374,6 +12734,22 @@ "properties": {}, "type": "object" }, + "GoogleCloudApigeeV1DocumentationFile": { + "description": "Documentation file contents for a catalog item.", + "id": "GoogleCloudApigeeV1DocumentationFile", + "properties": { + "contents": { + "description": "Required. The file contents. The max size is 4 MB.", + "format": "byte", + "type": "string" + }, + "displayName": { + "description": "Required. A display name for the file, shown in the management UI. Max length is 255 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1EnableSecurityActionRequest": { "description": "Message to enable a disabled SecurityAction.", "id": "GoogleCloudApigeeV1EnableSecurityActionRequest", @@ -13110,6 +13486,21 @@ }, "type": "object" }, + "GoogleCloudApigeeV1GraphqlDocumentation": { + "description": "GraphQL documentation for a catalog item.", + "id": "GoogleCloudApigeeV1GraphqlDocumentation", + "properties": { + "endpointUri": { + "description": "Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.", + "type": "string" + }, + "schema": { + "$ref": "GoogleCloudApigeeV1DocumentationFile", + "description": "Required. The documentation file contents for the GraphQL schema." + } + }, + "type": "object" + }, "GoogleCloudApigeeV1GrpcOperationConfig": { "description": "Binds the resources in a proxy or remote service with the gRPC operation and its associated quota enforcement.", "id": "GoogleCloudApigeeV1GrpcOperationConfig", @@ -13510,6 +13901,39 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListApiDocsResponse": { + "id": "GoogleCloudApigeeV1ListApiDocsResponse", + "properties": { + "data": { + "description": "The catalog item resources.", + "items": { + "$ref": "GoogleCloudApigeeV1ApiDoc" + }, + "type": "array" + }, + "errorCode": { + "description": "Unique error code for the request, if any.", + "type": "string" + }, + "message": { + "description": "Description of the operation.", + "type": "string" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "requestId": { + "description": "Unique ID of the request.", + "type": "string" + }, + "status": { + "description": "Status of the operation.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListApiProductsResponse": { "id": "GoogleCloudApigeeV1ListApiProductsResponse", "properties": { @@ -14221,6 +14645,32 @@ }, "type": "object" }, + "GoogleCloudApigeeV1OASDocumentation": { + "description": "OpenAPI Specification documentation for a catalog item.", + "id": "GoogleCloudApigeeV1OASDocumentation", + "properties": { + "format": { + "description": "Output only. The format of the input specification file contents.", + "enum": [ + "FORMAT_UNSPECIFIED", + "YAML", + "JSON" + ], + "enumDescriptions": [ + "The format is not available.", + "YAML format.", + "JSON format." + ], + "readOnly": true, + "type": "string" + }, + "spec": { + "$ref": "GoogleCloudApigeeV1DocumentationFile", + "description": "Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported." + } + }, + "type": "object" + }, "GoogleCloudApigeeV1Operation": { "description": "Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.", "id": "GoogleCloudApigeeV1Operation", diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index af7367068d8..f75ade20ff8 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -21,6 +21,33 @@ "description": "Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/bigquery-transfer/", + "endpoints": [ + { + "endpointUrl": "https://bigquerydatatransfer.me-central2.rep.googleapis.com/", + "location": "me-central2", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://bigquerydatatransfer.europe-west3.rep.googleapis.com/", + "location": "europe-west3", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://bigquerydatatransfer.europe-west9.rep.googleapis.com/", + "location": "europe-west9", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://bigquerydatatransfer.us-east4.rep.googleapis.com/", + "location": "us-east4", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://bigquerydatatransfer.us-west1.rep.googleapis.com/", + "location": "us-west1", + "description": "Regional Endpoint" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1371,7 +1398,7 @@ } } }, - "revision": "20240202", + "revision": "20240306", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/discovery/checks-v1alpha.json b/discovery/checks-v1alpha.json index b610748cb4d..296f6190353 100644 --- a/discovery/checks-v1alpha.json +++ b/discovery/checks-v1alpha.json @@ -414,7 +414,7 @@ } } }, - "revision": "20231221", + "revision": "20240312", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -795,7 +795,8 @@ "ALBERTA_PIPA", "QUEBEC_ACT", "QUEBEC_BILL_64", - "CHINA_PIPL" + "CHINA_PIPL", + "SOUTH_KOREA_PIPA" ], "enumDescriptions": [ "Not specified.", @@ -817,7 +818,8 @@ "Alberta (Canada) Personal Information Protection Act.", "Quebec: Act Respecting the Protection of Personal Information in the Private Sector.", "Quebec Bill 64: An Act to Modernize Legislative Provisions as Regards the Protection of Personal Information.", - "China Personal Information Protection Law." + "China Personal Information Protection Law.", + "South Korea Personal Information Protection Act." ], "type": "string" } diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index 8c786ae0d19..fe1b89e86e5 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -26,6 +26,11 @@ "endpointUrl": "https://dataflow.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", + "location": "europe-west3", + "description": "Regional Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -2177,7 +2182,7 @@ } } }, - "revision": "20240218", + "revision": "20240303", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/discovery/index.json b/discovery/index.json index 7cd64f91f06..32a2c11bac3 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -2207,6 +2207,21 @@ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, "documentationLink": "https://developers.google.com/data-portability", + "preferred": false + }, + { + "kind": "discovery#directoryItem", + "id": "dataportability:v1", + "name": "dataportability", + "version": "v1", + "title": "Data Portability API", + "description": "The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.", + "discoveryRestUrl": "https://dataportability.googleapis.com/$discovery/rest?version=v1", + "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://developers.google.com/data-portability", "preferred": true }, { @@ -3936,6 +3951,21 @@ "documentationLink": "https://developers.google.com/manufacturers/", "preferred": true }, + { + "kind": "discovery#directoryItem", + "id": "marketingplatformadmin:v1alpha", + "name": "marketingplatformadmin", + "version": "v1alpha", + "title": "Google Marketing Platform Admin API", + "description": "marketingplatformadmin.googleapis.com API.", + "discoveryRestUrl": "https://marketingplatformadmin.googleapis.com/$discovery/rest?version=v1alpha", + "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://developers.google.com/analytics/devguides/config/gmp/v1", + "preferred": true + }, { "kind": "discovery#directoryItem", "id": "memcache:v1beta2", @@ -5287,6 +5317,21 @@ "documentationLink": "https://cloud.google.com/secret-manager/", "preferred": false }, + { + "kind": "discovery#directoryItem", + "id": "secretmanager:v1beta2", + "name": "secretmanager", + "version": "v1beta2", + "title": "Secret Manager API", + "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security.", + "discoveryRestUrl": "https://secretmanager.googleapis.com/$discovery/rest?version=v1beta2", + "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://cloud.google.com/secret-manager/", + "preferred": false + }, { "kind": "discovery#directoryItem", "id": "secretmanager:v1", diff --git a/discovery/integrations-v1alpha.json b/discovery/integrations-v1alpha.json index 99020e18c5b..6a2d3500c8a 100644 --- a/discovery/integrations-v1alpha.json +++ b/discovery/integrations-v1alpha.json @@ -3299,7 +3299,7 @@ } } }, - "revision": "20240225", + "revision": "20240305", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -8532,13 +8532,6 @@ "registrationDestinationConfig": { "$ref": "GoogleCloudConnectorsV1DestinationConfig", "description": "Registration endpoint for auto registration." - }, - "triggerConfigVariables": { - "description": "Optional. Additional eventing related field values", - "items": { - "$ref": "GoogleCloudConnectorsV1ConfigVariable" - }, - "type": "array" } }, "type": "object" @@ -8576,6 +8569,54 @@ "$ref": "GoogleCloudConnectorsV1EventingStatus", "description": "Output only. Current status of eventing.", "readOnly": true + }, + "webhookData": { + "$ref": "GoogleCloudConnectorsV1EventingRuntimeDataWebhookData", + "description": "Output only. Webhook data.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1EventingRuntimeDataWebhookData": { + "description": "WebhookData has details of webhook configuration.", + "id": "GoogleCloudConnectorsV1EventingRuntimeDataWebhookData", + "properties": { + "additionalVariables": { + "description": "Output only. Additional webhook related field values.", + "items": { + "$ref": "GoogleCloudConnectorsV1ConfigVariable" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. Timestamp when the webhook was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. ID to uniquely identify webhook.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Name of the Webhook", + "readOnly": true, + "type": "string" + }, + "nextRefreshTime": { + "description": "Output only. Next webhook refresh time. Will be null if refresh is not supported.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the webhook was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/discovery/people-v1.json b/discovery/people-v1.json index 58d09c4b24d..5df0d618efc 100644 --- a/discovery/people-v1.json +++ b/discovery/people-v1.json @@ -429,13 +429,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "location": "query", "repeated": true, @@ -565,13 +567,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "location": "query", "repeated": true, @@ -642,13 +646,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "location": "query", "repeated": true, @@ -697,13 +703,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "location": "query", "repeated": true, @@ -759,13 +767,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "location": "query", "repeated": true, @@ -893,13 +903,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "location": "query", "repeated": true, @@ -1011,13 +1023,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "location": "query", "repeated": true, @@ -1140,13 +1154,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "location": "query", "repeated": true, @@ -1172,7 +1188,7 @@ } } }, - "revision": "20230706", + "revision": "20240312", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { @@ -1281,13 +1297,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "type": "string" }, @@ -1361,13 +1379,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "type": "string" }, @@ -1654,13 +1674,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "type": "string" }, @@ -3210,13 +3232,15 @@ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", "READ_SOURCE_TYPE_CONTACT", - "READ_SOURCE_TYPE_DOMAIN_CONTACT" + "READ_SOURCE_TYPE_DOMAIN_CONTACT", + "READ_SOURCE_TYPE_OTHER_CONTACT" ], "enumDescriptions": [ "Unspecified.", "Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.", "Returns SourceType.CONTACT.", - "Returns SourceType.DOMAIN_CONTACT." + "Returns SourceType.DOMAIN_CONTACT.", + "Returns SourceType.OTHER_CONTACT." ], "type": "string" }, diff --git a/discovery/vault-v1.json b/discovery/vault-v1.json index 940af09f81e..7355d6b3004 100644 --- a/discovery/vault-v1.json +++ b/discovery/vault-v1.json @@ -1102,7 +1102,10 @@ }, "response": { "$ref": "Empty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ] }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", @@ -1124,7 +1127,10 @@ "path": "v1/{+name}", "response": { "$ref": "Empty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ] }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", @@ -1188,12 +1194,16 @@ "path": "v1/{+name}", "response": { "$ref": "ListOperationsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery", + "https://www.googleapis.com/auth/ediscovery.readonly" + ] } } } }, - "revision": "20231213", + "revision": "20240226", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index 152110ebd5c..d20a07d0284 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -28,6 +28,12 @@ }, "https://www.googleapis.com/auth/chat.spaces.readonly": { "description": "View chat and spaces in Google Chat" + }, + "https://www.googleapis.com/auth/meetings.space.created": { + "description": "Create, edit, and see information about your Google Meet conferences created by the app." + }, + "https://www.googleapis.com/auth/meetings.space.readonly": { + "description": "Read information about any of your Google Meet conferences" } } } @@ -161,7 +167,9 @@ "https://www.googleapis.com/auth/chat.messages.reactions.readonly", "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", - "https://www.googleapis.com/auth/chat.spaces.readonly" + "https://www.googleapis.com/auth/chat.spaces.readonly", + "https://www.googleapis.com/auth/meetings.space.created", + "https://www.googleapis.com/auth/meetings.space.readonly" ] } } @@ -196,7 +204,9 @@ "https://www.googleapis.com/auth/chat.messages.reactions.readonly", "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", - "https://www.googleapis.com/auth/chat.spaces.readonly" + "https://www.googleapis.com/auth/chat.spaces.readonly", + "https://www.googleapis.com/auth/meetings.space.created", + "https://www.googleapis.com/auth/meetings.space.readonly" ] }, "delete": { @@ -244,7 +254,9 @@ "https://www.googleapis.com/auth/chat.messages.reactions.readonly", "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", - "https://www.googleapis.com/auth/chat.spaces.readonly" + "https://www.googleapis.com/auth/chat.spaces.readonly", + "https://www.googleapis.com/auth/meetings.space.created", + "https://www.googleapis.com/auth/meetings.space.readonly" ] }, "get": { @@ -277,7 +289,9 @@ "https://www.googleapis.com/auth/chat.messages.reactions.readonly", "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", - "https://www.googleapis.com/auth/chat.spaces.readonly" + "https://www.googleapis.com/auth/chat.spaces.readonly", + "https://www.googleapis.com/auth/meetings.space.created", + "https://www.googleapis.com/auth/meetings.space.readonly" ] }, "list": { @@ -317,7 +331,9 @@ "https://www.googleapis.com/auth/chat.messages.reactions.readonly", "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", - "https://www.googleapis.com/auth/chat.spaces.readonly" + "https://www.googleapis.com/auth/chat.spaces.readonly", + "https://www.googleapis.com/auth/meetings.space.created", + "https://www.googleapis.com/auth/meetings.space.readonly" ] }, "patch": { @@ -363,7 +379,9 @@ "https://www.googleapis.com/auth/chat.messages.reactions.readonly", "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", - "https://www.googleapis.com/auth/chat.spaces.readonly" + "https://www.googleapis.com/auth/chat.spaces.readonly", + "https://www.googleapis.com/auth/meetings.space.created", + "https://www.googleapis.com/auth/meetings.space.readonly" ] }, "reactivate": { @@ -398,13 +416,15 @@ "https://www.googleapis.com/auth/chat.messages.reactions.readonly", "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", - "https://www.googleapis.com/auth/chat.spaces.readonly" + "https://www.googleapis.com/auth/chat.spaces.readonly", + "https://www.googleapis.com/auth/meetings.space.created", + "https://www.googleapis.com/auth/meetings.space.readonly" ] } } } }, - "revision": "20240218", + "revision": "20240310", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { diff --git a/src/apis/index.ts b/src/apis/index.ts index a46c633acdd..6e764d085a7 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -401,6 +401,10 @@ import { VERSIONS as manufacturersVersions, manufacturers, } from './manufacturers'; +import { + VERSIONS as marketingplatformadminVersions, + marketingplatformadmin, +} from './marketingplatformadmin'; import {VERSIONS as memcacheVersions, memcache} from './memcache'; import {VERSIONS as metastoreVersions, metastore} from './metastore'; import { @@ -862,6 +866,7 @@ export const APIS: APIList = { looker: lookerVersions, managedidentities: managedidentitiesVersions, manufacturers: manufacturersVersions, + marketingplatformadmin: marketingplatformadminVersions, memcache: memcacheVersions, metastore: metastoreVersions, migrationcenter: migrationcenterVersions, @@ -1151,6 +1156,7 @@ export class GeneratedAPIs { looker = looker; managedidentities = managedidentities; manufacturers = manufacturers; + marketingplatformadmin = marketingplatformadmin; memcache = memcache; metastore = metastore; migrationcenter = migrationcenter; diff --git a/src/index.ts b/src/index.ts index e1fb22f7bd8..a77f3741418 100644 --- a/src/index.ts +++ b/src/index.ts @@ -188,6 +188,7 @@ export {datamigration_v1} from './apis/datamigration/v1'; export {datamigration_v1beta1} from './apis/datamigration/v1beta1'; export {datapipelines_v1} from './apis/datapipelines/v1'; export {dataplex_v1} from './apis/dataplex/v1'; +export {dataportability_v1} from './apis/dataportability/v1'; export {dataportability_v1beta} from './apis/dataportability/v1beta'; export {dataproc_v1} from './apis/dataproc/v1'; export {dataproc_v1beta2} from './apis/dataproc/v1beta2'; @@ -323,6 +324,7 @@ export {managedidentities_v1} from './apis/managedidentities/v1'; export {managedidentities_v1alpha1} from './apis/managedidentities/v1alpha1'; export {managedidentities_v1beta1} from './apis/managedidentities/v1beta1'; export {manufacturers_v1} from './apis/manufacturers/v1'; +export {marketingplatformadmin_v1alpha} from './apis/marketingplatformadmin/v1alpha'; export {memcache_v1} from './apis/memcache/v1'; export {memcache_v1beta2} from './apis/memcache/v1beta2'; export {metastore_v1} from './apis/metastore/v1'; @@ -423,6 +425,7 @@ export {searchads360_v0} from './apis/searchads360/v0'; export {searchconsole_v1} from './apis/searchconsole/v1'; export {secretmanager_v1} from './apis/secretmanager/v1'; export {secretmanager_v1beta1} from './apis/secretmanager/v1beta1'; +export {secretmanager_v1beta2} from './apis/secretmanager/v1beta2'; export {securitycenter_v1} from './apis/securitycenter/v1'; export {securitycenter_v1beta1} from './apis/securitycenter/v1beta1'; export {securitycenter_v1beta2} from './apis/securitycenter/v1beta2'; From 97a1b6c8896e8449442a0a840f46bb9a92cef060 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 14 Mar 2024 01:33:17 +0000 Subject: [PATCH 78/78] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20?= =?UTF-8?q?post-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- release-please-config.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/release-please-config.json b/release-please-config.json index aba0b7cb97b..a4227e2d351 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -288,6 +288,7 @@ "src/apis/walletobjects": {}, "src/apis/apphub": {}, "src/apis/dataportability": {}, - "src/apis/workspaceevents": {} + "src/apis/workspaceevents": {}, + "src/apis/marketingplatformadmin": {} } } \ No newline at end of file