From 8f249ee1094ede020dae789e214bb240fa10f18c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:14 +0000 Subject: [PATCH 01/43] feat(androidmanagement)!: update the API BREAKING CHANGE: This release has breaking changes. #### androidmanagement:v1 The following keys were deleted: - resources.enterprises.resources.devices.resources.operations.methods.delete.description - resources.enterprises.resources.devices.resources.operations.methods.delete.flatPath - resources.enterprises.resources.devices.resources.operations.methods.delete.httpMethod - resources.enterprises.resources.devices.resources.operations.methods.delete.id - resources.enterprises.resources.devices.resources.operations.methods.delete.parameterOrder - resources.enterprises.resources.devices.resources.operations.methods.delete.parameters.name.description - resources.enterprises.resources.devices.resources.operations.methods.delete.parameters.name.location - resources.enterprises.resources.devices.resources.operations.methods.delete.parameters.name.pattern - resources.enterprises.resources.devices.resources.operations.methods.delete.parameters.name.required - resources.enterprises.resources.devices.resources.operations.methods.delete.parameters.name.type - resources.enterprises.resources.devices.resources.operations.methods.delete.path - resources.enterprises.resources.devices.resources.operations.methods.delete.response.$ref - resources.enterprises.resources.devices.resources.operations.methods.delete.scopes The following keys were added: - schemas.ApplicationPolicy.properties.installConstraint.description - schemas.ApplicationPolicy.properties.installConstraint.items.$ref - schemas.ApplicationPolicy.properties.installConstraint.type - schemas.ApplicationPolicy.properties.installPriority.description - schemas.ApplicationPolicy.properties.installPriority.format - schemas.ApplicationPolicy.properties.installPriority.type - schemas.InstallConstraint.description - schemas.InstallConstraint.id - schemas.InstallConstraint.properties.chargingConstraint.description - schemas.InstallConstraint.properties.chargingConstraint.enum - schemas.InstallConstraint.properties.chargingConstraint.enumDescriptions - schemas.InstallConstraint.properties.chargingConstraint.type - schemas.InstallConstraint.properties.deviceIdleConstraint.description - schemas.InstallConstraint.properties.deviceIdleConstraint.enum - schemas.InstallConstraint.properties.deviceIdleConstraint.enumDescriptions - schemas.InstallConstraint.properties.deviceIdleConstraint.type - schemas.InstallConstraint.properties.networkTypeConstraint.description - schemas.InstallConstraint.properties.networkTypeConstraint.enum - schemas.InstallConstraint.properties.networkTypeConstraint.enumDescriptions - schemas.InstallConstraint.properties.networkTypeConstraint.type - schemas.InstallConstraint.type - schemas.Policy.properties.androidDevicePolicyTracks.deprecated The following keys were changed: - schemas.AdvancedSecurityOverrides.description - schemas.ApplicationPolicy.properties.defaultPermissionPolicy.enumDescriptions - schemas.Device.properties.memoryEvents.description - schemas.MemoryEvent.description - schemas.PermissionGrant.properties.policy.enumDescriptions - schemas.Policy.properties.advancedSecurityOverrides.description - schemas.Policy.properties.androidDevicePolicyTracks.description - schemas.Policy.properties.defaultPermissionPolicy.enumDescriptions --- discovery/androidmanagement-v1.json | 105 +++++++++++++++-------- src/apis/androidmanagement/v1.ts | 127 +++++++--------------------- 2 files changed, 101 insertions(+), 131 deletions(-) diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index 03dcb25ee5..1951d2165b 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -512,31 +512,6 @@ "https://www.googleapis.com/auth/androidmanagement" ] }, - "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": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "androidmanagement.enterprises.devices.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^enterprises/[^/]+/devices/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/androidmanagement" - ] - }, "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/enterprises/{enterprisesId}/devices/{devicesId}/operations/{operationsId}", @@ -1188,7 +1163,7 @@ } } }, - "revision": "20240115", + "revision": "20240129", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1209,7 +1184,7 @@ "type": "object" }, "AdvancedSecurityOverrides": { - "description": "Security policies set to secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values.", + "description": "Advanced security settings. In most cases, setting these is not needed.", "id": "AdvancedSecurityOverrides", "properties": { "commonCriteriaMode": { @@ -1692,7 +1667,7 @@ "enumDescriptions": [ "Policy not specified. If no policy is specified for a permission at any level, then the PROMPT behavior is used by default.", "Prompt the user to grant a permission.", - "Automatically grant a permission.", + "Automatically grant a permission.On Android 12 and above, Manifest.permission.READ_SMS (https://developer.android.com/reference/android/Manifest.permission#READ_SMS) and following sensor-related permissions can only be granted on fully managed devices: Manifest.permission.ACCESS_FINE_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_FINE_LOCATION) Manifest.permission.ACCESS_BACKGROUND_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_BACKGROUND_LOCATION) Manifest.permission.ACCESS_COARSE_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_COARSE_LOCATION) Manifest.permission.CAMERA (https://developer.android.com/reference/android/Manifest.permission#CAMERA) Manifest.permission.RECORD_AUDIO (https://developer.android.com/reference/android/Manifest.permission#RECORD_AUDIO) Manifest.permission.ACTIVITY_RECOGNITION (https://developer.android.com/reference/android/Manifest.permission#ACTIVITY_RECOGNITION) Manifest.permission.BODY_SENSORS (https://developer.android.com/reference/android/Manifest.permission#BODY_SENSORS)", "Automatically deny a permission." ], "type": "string" @@ -1736,6 +1711,18 @@ "$ref": "ExtensionConfig", "description": "Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app." }, + "installConstraint": { + "description": "Optional. The constraints for installing the app. You can specify a maximum of one InstallConstraint. Multiple constraints are rejected.", + "items": { + "$ref": "InstallConstraint" + }, + "type": "array" + }, + "installPriority": { + "description": "Optional. Amongst apps with installTypeset to:FORCE_INSTALLEDPREINSTALLED this controls the relative priority of installation. A value of 0 (default) means this app has no priority over other apps. For values between 1 and 10,000, a lower value means a higher priority. Values outside of the range 0 to 10,000 inclusive are rejected.", + "format": "int32", + "type": "integer" + }, "installType": { "description": "The type of installation to perform.", "enum": [ @@ -2547,7 +2534,7 @@ "type": "string" }, "memoryEvents": { - "description": "Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.", + "description": "Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.Events are retained for a certain period of time and old events are deleted.", "items": { "$ref": "MemoryEvent" }, @@ -3340,6 +3327,55 @@ }, "type": "object" }, + "InstallConstraint": { + "description": "Amongst apps with InstallTypeset to:FORCE_INSTALLEDPREINSTALLED this defines a set of restrictions for the app installation. At least one of the fields must be set. When multiple fields are set, then all the constraints need to be satisfied for the app to be installed.", + "id": "InstallConstraint", + "properties": { + "chargingConstraint": { + "description": "Optional. Charging constraint.", + "enum": [ + "CHARGING_CONSTRAINT_UNSPECIFIED", + "CHARGING_NOT_REQUIRED", + "INSTALL_ONLY_WHEN_CHARGING" + ], + "enumDescriptions": [ + "Unspecified. Default to CHARGING_NOT_REQUIRED.", + "Device doesn't have to be charging.", + "Device has to be charging." + ], + "type": "string" + }, + "deviceIdleConstraint": { + "description": "Optional. Device idle constraint.", + "enum": [ + "DEVICE_IDLE_CONSTRAINT_UNSPECIFIED", + "DEVICE_IDLE_NOT_REQUIRED", + "INSTALL_ONLY_WHEN_DEVICE_IDLE" + ], + "enumDescriptions": [ + "Unspecified. Default to DEVICE_IDLE_NOT_REQUIRED.", + "Device doesn't have to be idle, app can be installed while the user is interacting with the device.", + "Device has to be idle." + ], + "type": "string" + }, + "networkTypeConstraint": { + "description": "Optional. Network type constraint.", + "enum": [ + "NETWORK_TYPE_CONSTRAINT_UNSPECIFIED", + "INSTALL_ON_ANY_NETWORK", + "INSTALL_ONLY_ON_UNMETERED_NETWORK" + ], + "enumDescriptions": [ + "Unspecified. Default to INSTALL_ON_ANY_NETWORK.", + "Any active networks (Wi-Fi, cellular, etc.).", + "Any unmetered network (e.g. Wi-FI)." + ], + "type": "string" + } + }, + "type": "object" + }, "IssueCommandResponse": { "description": "Response on issuing a command. This is currently empty as a placeholder.", "id": "IssueCommandResponse", @@ -3894,7 +3930,7 @@ "type": "object" }, "MemoryEvent": { - "description": "An event related to memory and storage measurements.", + "description": "An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.", "id": "MemoryEvent", "properties": { "byteCount": { @@ -4530,7 +4566,7 @@ "enumDescriptions": [ "Policy not specified. If no policy is specified for a permission at any level, then the PROMPT behavior is used by default.", "Prompt the user to grant a permission.", - "Automatically grant a permission.", + "Automatically grant a permission.On Android 12 and above, Manifest.permission.READ_SMS (https://developer.android.com/reference/android/Manifest.permission#READ_SMS) and following sensor-related permissions can only be granted on fully managed devices: Manifest.permission.ACCESS_FINE_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_FINE_LOCATION) Manifest.permission.ACCESS_BACKGROUND_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_BACKGROUND_LOCATION) Manifest.permission.ACCESS_COARSE_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_COARSE_LOCATION) Manifest.permission.CAMERA (https://developer.android.com/reference/android/Manifest.permission#CAMERA) Manifest.permission.RECORD_AUDIO (https://developer.android.com/reference/android/Manifest.permission#RECORD_AUDIO) Manifest.permission.ACTIVITY_RECOGNITION (https://developer.android.com/reference/android/Manifest.permission#ACTIVITY_RECOGNITION) Manifest.permission.BODY_SENSORS (https://developer.android.com/reference/android/Manifest.permission#BODY_SENSORS)", "Automatically deny a permission." ], "type": "string" @@ -4665,14 +4701,15 @@ }, "advancedSecurityOverrides": { "$ref": "AdvancedSecurityOverrides", - "description": "Security policies set to secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values." + "description": "Advanced security settings. In most cases, setting these is not needed." }, "alwaysOnVpnPackage": { "$ref": "AlwaysOnVpnPackage", "description": "Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting." }, "androidDevicePolicyTracks": { - "description": "The app tracks for Android Device Policy the device can access. The device receives the latest version among all accessible tracks. If no tracks are specified, then the device only uses the production track.", + "deprecated": true, + "description": "This setting is not supported. Any value is ignored.", "items": { "enum": [ "APP_TRACK_UNSPECIFIED", @@ -4821,7 +4858,7 @@ "enumDescriptions": [ "Policy not specified. If no policy is specified for a permission at any level, then the PROMPT behavior is used by default.", "Prompt the user to grant a permission.", - "Automatically grant a permission.", + "Automatically grant a permission.On Android 12 and above, Manifest.permission.READ_SMS (https://developer.android.com/reference/android/Manifest.permission#READ_SMS) and following sensor-related permissions can only be granted on fully managed devices: Manifest.permission.ACCESS_FINE_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_FINE_LOCATION) Manifest.permission.ACCESS_BACKGROUND_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_BACKGROUND_LOCATION) Manifest.permission.ACCESS_COARSE_LOCATION (https://developer.android.com/reference/android/Manifest.permission#ACCESS_COARSE_LOCATION) Manifest.permission.CAMERA (https://developer.android.com/reference/android/Manifest.permission#CAMERA) Manifest.permission.RECORD_AUDIO (https://developer.android.com/reference/android/Manifest.permission#RECORD_AUDIO) Manifest.permission.ACTIVITY_RECOGNITION (https://developer.android.com/reference/android/Manifest.permission#ACTIVITY_RECOGNITION) Manifest.permission.BODY_SENSORS (https://developer.android.com/reference/android/Manifest.permission#BODY_SENSORS)", "Automatically deny a permission." ], "type": "string" diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 814db6e68d..af3be2cb97 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -142,7 +142,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$AdbShellInteractiveEvent {} /** - * Security policies set to secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values. + * Advanced security settings. In most cases, setting these is not needed. */ export interface Schema$AdvancedSecurityOverrides { /** @@ -347,6 +347,14 @@ export namespace androidmanagement_v1 { * Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. */ extensionConfig?: Schema$ExtensionConfig; + /** + * Optional. The constraints for installing the app. You can specify a maximum of one InstallConstraint. Multiple constraints are rejected. + */ + installConstraint?: Schema$InstallConstraint[]; + /** + * Optional. Amongst apps with installTypeset to:FORCE_INSTALLEDPREINSTALLED this controls the relative priority of installation. A value of 0 (default) means this app has no priority over other apps. For values between 1 and 10,000, a lower value means a higher priority. Values outside of the range 0 to 10,000 inclusive are rejected. + */ + installPriority?: number | null; /** * The type of installation to perform. */ @@ -920,7 +928,7 @@ export namespace androidmanagement_v1 { */ managementMode?: string | null; /** - * Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy. + * Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.Events are retained for a certain period of time and old events are deleted. */ memoryEvents?: Schema$MemoryEvent[]; /** @@ -1383,6 +1391,23 @@ export namespace androidmanagement_v1 { */ skinTemperatures?: number[] | null; } + /** + * Amongst apps with InstallTypeset to:FORCE_INSTALLEDPREINSTALLED this defines a set of restrictions for the app installation. At least one of the fields must be set. When multiple fields are set, then all the constraints need to be satisfied for the app to be installed. + */ + export interface Schema$InstallConstraint { + /** + * Optional. Charging constraint. + */ + chargingConstraint?: string | null; + /** + * Optional. Device idle constraint. + */ + deviceIdleConstraint?: string | null; + /** + * Optional. Network type constraint. + */ + networkTypeConstraint?: string | null; + } /** * Response on issuing a command. This is currently empty as a placeholder. */ @@ -1754,7 +1779,7 @@ export namespace androidmanagement_v1 { volumeLabel?: string | null; } /** - * An event related to memory and storage measurements. + * An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field. */ export interface Schema$MemoryEvent { /** @@ -2152,7 +2177,7 @@ export namespace androidmanagement_v1 { */ adjustVolumeDisabled?: boolean | null; /** - * Security policies set to secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values. + * Advanced security settings. In most cases, setting these is not needed. */ advancedSecurityOverrides?: Schema$AdvancedSecurityOverrides; /** @@ -2160,7 +2185,7 @@ export namespace androidmanagement_v1 { */ alwaysOnVpnPackage?: Schema$AlwaysOnVpnPackage; /** - * The app tracks for Android Device Policy the device can access. The device receives the latest version among all accessible tracks. If no tracks are specified, then the device only uses the production track. + * This setting is not supported. Any value is ignored. */ androidDevicePolicyTracks?: string[] | null; /** @@ -4418,91 +4443,6 @@ export namespace androidmanagement_v1 { } } - /** - * 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$Enterprises$Devices$Operations$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Enterprises$Devices$Operations$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Enterprises$Devices$Operations$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Enterprises$Devices$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Enterprises$Devices$Operations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Enterprises$Devices$Operations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Enterprises$Devices$Operations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Enterprises$Devices$Operations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://androidmanagement.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 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. * @@ -4686,13 +4626,6 @@ export namespace androidmanagement_v1 { */ name?: string; } - export interface Params$Resource$Enterprises$Devices$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } export interface Params$Resource$Enterprises$Devices$Operations$Get extends StandardParameters { /** From 60b688eff2a4003639a0220b22c79256eb15b428 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:14 +0000 Subject: [PATCH 02/43] fix(backupdr): update the API #### backupdr:v1 The following keys were changed: - schemas.Binding.properties.role.description --- discovery/backupdr-v1.json | 4 ++-- src/apis/backupdr/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index 1149c17e54..f69519783b 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -567,7 +567,7 @@ } } }, - "revision": "20231224", + "revision": "20240124", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AuditConfig": { @@ -634,7 +634,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`.", + "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" } }, diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index 77942a69a4..2d1c1be679 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -163,7 +163,7 @@ export namespace backupdr_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } From 98e9680d60153dbeaff0f2ce8f94b1b00d606a13 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:14 +0000 Subject: [PATCH 03/43] fix(batch): update the API #### batch:v1 The following keys were changed: - schemas.Container.properties.password.description - schemas.Container.properties.username.description - schemas.TaskGroup.properties.requireHostsFile.description - schemas.TaskGroup.properties.runAsNonRoot.description --- discovery/batch-v1.json | 10 +++++----- src/apis/batch/README.md | 2 +- src/apis/batch/v1.ts | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 052f623e2b..bbe844f5f7 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -561,7 +561,7 @@ } } }, - "revision": "20240112", + "revision": "20240202", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1108,11 +1108,11 @@ "type": "string" }, "password": { - "description": "Optional password for logging in to a docker registry. If password matches `projects/*/secrets/*/versions/*` then Batch will read the password from the Secret Manager;", + "description": "Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image. For security, it is strongly recommended to specify an encrypted password by using a Secret Manager secret: `projects/*/secrets/*/versions/*`. Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead. Learn more about [Secret Manager](https://cloud.google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).", "type": "string" }, "username": { - "description": "Optional username for logging in to a docker registry. If username matches `projects/*/secrets/*/versions/*` then Batch will read the username from the Secret Manager.", + "description": "Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image. You can either specify the username directly by using plain text or specify an encrypted username by using a Secret Manager secret: `projects/*/secrets/*/versions/*`. However, using a secret is recommended for enhanced security. Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead. Learn more about [Secret Manager](https://cloud.google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).", "type": "string" }, "volumes": { @@ -2093,11 +2093,11 @@ "type": "boolean" }, "requireHostsFile": { - "description": "When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.", + "description": "When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false. The host file supports up to 1000 VMs.", "type": "boolean" }, "runAsNonRoot": { - "description": "Optional. If not set or set to false, Batch uses the root user to execute runnables. If set to true, Batch will make sure to run the runnables using a non-root user. Currently, the non-root user Batch used is generated by OS Login. For more information, see [About OS Login](https://cloud.google.com/compute/docs/oslogin).", + "description": "Optional. If not set or set to false, Batch uses the root user to execute runnables. If set to true, Batch runs the runnables using a non-root user. Currently, the non-root user Batch used is generated by OS Login. For more information, see [About OS Login](https://cloud.google.com/compute/docs/oslogin).", "type": "boolean" }, "schedulingPolicy": { diff --git a/src/apis/batch/README.md b/src/apis/batch/README.md index 863d85be6e..fe0b8dd25d 100644 --- a/src/apis/batch/README.md +++ b/src/apis/batch/README.md @@ -2,7 +2,7 @@ # batch -> An API to manage the running of batch jobs on Google Cloud Platform. +> An API to manage the running of batch resources on Google Cloud Platform. ## Support status **Note**: Google provides multiple libraries for this service. This library is in diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index 7d5346b3d8..02b38f7ad5 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -537,11 +537,11 @@ export namespace batch_v1 { */ options?: string | null; /** - * Optional password for logging in to a docker registry. If password matches `projects/x/secrets/x/versions/x` then Batch will read the password from the Secret Manager; + * Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image. For security, it is strongly recommended to specify an encrypted password by using a Secret Manager secret: `projects/x/secrets/x/versions/x`. Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead. Learn more about [Secret Manager](https://cloud.google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager). */ password?: string | null; /** - * Optional username for logging in to a docker registry. If username matches `projects/x/secrets/x/versions/x` then Batch will read the username from the Secret Manager. + * Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image. You can either specify the username directly by using plain text or specify an encrypted username by using a Secret Manager secret: `projects/x/secrets/x/versions/x`. However, using a secret is recommended for enhanced security. Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead. Learn more about [Secret Manager](https://cloud.google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager). */ username?: string | null; /** @@ -1206,11 +1206,11 @@ export namespace batch_v1 { */ permissiveSsh?: boolean | null; /** - * When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false. + * When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false. The host file supports up to 1000 VMs. */ requireHostsFile?: boolean | null; /** - * Optional. If not set or set to false, Batch uses the root user to execute runnables. If set to true, Batch will make sure to run the runnables using a non-root user. Currently, the non-root user Batch used is generated by OS Login. For more information, see [About OS Login](https://cloud.google.com/compute/docs/oslogin). + * Optional. If not set or set to false, Batch uses the root user to execute runnables. If set to true, Batch runs the runnables using a non-root user. Currently, the non-root user Batch used is generated by OS Login. For more information, see [About OS Login](https://cloud.google.com/compute/docs/oslogin). */ runAsNonRoot?: boolean | null; /** From fd13717902bbcae7c1edf8e89c2892f7cd049362 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:14 +0000 Subject: [PATCH 04/43] feat(bigquerydatatransfer): update the API #### bigquerydatatransfer:v1 The following keys were added: - resources.projects.resources.locations.methods.unenrollDataSources.description - resources.projects.resources.locations.methods.unenrollDataSources.flatPath - resources.projects.resources.locations.methods.unenrollDataSources.httpMethod - resources.projects.resources.locations.methods.unenrollDataSources.id - resources.projects.resources.locations.methods.unenrollDataSources.parameterOrder - resources.projects.resources.locations.methods.unenrollDataSources.parameters.name.description - resources.projects.resources.locations.methods.unenrollDataSources.parameters.name.location - resources.projects.resources.locations.methods.unenrollDataSources.parameters.name.pattern - resources.projects.resources.locations.methods.unenrollDataSources.parameters.name.required - resources.projects.resources.locations.methods.unenrollDataSources.parameters.name.type - resources.projects.resources.locations.methods.unenrollDataSources.path - resources.projects.resources.locations.methods.unenrollDataSources.request.$ref - resources.projects.resources.locations.methods.unenrollDataSources.response.$ref - resources.projects.resources.locations.methods.unenrollDataSources.scopes - schemas.UnenrollDataSourcesRequest.description - schemas.UnenrollDataSourcesRequest.id - schemas.UnenrollDataSourcesRequest.properties.dataSourceIds.description - schemas.UnenrollDataSourcesRequest.properties.dataSourceIds.items.type - schemas.UnenrollDataSourcesRequest.properties.dataSourceIds.type - schemas.UnenrollDataSourcesRequest.type --- discovery/bigquerydatatransfer-v1.json | 45 +++++++++- src/apis/bigquerydatatransfer/v1.ts | 109 +++++++++++++++++++++++++ 2 files changed, 153 insertions(+), 1 deletion(-) diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index 9ada68adb6..92dd041ba4 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -343,6 +343,35 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] + }, + "unenrollDataSources": { + "description": "Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the [BigQuery UI](https://console.cloud.google.com/bigquery).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:unenrollDataSources", + "httpMethod": "POST", + "id": "bigquerydatatransfer.projects.locations.unenrollDataSources", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the project resource in the form: `projects/{project_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:unenrollDataSources", + "request": { + "$ref": "UnenrollDataSourcesRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1342,7 +1371,7 @@ } } }, - "revision": "20230905", + "revision": "20240130", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { @@ -2125,6 +2154,20 @@ }, "type": "object" }, + "UnenrollDataSourcesRequest": { + "description": "A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab.", + "id": "UnenrollDataSourcesRequest", + "properties": { + "dataSourceIds": { + "description": "Data sources that are unenrolled. It is required to provide at least one data source id.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "UserInfo": { "description": "Information about a user.", "id": "UserInfo", diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index 00c47cffac..a71d045966 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -654,6 +654,15 @@ export namespace bigquerydatatransfer_v1 { */ userId?: string | null; } + /** + * A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab. + */ + export interface Schema$UnenrollDataSourcesRequest { + /** + * Data sources that are unenrolled. It is required to provide at least one data source id. + */ + dataSourceIds?: string[] | null; + } /** * Information about a user. */ @@ -1374,6 +1383,94 @@ export namespace bigquerydatatransfer_v1 { return createAPIRequest(parameters); } } + + /** + * Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the [BigQuery UI](https://console.cloud.google.com/bigquery). + * + * @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. + */ + unenrollDataSources( + params: Params$Resource$Projects$Locations$Unenrolldatasources, + options: StreamMethodOptions + ): GaxiosPromise; + unenrollDataSources( + params?: Params$Resource$Projects$Locations$Unenrolldatasources, + options?: MethodOptions + ): GaxiosPromise; + unenrollDataSources( + params: Params$Resource$Projects$Locations$Unenrolldatasources, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + unenrollDataSources( + params: Params$Resource$Projects$Locations$Unenrolldatasources, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + unenrollDataSources( + params: Params$Resource$Projects$Locations$Unenrolldatasources, + callback: BodyResponseCallback + ): void; + unenrollDataSources(callback: BodyResponseCallback): void; + unenrollDataSources( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Unenrolldatasources + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Unenrolldatasources; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Unenrolldatasources; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigquerydatatransfer.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:unenrollDataSources').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$Enrolldatasources @@ -1414,6 +1511,18 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; } + export interface Params$Resource$Projects$Locations$Unenrolldatasources + extends StandardParameters { + /** + * The name of the project resource in the form: `projects/{project_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UnenrollDataSourcesRequest; + } export class Resource$Projects$Locations$Datasources { context: APIRequestContext; From a14cf259a40e260f3fec1d86ebb20348e2e6fe36 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:14 +0000 Subject: [PATCH 05/43] fix(bigtableadmin): update the API #### bigtableadmin:v2 The following keys were changed: - schemas.Backup.properties.sourceBackup.description - schemas.BackupInfo.properties.sourceBackup.description - schemas.Binding.properties.role.description --- discovery/bigtableadmin-v2.json | 8 ++++---- src/apis/bigtableadmin/v2.ts | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index a179282686..f3cbb06405 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -1875,7 +1875,7 @@ } } }, - "revision": "20240120", + "revision": "20240126", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2039,7 +2039,7 @@ "type": "string" }, "sourceBackup": { - "description": "Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.", + "description": "Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/", "readOnly": true, "type": "string" }, @@ -2087,7 +2087,7 @@ "type": "string" }, "sourceBackup": { - "description": "Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.", + "description": "Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/", "readOnly": true, "type": "string" }, @@ -2121,7 +2121,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`.", + "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" } }, diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 02dfb270f0..e00e595f6d 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -236,7 +236,7 @@ export namespace bigtableadmin_v2 { */ sizeBytes?: string | null; /** - * Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/. + * Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/ */ sourceBackup?: string | null; /** @@ -265,7 +265,7 @@ export namespace bigtableadmin_v2 { */ endTime?: string | null; /** - * Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/. + * Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/ */ sourceBackup?: string | null; /** @@ -290,7 +290,7 @@ export namespace bigtableadmin_v2 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } From 66991b58cd8339769df19f62c291fa2f7660f22a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:14 +0000 Subject: [PATCH 06/43] feat(cloudbuild): update the API #### cloudbuild:v2 The following keys were added: - schemas.PipelineRun.properties.gcbParams.additionalProperties.type - schemas.PipelineRun.properties.gcbParams.description - schemas.PipelineRun.properties.gcbParams.readOnly - schemas.PipelineRun.properties.gcbParams.type - schemas.PipelineRun.properties.provenance.$ref - schemas.PipelineRun.properties.provenance.description - schemas.PipelineRun.properties.security.$ref - schemas.PipelineRun.properties.security.description - schemas.PipelineRun.properties.worker.$ref - schemas.PipelineRun.properties.worker.description - schemas.Provenance.description - schemas.Provenance.id - schemas.Provenance.properties.enabled.description - schemas.Provenance.properties.enabled.enum - schemas.Provenance.properties.enabled.enumDescriptions - schemas.Provenance.properties.enabled.type - schemas.Provenance.properties.region.description - schemas.Provenance.properties.region.enum - schemas.Provenance.properties.region.enumDescriptions - schemas.Provenance.properties.region.type - schemas.Provenance.properties.storage.description - schemas.Provenance.properties.storage.enum - schemas.Provenance.properties.storage.enumDescriptions - schemas.Provenance.properties.storage.type - schemas.Provenance.type - schemas.Security.description - schemas.Security.id - schemas.Security.properties.privilegeMode.description - schemas.Security.properties.privilegeMode.enum - schemas.Security.properties.privilegeMode.enumDescriptions - schemas.Security.properties.privilegeMode.type - schemas.Security.properties.serviceAccount.description - schemas.Security.properties.serviceAccount.type - schemas.Security.type - schemas.Worker.description - schemas.Worker.id - schemas.Worker.properties.machineType.description - schemas.Worker.properties.machineType.type - schemas.Worker.type The following keys were changed: - schemas.Binding.properties.role.description --- discovery/cloudbuild-v2.json | 111 ++++++++++++++++++++++++++++++++++- src/apis/cloudbuild/v2.ts | 57 +++++++++++++++++- 2 files changed, 165 insertions(+), 3 deletions(-) diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index 8737b09bc3..1890a17370 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -844,7 +844,7 @@ } } }, - "revision": "20231231", + "revision": "20240130", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -939,7 +939,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`.", + "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" } }, @@ -1867,6 +1867,14 @@ "readOnly": true, "type": "string" }, + "gcbParams": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. GCB default params.", + "readOnly": true, + "type": "object" + }, "name": { "description": "Output only. The `PipelineRun` name with format `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}`", "readOnly": true, @@ -1899,11 +1907,19 @@ "$ref": "PipelineSpec", "description": "PipelineSpec defines the desired state of Pipeline." }, + "provenance": { + "$ref": "Provenance", + "description": "Optional. Provenance configuration." + }, "resolvedPipelineSpec": { "$ref": "PipelineSpec", "description": "Output only. The exact PipelineSpec used to instantiate the run.", "readOnly": true }, + "security": { + "$ref": "Security", + "description": "Optional. Security configuration." + }, "serviceAccount": { "description": "Service account used in the Pipeline.", "type": "string" @@ -1937,6 +1953,10 @@ "readOnly": true, "type": "string" }, + "worker": { + "$ref": "Worker", + "description": "Optional. Worker configuration." + }, "workerPool": { "description": "Output only. The WorkerPool used to run this PipelineRun.", "readOnly": true, @@ -2139,6 +2159,57 @@ }, "type": "object" }, + "Provenance": { + "description": "Provenance configuration.", + "id": "Provenance", + "properties": { + "enabled": { + "description": "Optional. Provenance push mode.", + "enum": [ + "ENABLED_UNSPECIFIED", + "REQUIRED", + "OPTIMISTIC", + "DISABLED" + ], + "enumDescriptions": [ + "Default to disabled (before AA regionalization), optimistic after", + "Provenance failures would fail the run", + "GCB will attempt to push to artifact analaysis and build state would not be impacted by the push failures.", + "Disable the provenance push entirely." + ], + "type": "string" + }, + "region": { + "description": "Optional. Provenance region.", + "enum": [ + "REGION_UNSPECIFIED", + "GLOBAL" + ], + "enumDescriptions": [ + "The PipelineRun/TaskRun/Workflow will be rejected. Update this comment to push to the same region as the run in Artifact Analysis when it's regionalized.", + "Push provenance to Artifact Analysis in global region." + ], + "type": "string" + }, + "storage": { + "description": "Optional. Where provenance is stored.", + "enum": [ + "STORAGE_UNSPECIFIED", + "PREFER_ARTIFACT_PROJECT", + "ARTIFACT_PROJECT_ONLY", + "BUILD_PROJECT_ONLY" + ], + "enumDescriptions": [ + "Default PREFER_ARTIFACT_PROJECT.", + "GCB will attempt to push provenance to the artifact project. If it is not available, fallback to build project.", + "Only push to artifact project.", + "Only push to build project." + ], + "type": "string" + } + }, + "type": "object" + }, "Repository": { "description": "A repository associated to a parent connection.", "id": "Repository", @@ -2242,6 +2313,31 @@ }, "type": "object" }, + "Security": { + "description": "Security configuration.", + "id": "Security", + "properties": { + "privilegeMode": { + "description": "Optional. Privilege mode.", + "enum": [ + "PRIVILEGE_MODE_UNSPECIFIED", + "PRIVILEGED", + "UNPRIVILEGED" + ], + "enumDescriptions": [ + "Default to PRIVILEGED.", + "Privileged mode.", + "Unprivileged mode." + ], + "type": "string" + }, + "serviceAccount": { + "description": "IAM service account whose credentials will be used at runtime.", + "type": "string" + } + }, + "type": "object" + }, "SecurityContext": { "description": "Security options the container should be run with.", "id": "SecurityContext", @@ -2777,6 +2873,17 @@ }, "type": "object" }, + "Worker": { + "description": "Configuration for the worker.", + "id": "Worker", + "properties": { + "machineType": { + "description": "Optional. Machine type of a worker, default is \"e2-standard-2\".", + "type": "string" + } + }, + "type": "object" + }, "WorkspaceBinding": { "description": "WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used to refer to a specific instance of a Pipeline.", "id": "WorkspaceBinding", diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index 3589b1da35..1c917dca40 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -181,7 +181,7 @@ export namespace cloudbuild_v2 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -844,6 +844,10 @@ export namespace cloudbuild_v2 { * Output only. FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed. +optional */ finallyStartTime?: string | null; + /** + * Output only. GCB default params. + */ + gcbParams?: {[key: string]: string} | null; /** * Output only. The `PipelineRun` name with format `projects/{project\}/locations/{location\}/pipelineRuns/{pipeline_run\}` */ @@ -864,10 +868,18 @@ export namespace cloudbuild_v2 { * PipelineSpec defines the desired state of Pipeline. */ pipelineSpec?: Schema$PipelineSpec; + /** + * Optional. Provenance configuration. + */ + provenance?: Schema$Provenance; /** * Output only. The exact PipelineSpec used to instantiate the run. */ resolvedPipelineSpec?: Schema$PipelineSpec; + /** + * Optional. Security configuration. + */ + security?: Schema$Security; /** * Service account used in the Pipeline. */ @@ -892,6 +904,10 @@ export namespace cloudbuild_v2 { * Output only. Time at which the request to update the `PipelineRun` was received. */ updateTime?: string | null; + /** + * Optional. Worker configuration. + */ + worker?: Schema$Worker; /** * Output only. The WorkerPool used to run this PipelineRun. */ @@ -1031,6 +1047,23 @@ export namespace cloudbuild_v2 { */ type?: string | null; } + /** + * Provenance configuration. + */ + export interface Schema$Provenance { + /** + * Optional. Provenance push mode. + */ + enabled?: string | null; + /** + * Optional. Provenance region. + */ + region?: string | null; + /** + * Optional. Where provenance is stored. + */ + storage?: string | null; + } /** * A repository associated to a parent connection. */ @@ -1110,6 +1143,19 @@ export namespace cloudbuild_v2 { */ secretVersion?: string | null; } + /** + * Security configuration. + */ + export interface Schema$Security { + /** + * Optional. Privilege mode. + */ + privilegeMode?: string | null; + /** + * IAM service account whose credentials will be used at runtime. + */ + serviceAccount?: string | null; + } /** * Security options the container should be run with. */ @@ -1480,6 +1526,15 @@ export namespace cloudbuild_v2 { */ values?: string[] | null; } + /** + * Configuration for the worker. + */ + export interface Schema$Worker { + /** + * Optional. Machine type of a worker, default is "e2-standard-2". + */ + machineType?: string | null; + } /** * WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used to refer to a specific instance of a Pipeline. */ From f8a4b91c64f1955d75ed8ffb7d663627a710220c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:15 +0000 Subject: [PATCH 07/43] feat(cloudfunctions): update the API #### cloudfunctions:v2alpha The following keys were added: - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.description - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.flatPath - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.httpMethod - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.id - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameterOrder - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.path - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.request.$ref - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.response.$ref - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.scopes - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.description - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.flatPath - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.httpMethod - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.id - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameterOrder - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.path - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.request.$ref - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.response.$ref - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.scopes - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.description - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.flatPath - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.httpMethod - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.id - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameterOrder - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.path - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.request.$ref - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.response.$ref - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.scopes - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.description - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.flatPath - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.httpMethod - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.id - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameterOrder - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.path - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.request.$ref - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.response.$ref - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.scopes - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.description - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.flatPath - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.httpMethod - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.id - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameterOrder - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.path - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.request.$ref - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.response.$ref - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.scopes - schemas.AbortFunctionUpgradeRequest.description - schemas.AbortFunctionUpgradeRequest.id - schemas.AbortFunctionUpgradeRequest.type - schemas.CommitFunctionUpgradeRequest.description - schemas.CommitFunctionUpgradeRequest.id - schemas.CommitFunctionUpgradeRequest.type - schemas.Function.properties.createTime.description - schemas.Function.properties.createTime.format - schemas.Function.properties.createTime.readOnly - schemas.Function.properties.createTime.type - schemas.Function.properties.upgradeInfo.$ref - schemas.Function.properties.upgradeInfo.description - schemas.Function.properties.upgradeInfo.readOnly - schemas.RedirectFunctionUpgradeTrafficRequest.description - schemas.RedirectFunctionUpgradeTrafficRequest.id - schemas.RedirectFunctionUpgradeTrafficRequest.type - schemas.RollbackFunctionUpgradeTrafficRequest.description - schemas.RollbackFunctionUpgradeTrafficRequest.id - schemas.RollbackFunctionUpgradeTrafficRequest.type - schemas.SetupFunctionUpgradeConfigRequest.description - schemas.SetupFunctionUpgradeConfigRequest.id - schemas.SetupFunctionUpgradeConfigRequest.type - schemas.UpgradeInfo.description - schemas.UpgradeInfo.id - schemas.UpgradeInfo.properties.buildConfig.$ref - schemas.UpgradeInfo.properties.buildConfig.description - schemas.UpgradeInfo.properties.eventTrigger.$ref - schemas.UpgradeInfo.properties.eventTrigger.description - schemas.UpgradeInfo.properties.serviceConfig.$ref - schemas.UpgradeInfo.properties.serviceConfig.description - schemas.UpgradeInfo.properties.upgradeState.description - schemas.UpgradeInfo.properties.upgradeState.enum - schemas.UpgradeInfo.properties.upgradeState.enumDescriptions - schemas.UpgradeInfo.properties.upgradeState.type - schemas.UpgradeInfo.type #### cloudfunctions:v2beta The following keys were added: - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.description - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.flatPath - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.httpMethod - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.id - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameterOrder - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.path - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.request.$ref - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.response.$ref - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.scopes - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.description - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.flatPath - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.httpMethod - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.id - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameterOrder - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.path - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.request.$ref - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.response.$ref - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.scopes - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.description - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.flatPath - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.httpMethod - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.id - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameterOrder - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.path - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.request.$ref - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.response.$ref - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.scopes - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.description - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.flatPath - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.httpMethod - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.id - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameterOrder - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.path - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.request.$ref - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.response.$ref - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.scopes - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.description - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.flatPath - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.httpMethod - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.id - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameterOrder - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.path - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.request.$ref - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.response.$ref - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.scopes - schemas.AbortFunctionUpgradeRequest.description - schemas.AbortFunctionUpgradeRequest.id - schemas.AbortFunctionUpgradeRequest.type - schemas.CommitFunctionUpgradeRequest.description - schemas.CommitFunctionUpgradeRequest.id - schemas.CommitFunctionUpgradeRequest.type - schemas.Function.properties.createTime.description - schemas.Function.properties.createTime.format - schemas.Function.properties.createTime.readOnly - schemas.Function.properties.createTime.type - schemas.Function.properties.upgradeInfo.$ref - schemas.Function.properties.upgradeInfo.description - schemas.Function.properties.upgradeInfo.readOnly - schemas.RedirectFunctionUpgradeTrafficRequest.description - schemas.RedirectFunctionUpgradeTrafficRequest.id - schemas.RedirectFunctionUpgradeTrafficRequest.type - schemas.RollbackFunctionUpgradeTrafficRequest.description - schemas.RollbackFunctionUpgradeTrafficRequest.id - schemas.RollbackFunctionUpgradeTrafficRequest.type - schemas.SetupFunctionUpgradeConfigRequest.description - schemas.SetupFunctionUpgradeConfigRequest.id - schemas.SetupFunctionUpgradeConfigRequest.type - schemas.UpgradeInfo.description - schemas.UpgradeInfo.id - schemas.UpgradeInfo.properties.buildConfig.$ref - schemas.UpgradeInfo.properties.buildConfig.description - schemas.UpgradeInfo.properties.eventTrigger.$ref - schemas.UpgradeInfo.properties.eventTrigger.description - schemas.UpgradeInfo.properties.serviceConfig.$ref - schemas.UpgradeInfo.properties.serviceConfig.description - schemas.UpgradeInfo.properties.upgradeState.description - schemas.UpgradeInfo.properties.upgradeState.enum - schemas.UpgradeInfo.properties.upgradeState.enumDescriptions - schemas.UpgradeInfo.properties.upgradeState.type - schemas.UpgradeInfo.type #### cloudfunctions:v1 The following keys were added: - schemas.CloudFunction.properties.buildServiceAccount.description - schemas.CloudFunction.properties.buildServiceAccount.type The following keys were changed: - schemas.CloudFunction.properties.dockerRegistry.description #### cloudfunctions:v2 The following keys were added: - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.description - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.flatPath - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.httpMethod - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.id - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameterOrder - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.path - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.request.$ref - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.response.$ref - resources.projects.resources.locations.resources.functions.methods.abortFunctionUpgrade.scopes - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.description - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.flatPath - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.httpMethod - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.id - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameterOrder - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.path - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.request.$ref - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.response.$ref - resources.projects.resources.locations.resources.functions.methods.commitFunctionUpgrade.scopes - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.description - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.flatPath - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.httpMethod - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.id - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameterOrder - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.path - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.request.$ref - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.response.$ref - resources.projects.resources.locations.resources.functions.methods.redirectFunctionUpgradeTraffic.scopes - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.description - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.flatPath - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.httpMethod - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.id - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameterOrder - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.path - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.request.$ref - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.response.$ref - resources.projects.resources.locations.resources.functions.methods.rollbackFunctionUpgradeTraffic.scopes - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.description - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.flatPath - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.httpMethod - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.id - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameterOrder - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.description - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.location - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.pattern - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.required - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.parameters.name.type - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.path - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.request.$ref - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.response.$ref - resources.projects.resources.locations.resources.functions.methods.setupFunctionUpgradeConfig.scopes - schemas.AbortFunctionUpgradeRequest.description - schemas.AbortFunctionUpgradeRequest.id - schemas.AbortFunctionUpgradeRequest.type - schemas.CommitFunctionUpgradeRequest.description - schemas.CommitFunctionUpgradeRequest.id - schemas.CommitFunctionUpgradeRequest.type - schemas.Function.properties.createTime.description - schemas.Function.properties.createTime.format - schemas.Function.properties.createTime.readOnly - schemas.Function.properties.createTime.type - schemas.Function.properties.upgradeInfo.$ref - schemas.Function.properties.upgradeInfo.description - schemas.Function.properties.upgradeInfo.readOnly - schemas.RedirectFunctionUpgradeTrafficRequest.description - schemas.RedirectFunctionUpgradeTrafficRequest.id - schemas.RedirectFunctionUpgradeTrafficRequest.type - schemas.RollbackFunctionUpgradeTrafficRequest.description - schemas.RollbackFunctionUpgradeTrafficRequest.id - schemas.RollbackFunctionUpgradeTrafficRequest.type - schemas.SetupFunctionUpgradeConfigRequest.description - schemas.SetupFunctionUpgradeConfigRequest.id - schemas.SetupFunctionUpgradeConfigRequest.type - schemas.UpgradeInfo.description - schemas.UpgradeInfo.id - schemas.UpgradeInfo.properties.buildConfig.$ref - schemas.UpgradeInfo.properties.buildConfig.description - schemas.UpgradeInfo.properties.eventTrigger.$ref - schemas.UpgradeInfo.properties.eventTrigger.description - schemas.UpgradeInfo.properties.serviceConfig.$ref - schemas.UpgradeInfo.properties.serviceConfig.description - schemas.UpgradeInfo.properties.upgradeState.description - schemas.UpgradeInfo.properties.upgradeState.enum - schemas.UpgradeInfo.properties.upgradeState.enumDescriptions - schemas.UpgradeInfo.properties.upgradeState.type - schemas.UpgradeInfo.type --- discovery/cloudfunctions-v1.json | 8 +- discovery/cloudfunctions-v2.json | 230 ++++++++++- discovery/cloudfunctions-v2alpha.json | 230 ++++++++++- discovery/cloudfunctions-v2beta.json | 230 ++++++++++- src/apis/cloudfunctions/v1.ts | 6 +- src/apis/cloudfunctions/v2.ts | 562 ++++++++++++++++++++++++++ src/apis/cloudfunctions/v2alpha.ts | 561 +++++++++++++++++++++++++ src/apis/cloudfunctions/v2beta.ts | 561 +++++++++++++++++++++++++ 8 files changed, 2382 insertions(+), 6 deletions(-) diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index b99107b12b..a30e1ea5f5 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -552,7 +552,7 @@ } } }, - "revision": "20240118", + "revision": "20240205", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -691,6 +691,10 @@ "readOnly": true, "type": "string" }, + "buildServiceAccount": { + "description": "Optional. A service account the user provides for use with Cloud Build.", + "type": "string" + }, "buildWorkerPool": { "description": "Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where `{project}` and `{region}` are the project id and region respectively where the worker pool is defined and `{workerPool}` is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (`service-@gcf-admin-robot.iam.gserviceaccount.com`) must be granted the role Cloud Build Custom Workers Builder (`roles/cloudbuild.customworkers.builder`) in the project.", "type": "string" @@ -700,7 +704,7 @@ "type": "string" }, "dockerRegistry": { - "description": "Docker Registry to use for this deployment. 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. 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-v2.json b/discovery/cloudfunctions-v2.json index 445eef7b1c..545afcefaf 100644 --- a/discovery/cloudfunctions-v2.json +++ b/discovery/cloudfunctions-v2.json @@ -154,6 +154,62 @@ "resources": { "functions": { "methods": { + "abortFunctionUpgrade": { + "description": "Aborts generation upgrade process for a function with the given name from the specified project. Deletes all 2nd Gen copy related configuration and resources which were created during the upgrade process.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:abortFunctionUpgrade", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.abortFunctionUpgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which upgrade should be aborted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:abortFunctionUpgrade", + "request": { + "$ref": "AbortFunctionUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "commitFunctionUpgrade": { + "description": "Finalizes the upgrade after which function upgrade can not be rolled back. This is the last step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Deletes all original 1st Gen related configuration and resources.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:commitFunctionUpgrade", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.commitFunctionUpgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which upgrade should be finalized.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:commitFunctionUpgrade", + "request": { + "$ref": "CommitFunctionUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions", @@ -404,6 +460,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "redirectFunctionUpgradeTraffic": { + "description": "Changes the traffic target of a function from the original 1st Gen function to the 2nd Gen copy. This is the second step of the multi step process to upgrade 1st Gen functions to 2nd Gen. After this operation, all new traffic will be served by 2nd Gen copy.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:redirectFunctionUpgradeTraffic", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.redirectFunctionUpgradeTraffic", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:redirectFunctionUpgradeTraffic", + "request": { + "$ref": "RedirectFunctionUpgradeTrafficRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rollbackFunctionUpgradeTraffic": { + "description": "Reverts the traffic target of a function from the 2nd Gen copy to the original 1st Gen function. After this operation, all new traffic would be served by the 1st Gen.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:rollbackFunctionUpgradeTraffic", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.rollbackFunctionUpgradeTraffic", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:rollbackFunctionUpgradeTraffic", + "request": { + "$ref": "RollbackFunctionUpgradeTrafficRequest" + }, + "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": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy", @@ -432,6 +544,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setupFunctionUpgradeConfig": { + "description": "Creates a 2nd Gen copy of the function configuration based on the 1st Gen function with the given name. This is the first step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Only 2nd Gen configuration is setup as part of this request and traffic continues to be served by 1st Gen.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setupFunctionUpgradeConfig", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.setupFunctionUpgradeConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function which should have configuration copied for upgrade.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:setupFunctionUpgradeConfig", + "request": { + "$ref": "SetupFunctionUpgradeConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "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": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:testIamPermissions", @@ -571,9 +711,15 @@ } } }, - "revision": "20240118", + "revision": "20240205", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { + "AbortFunctionUpgradeRequest": { + "description": "Request for the `AbortFunctionUpgrade` method.", + "id": "AbortFunctionUpgradeRequest", + "properties": {}, + "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", @@ -724,6 +870,12 @@ }, "type": "object" }, + "CommitFunctionUpgradeRequest": { + "description": "Request for the `CommitFunctionUpgrade` method.", + "id": "CommitFunctionUpgradeRequest", + "properties": {}, + "type": "object" + }, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -853,6 +1005,12 @@ "$ref": "BuildConfig", "description": "Describes the Build step of the function that builds a container from the given source." }, + "createTime": { + "description": "Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "description": { "description": "User-provided description of a function.", "type": "string" @@ -934,6 +1092,11 @@ "readOnly": true, "type": "string" }, + "upgradeInfo": { + "$ref": "UpgradeInfo", + "description": "Output only. UpgradeInfo for this Cloud Function", + "readOnly": true + }, "url": { "description": "Output only. The deployed url for the function.", "readOnly": true, @@ -1846,6 +2009,12 @@ }, "type": "object" }, + "RedirectFunctionUpgradeTrafficRequest": { + "description": "Request for the `RedirectFunctionUpgradeTraffic` method.", + "id": "RedirectFunctionUpgradeTrafficRequest", + "properties": {}, + "type": "object" + }, "RepoSource": { "description": "Location of the source in a Google Cloud Source Repository.", "id": "RepoSource", @@ -1877,6 +2046,12 @@ }, "type": "object" }, + "RollbackFunctionUpgradeTrafficRequest": { + "description": "Request for the `RollbackFunctionUpgradeTraffic` method.", + "id": "RollbackFunctionUpgradeTrafficRequest", + "properties": {}, + "type": "object" + }, "Runtime": { "description": "Describes a runtime and any special information (e.g., deprecation status) related to it.", "id": "Runtime", @@ -2150,6 +2325,12 @@ }, "type": "object" }, + "SetupFunctionUpgradeConfigRequest": { + "description": "Request for the `SetupFunctionUpgradeConfig` method.", + "id": "SetupFunctionUpgradeConfigRequest", + "properties": {}, + "type": "object" + }, "Source": { "description": "The location of the function source code.", "id": "Source", @@ -2262,6 +2443,53 @@ } }, "type": "object" + }, + "UpgradeInfo": { + "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration * Current state of migration for function undergoing migration.", + "id": "UpgradeInfo", + "properties": { + "buildConfig": { + "$ref": "BuildConfig", + "description": "Describes the Build step of the function that builds a container to prepare for 2nd gen upgrade." + }, + "eventTrigger": { + "$ref": "EventTrigger", + "description": "Describes the Event trigger which has been setup to prepare for 2nd gen upgrade." + }, + "serviceConfig": { + "$ref": "ServiceConfig", + "description": "Describes the Cloud Run service which has been setup to prepare for 2nd gen upgrade." + }, + "upgradeState": { + "description": "UpgradeState of the function", + "enum": [ + "UPGRADE_STATE_UNSPECIFIED", + "ELIGIBLE_FOR_2ND_GEN_UPGRADE", + "UPGRADE_OPERATION_IN_PROGRESS", + "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", + "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", + "ABORT_FUNCTION_UPGRADE_ERROR", + "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_SUCCESSFUL", + "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_ERROR", + "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC_ERROR", + "COMMIT_FUNCTION_UPGRADE_ERROR" + ], + "enumDescriptions": [ + "Unspecified state. Most functions are in this upgrade state.", + "Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", + "An upgrade related operation is in progress.", + "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", + "SetupFunctionUpgradeConfig API was un-successful.", + "AbortFunctionUpgrade API was un-successful.", + "RedirectFunctionUpgradeTraffic API was successful and traffic is served by 2nd Gen function stack.", + "RedirectFunctionUpgradeTraffic API was un-successful.", + "RollbackFunctionUpgradeTraffic API was un-successful.", + "CommitFunctionUpgrade API was un-successful." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/cloudfunctions-v2alpha.json b/discovery/cloudfunctions-v2alpha.json index 5030e670cf..92687ab71d 100644 --- a/discovery/cloudfunctions-v2alpha.json +++ b/discovery/cloudfunctions-v2alpha.json @@ -154,6 +154,62 @@ "resources": { "functions": { "methods": { + "abortFunctionUpgrade": { + "description": "Aborts generation upgrade process for a function with the given name from the specified project. Deletes all 2nd Gen copy related configuration and resources which were created during the upgrade process.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:abortFunctionUpgrade", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.abortFunctionUpgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which upgrade should be aborted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+name}:abortFunctionUpgrade", + "request": { + "$ref": "AbortFunctionUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "commitFunctionUpgrade": { + "description": "Finalizes the upgrade after which function upgrade can not be rolled back. This is the last step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Deletes all original 1st Gen related configuration and resources.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:commitFunctionUpgrade", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.commitFunctionUpgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which upgrade should be finalized.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+name}:commitFunctionUpgrade", + "request": { + "$ref": "CommitFunctionUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions", @@ -404,6 +460,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "redirectFunctionUpgradeTraffic": { + "description": "Changes the traffic target of a function from the original 1st Gen function to the 2nd Gen copy. This is the second step of the multi step process to upgrade 1st Gen functions to 2nd Gen. After this operation, all new traffic will be served by 2nd Gen copy.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:redirectFunctionUpgradeTraffic", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.redirectFunctionUpgradeTraffic", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+name}:redirectFunctionUpgradeTraffic", + "request": { + "$ref": "RedirectFunctionUpgradeTrafficRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rollbackFunctionUpgradeTraffic": { + "description": "Reverts the traffic target of a function from the 2nd Gen copy to the original 1st Gen function. After this operation, all new traffic would be served by the 1st Gen.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:rollbackFunctionUpgradeTraffic", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.rollbackFunctionUpgradeTraffic", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+name}:rollbackFunctionUpgradeTraffic", + "request": { + "$ref": "RollbackFunctionUpgradeTrafficRequest" + }, + "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": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy", @@ -432,6 +544,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setupFunctionUpgradeConfig": { + "description": "Creates a 2nd Gen copy of the function configuration based on the 1st Gen function with the given name. This is the first step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Only 2nd Gen configuration is setup as part of this request and traffic continues to be served by 1st Gen.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setupFunctionUpgradeConfig", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.setupFunctionUpgradeConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function which should have configuration copied for upgrade.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+name}:setupFunctionUpgradeConfig", + "request": { + "$ref": "SetupFunctionUpgradeConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "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": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:testIamPermissions", @@ -571,9 +711,15 @@ } } }, - "revision": "20240118", + "revision": "20240205", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { + "AbortFunctionUpgradeRequest": { + "description": "Request for the `AbortFunctionUpgrade` method.", + "id": "AbortFunctionUpgradeRequest", + "properties": {}, + "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", @@ -724,6 +870,12 @@ }, "type": "object" }, + "CommitFunctionUpgradeRequest": { + "description": "Request for the `CommitFunctionUpgrade` method.", + "id": "CommitFunctionUpgradeRequest", + "properties": {}, + "type": "object" + }, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -853,6 +1005,12 @@ "$ref": "BuildConfig", "description": "Describes the Build step of the function that builds a container from the given source." }, + "createTime": { + "description": "Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "description": { "description": "User-provided description of a function.", "type": "string" @@ -934,6 +1092,11 @@ "readOnly": true, "type": "string" }, + "upgradeInfo": { + "$ref": "UpgradeInfo", + "description": "Output only. UpgradeInfo for this Cloud Function", + "readOnly": true + }, "url": { "description": "Output only. The deployed url for the function.", "readOnly": true, @@ -1846,6 +2009,12 @@ }, "type": "object" }, + "RedirectFunctionUpgradeTrafficRequest": { + "description": "Request for the `RedirectFunctionUpgradeTraffic` method.", + "id": "RedirectFunctionUpgradeTrafficRequest", + "properties": {}, + "type": "object" + }, "RepoSource": { "description": "Location of the source in a Google Cloud Source Repository.", "id": "RepoSource", @@ -1877,6 +2046,12 @@ }, "type": "object" }, + "RollbackFunctionUpgradeTrafficRequest": { + "description": "Request for the `RollbackFunctionUpgradeTraffic` method.", + "id": "RollbackFunctionUpgradeTrafficRequest", + "properties": {}, + "type": "object" + }, "Runtime": { "description": "Describes a runtime and any special information (e.g., deprecation status) related to it.", "id": "Runtime", @@ -2150,6 +2325,12 @@ }, "type": "object" }, + "SetupFunctionUpgradeConfigRequest": { + "description": "Request for the `SetupFunctionUpgradeConfig` method.", + "id": "SetupFunctionUpgradeConfigRequest", + "properties": {}, + "type": "object" + }, "Source": { "description": "The location of the function source code.", "id": "Source", @@ -2262,6 +2443,53 @@ } }, "type": "object" + }, + "UpgradeInfo": { + "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration * Current state of migration for function undergoing migration.", + "id": "UpgradeInfo", + "properties": { + "buildConfig": { + "$ref": "BuildConfig", + "description": "Describes the Build step of the function that builds a container to prepare for 2nd gen upgrade." + }, + "eventTrigger": { + "$ref": "EventTrigger", + "description": "Describes the Event trigger which has been setup to prepare for 2nd gen upgrade." + }, + "serviceConfig": { + "$ref": "ServiceConfig", + "description": "Describes the Cloud Run service which has been setup to prepare for 2nd gen upgrade." + }, + "upgradeState": { + "description": "UpgradeState of the function", + "enum": [ + "UPGRADE_STATE_UNSPECIFIED", + "ELIGIBLE_FOR_2ND_GEN_UPGRADE", + "UPGRADE_OPERATION_IN_PROGRESS", + "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", + "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", + "ABORT_FUNCTION_UPGRADE_ERROR", + "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_SUCCESSFUL", + "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_ERROR", + "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC_ERROR", + "COMMIT_FUNCTION_UPGRADE_ERROR" + ], + "enumDescriptions": [ + "Unspecified state. Most functions are in this upgrade state.", + "Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", + "An upgrade related operation is in progress.", + "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", + "SetupFunctionUpgradeConfig API was un-successful.", + "AbortFunctionUpgrade API was un-successful.", + "RedirectFunctionUpgradeTraffic API was successful and traffic is served by 2nd Gen function stack.", + "RedirectFunctionUpgradeTraffic API was un-successful.", + "RollbackFunctionUpgradeTraffic API was un-successful.", + "CommitFunctionUpgrade API was un-successful." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/cloudfunctions-v2beta.json b/discovery/cloudfunctions-v2beta.json index 8be92e67c7..b8307f751b 100644 --- a/discovery/cloudfunctions-v2beta.json +++ b/discovery/cloudfunctions-v2beta.json @@ -154,6 +154,62 @@ "resources": { "functions": { "methods": { + "abortFunctionUpgrade": { + "description": "Aborts generation upgrade process for a function with the given name from the specified project. Deletes all 2nd Gen copy related configuration and resources which were created during the upgrade process.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:abortFunctionUpgrade", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.abortFunctionUpgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which upgrade should be aborted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+name}:abortFunctionUpgrade", + "request": { + "$ref": "AbortFunctionUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "commitFunctionUpgrade": { + "description": "Finalizes the upgrade after which function upgrade can not be rolled back. This is the last step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Deletes all original 1st Gen related configuration and resources.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:commitFunctionUpgrade", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.commitFunctionUpgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which upgrade should be finalized.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+name}:commitFunctionUpgrade", + "request": { + "$ref": "CommitFunctionUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/functions", @@ -404,6 +460,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "redirectFunctionUpgradeTraffic": { + "description": "Changes the traffic target of a function from the original 1st Gen function to the 2nd Gen copy. This is the second step of the multi step process to upgrade 1st Gen functions to 2nd Gen. After this operation, all new traffic will be served by 2nd Gen copy.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:redirectFunctionUpgradeTraffic", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.redirectFunctionUpgradeTraffic", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+name}:redirectFunctionUpgradeTraffic", + "request": { + "$ref": "RedirectFunctionUpgradeTrafficRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rollbackFunctionUpgradeTraffic": { + "description": "Reverts the traffic target of a function from the 2nd Gen copy to the original 1st Gen function. After this operation, all new traffic would be served by the 1st Gen.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:rollbackFunctionUpgradeTraffic", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.rollbackFunctionUpgradeTraffic", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+name}:rollbackFunctionUpgradeTraffic", + "request": { + "$ref": "RollbackFunctionUpgradeTrafficRequest" + }, + "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": "v2beta/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy", @@ -432,6 +544,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setupFunctionUpgradeConfig": { + "description": "Creates a 2nd Gen copy of the function configuration based on the 1st Gen function with the given name. This is the first step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Only 2nd Gen configuration is setup as part of this request and traffic continues to be served by 1st Gen.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setupFunctionUpgradeConfig", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.setupFunctionUpgradeConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function which should have configuration copied for upgrade.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+name}:setupFunctionUpgradeConfig", + "request": { + "$ref": "SetupFunctionUpgradeConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "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": "v2beta/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:testIamPermissions", @@ -571,9 +711,15 @@ } } }, - "revision": "20240118", + "revision": "20240205", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { + "AbortFunctionUpgradeRequest": { + "description": "Request for the `AbortFunctionUpgrade` method.", + "id": "AbortFunctionUpgradeRequest", + "properties": {}, + "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", @@ -724,6 +870,12 @@ }, "type": "object" }, + "CommitFunctionUpgradeRequest": { + "description": "Request for the `CommitFunctionUpgrade` method.", + "id": "CommitFunctionUpgradeRequest", + "properties": {}, + "type": "object" + }, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -853,6 +1005,12 @@ "$ref": "BuildConfig", "description": "Describes the Build step of the function that builds a container from the given source." }, + "createTime": { + "description": "Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "description": { "description": "User-provided description of a function.", "type": "string" @@ -934,6 +1092,11 @@ "readOnly": true, "type": "string" }, + "upgradeInfo": { + "$ref": "UpgradeInfo", + "description": "Output only. UpgradeInfo for this Cloud Function", + "readOnly": true + }, "url": { "description": "Output only. The deployed url for the function.", "readOnly": true, @@ -1846,6 +2009,12 @@ }, "type": "object" }, + "RedirectFunctionUpgradeTrafficRequest": { + "description": "Request for the `RedirectFunctionUpgradeTraffic` method.", + "id": "RedirectFunctionUpgradeTrafficRequest", + "properties": {}, + "type": "object" + }, "RepoSource": { "description": "Location of the source in a Google Cloud Source Repository.", "id": "RepoSource", @@ -1877,6 +2046,12 @@ }, "type": "object" }, + "RollbackFunctionUpgradeTrafficRequest": { + "description": "Request for the `RollbackFunctionUpgradeTraffic` method.", + "id": "RollbackFunctionUpgradeTrafficRequest", + "properties": {}, + "type": "object" + }, "Runtime": { "description": "Describes a runtime and any special information (e.g., deprecation status) related to it.", "id": "Runtime", @@ -2150,6 +2325,12 @@ }, "type": "object" }, + "SetupFunctionUpgradeConfigRequest": { + "description": "Request for the `SetupFunctionUpgradeConfig` method.", + "id": "SetupFunctionUpgradeConfigRequest", + "properties": {}, + "type": "object" + }, "Source": { "description": "The location of the function source code.", "id": "Source", @@ -2262,6 +2443,53 @@ } }, "type": "object" + }, + "UpgradeInfo": { + "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration * Current state of migration for function undergoing migration.", + "id": "UpgradeInfo", + "properties": { + "buildConfig": { + "$ref": "BuildConfig", + "description": "Describes the Build step of the function that builds a container to prepare for 2nd gen upgrade." + }, + "eventTrigger": { + "$ref": "EventTrigger", + "description": "Describes the Event trigger which has been setup to prepare for 2nd gen upgrade." + }, + "serviceConfig": { + "$ref": "ServiceConfig", + "description": "Describes the Cloud Run service which has been setup to prepare for 2nd gen upgrade." + }, + "upgradeState": { + "description": "UpgradeState of the function", + "enum": [ + "UPGRADE_STATE_UNSPECIFIED", + "ELIGIBLE_FOR_2ND_GEN_UPGRADE", + "UPGRADE_OPERATION_IN_PROGRESS", + "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", + "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", + "ABORT_FUNCTION_UPGRADE_ERROR", + "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_SUCCESSFUL", + "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_ERROR", + "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC_ERROR", + "COMMIT_FUNCTION_UPGRADE_ERROR" + ], + "enumDescriptions": [ + "Unspecified state. Most functions are in this upgrade state.", + "Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", + "An upgrade related operation is in progress.", + "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", + "SetupFunctionUpgradeConfig API was un-successful.", + "AbortFunctionUpgrade API was un-successful.", + "RedirectFunctionUpgradeTraffic API was successful and traffic is served by 2nd Gen function stack.", + "RedirectFunctionUpgradeTraffic API was un-successful.", + "RollbackFunctionUpgradeTraffic API was un-successful.", + "CommitFunctionUpgrade API was un-successful." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 47ab454ebd..1807897cdb 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -223,6 +223,10 @@ export namespace cloudfunctions_v1 { * Output only. The Cloud Build Name of the function deployment. `projects//locations//builds/`. */ buildName?: string | null; + /** + * Optional. A service account the user provides for use with Cloud Build. + */ + buildServiceAccount?: string | null; /** * Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project\}/locations/{region\}/workerPools/{workerPool\}` where `{project\}` and `{region\}` are the project id and region respectively where the worker pool is defined and `{workerPool\}` is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (`service-@gcf-admin-robot.iam.gserviceaccount.com`) must be granted the role Cloud Build Custom Workers Builder (`roles/cloudbuild.customworkers.builder`) in the project. */ @@ -232,7 +236,7 @@ export namespace cloudfunctions_v1 { */ description?: string | null; /** - * Docker Registry to use for this deployment. 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. 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; /** diff --git a/src/apis/cloudfunctions/v2.ts b/src/apis/cloudfunctions/v2.ts index 35ffa00eea..5d087a218b 100644 --- a/src/apis/cloudfunctions/v2.ts +++ b/src/apis/cloudfunctions/v2.ts @@ -124,6 +124,10 @@ export namespace cloudfunctions_v2 { } } + /** + * Request for the `AbortFunctionUpgrade` method. + */ + export interface Schema$AbortFunctionUpgradeRequest {} /** * 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. */ @@ -228,6 +232,10 @@ export namespace cloudfunctions_v2 { */ workerPool?: string | null; } + /** + * Request for the `CommitFunctionUpgrade` method. + */ + export interface Schema$CommitFunctionUpgradeRequest {} /** * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp */ @@ -332,6 +340,10 @@ export namespace cloudfunctions_v2 { * Describes the Build step of the function that builds a container from the given source. */ buildConfig?: Schema$BuildConfig; + /** + * Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions. + */ + createTime?: string | null; /** * User-provided description of a function. */ @@ -376,6 +388,10 @@ export namespace cloudfunctions_v2 { * Output only. The last update timestamp of a Cloud Function. */ updateTime?: string | null; + /** + * Output only. UpgradeInfo for this Cloud Function + */ + upgradeInfo?: Schema$UpgradeInfo; /** * Output only. The deployed url for the function. */ @@ -901,6 +917,10 @@ export namespace cloudfunctions_v2 { */ version?: number | null; } + /** + * Request for the `RedirectFunctionUpgradeTraffic` method. + */ + export interface Schema$RedirectFunctionUpgradeTrafficRequest {} /** * Location of the source in a Google Cloud Source Repository. */ @@ -930,6 +950,10 @@ export namespace cloudfunctions_v2 { */ tagName?: string | null; } + /** + * Request for the `RollbackFunctionUpgradeTraffic` method. + */ + export interface Schema$RollbackFunctionUpgradeTrafficRequest {} /** * Describes a runtime and any special information (e.g., deprecation status) related to it. */ @@ -1108,6 +1132,10 @@ export namespace cloudfunctions_v2 { */ updateMask?: string | null; } + /** + * Request for the `SetupFunctionUpgradeConfig` method. + */ + export interface Schema$SetupFunctionUpgradeConfigRequest {} /** * The location of the function source code. */ @@ -1194,6 +1222,27 @@ export namespace cloudfunctions_v2 { */ permissions?: string[] | null; } + /** + * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration * Current state of migration for function undergoing migration. + */ + export interface Schema$UpgradeInfo { + /** + * Describes the Build step of the function that builds a container to prepare for 2nd gen upgrade. + */ + buildConfig?: Schema$BuildConfig; + /** + * Describes the Event trigger which has been setup to prepare for 2nd gen upgrade. + */ + eventTrigger?: Schema$EventTrigger; + /** + * Describes the Cloud Run service which has been setup to prepare for 2nd gen upgrade. + */ + serviceConfig?: Schema$ServiceConfig; + /** + * UpgradeState of the function + */ + upgradeState?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -1338,6 +1387,188 @@ export namespace cloudfunctions_v2 { this.context = context; } + /** + * Aborts generation upgrade process for a function with the given name from the specified project. Deletes all 2nd Gen copy related configuration and resources which were created during the upgrade process. + * + * @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. + */ + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: StreamMethodOptions + ): GaxiosPromise; + abortFunctionUpgrade( + params?: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options?: MethodOptions + ): GaxiosPromise; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:abortFunctionUpgrade').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); + } + } + + /** + * Finalizes the upgrade after which function upgrade can not be rolled back. This is the last step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Deletes all original 1st Gen related configuration and resources. + * + * @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. + */ + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: StreamMethodOptions + ): GaxiosPromise; + commitFunctionUpgrade( + params?: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options?: MethodOptions + ): GaxiosPromise; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:commitFunctionUpgrade').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); + } + } + /** * Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error. * @@ -2054,6 +2285,186 @@ export namespace cloudfunctions_v2 { } } + /** + * Changes the traffic target of a function from the original 1st Gen function to the 2nd Gen copy. This is the second step of the multi step process to upgrade 1st Gen functions to 2nd Gen. After this operation, all new traffic will be served by 2nd Gen copy. + * + * @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. + */ + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: StreamMethodOptions + ): GaxiosPromise; + redirectFunctionUpgradeTraffic( + params?: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options?: MethodOptions + ): GaxiosPromise; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2/{+name}:redirectFunctionUpgradeTraffic' + ).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); + } + } + + /** + * Reverts the traffic target of a function from the 2nd Gen copy to the original 1st Gen function. After this operation, all new traffic would be served by the 1st Gen. + * + * @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. + */ + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: StreamMethodOptions + ): GaxiosPromise; + rollbackFunctionUpgradeTraffic( + params?: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options?: MethodOptions + ): GaxiosPromise; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2/{+name}:rollbackFunctionUpgradeTraffic' + ).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); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @@ -2143,6 +2554,97 @@ export namespace cloudfunctions_v2 { } } + /** + * Creates a 2nd Gen copy of the function configuration based on the 1st Gen function with the given name. This is the first step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Only 2nd Gen configuration is setup as part of this request and traffic continues to be served by 1st Gen. + * + * @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. + */ + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: StreamMethodOptions + ): GaxiosPromise; + setupFunctionUpgradeConfig( + params?: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options?: MethodOptions + ): GaxiosPromise; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:setupFunctionUpgradeConfig').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); + } + } + /** * 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. * @@ -2240,6 +2742,30 @@ export namespace cloudfunctions_v2 { } } + export interface Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade + extends StandardParameters { + /** + * Required. The name of the function for which upgrade should be aborted. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AbortFunctionUpgradeRequest; + } + export interface Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade + extends StandardParameters { + /** + * Required. The name of the function for which upgrade should be finalized. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CommitFunctionUpgradeRequest; + } export interface Params$Resource$Projects$Locations$Functions$Create extends StandardParameters { /** @@ -2344,6 +2870,30 @@ export namespace cloudfunctions_v2 { */ requestBody?: Schema$Function; } + export interface Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic + extends StandardParameters { + /** + * Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RedirectFunctionUpgradeTrafficRequest; + } + export interface Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic + extends StandardParameters { + /** + * Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RollbackFunctionUpgradeTrafficRequest; + } export interface Params$Resource$Projects$Locations$Functions$Setiampolicy extends StandardParameters { /** @@ -2356,6 +2906,18 @@ export namespace cloudfunctions_v2 { */ requestBody?: Schema$SetIamPolicyRequest; } + export interface Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig + extends StandardParameters { + /** + * Required. The name of the function which should have configuration copied for upgrade. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetupFunctionUpgradeConfigRequest; + } export interface Params$Resource$Projects$Locations$Functions$Testiampermissions extends StandardParameters { /** diff --git a/src/apis/cloudfunctions/v2alpha.ts b/src/apis/cloudfunctions/v2alpha.ts index 0930c3dcd7..8347049d00 100644 --- a/src/apis/cloudfunctions/v2alpha.ts +++ b/src/apis/cloudfunctions/v2alpha.ts @@ -124,6 +124,10 @@ export namespace cloudfunctions_v2alpha { } } + /** + * Request for the `AbortFunctionUpgrade` method. + */ + export interface Schema$AbortFunctionUpgradeRequest {} /** * 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. */ @@ -228,6 +232,10 @@ export namespace cloudfunctions_v2alpha { */ workerPool?: string | null; } + /** + * Request for the `CommitFunctionUpgrade` method. + */ + export interface Schema$CommitFunctionUpgradeRequest {} /** * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp */ @@ -332,6 +340,10 @@ export namespace cloudfunctions_v2alpha { * Describes the Build step of the function that builds a container from the given source. */ buildConfig?: Schema$BuildConfig; + /** + * Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions. + */ + createTime?: string | null; /** * User-provided description of a function. */ @@ -376,6 +388,10 @@ export namespace cloudfunctions_v2alpha { * Output only. The last update timestamp of a Cloud Function. */ updateTime?: string | null; + /** + * Output only. UpgradeInfo for this Cloud Function + */ + upgradeInfo?: Schema$UpgradeInfo; /** * Output only. The deployed url for the function. */ @@ -901,6 +917,10 @@ export namespace cloudfunctions_v2alpha { */ version?: number | null; } + /** + * Request for the `RedirectFunctionUpgradeTraffic` method. + */ + export interface Schema$RedirectFunctionUpgradeTrafficRequest {} /** * Location of the source in a Google Cloud Source Repository. */ @@ -930,6 +950,10 @@ export namespace cloudfunctions_v2alpha { */ tagName?: string | null; } + /** + * Request for the `RollbackFunctionUpgradeTraffic` method. + */ + export interface Schema$RollbackFunctionUpgradeTrafficRequest {} /** * Describes a runtime and any special information (e.g., deprecation status) related to it. */ @@ -1108,6 +1132,10 @@ export namespace cloudfunctions_v2alpha { */ updateMask?: string | null; } + /** + * Request for the `SetupFunctionUpgradeConfig` method. + */ + export interface Schema$SetupFunctionUpgradeConfigRequest {} /** * The location of the function source code. */ @@ -1194,6 +1222,27 @@ export namespace cloudfunctions_v2alpha { */ permissions?: string[] | null; } + /** + * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration * Current state of migration for function undergoing migration. + */ + export interface Schema$UpgradeInfo { + /** + * Describes the Build step of the function that builds a container to prepare for 2nd gen upgrade. + */ + buildConfig?: Schema$BuildConfig; + /** + * Describes the Event trigger which has been setup to prepare for 2nd gen upgrade. + */ + eventTrigger?: Schema$EventTrigger; + /** + * Describes the Cloud Run service which has been setup to prepare for 2nd gen upgrade. + */ + serviceConfig?: Schema$ServiceConfig; + /** + * UpgradeState of the function + */ + upgradeState?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -1338,6 +1387,188 @@ export namespace cloudfunctions_v2alpha { this.context = context; } + /** + * Aborts generation upgrade process for a function with the given name from the specified project. Deletes all 2nd Gen copy related configuration and resources which were created during the upgrade process. + * + * @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. + */ + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: StreamMethodOptions + ): GaxiosPromise; + abortFunctionUpgrade( + params?: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options?: MethodOptions + ): GaxiosPromise; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+name}:abortFunctionUpgrade').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); + } + } + + /** + * Finalizes the upgrade after which function upgrade can not be rolled back. This is the last step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Deletes all original 1st Gen related configuration and resources. + * + * @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. + */ + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: StreamMethodOptions + ): GaxiosPromise; + commitFunctionUpgrade( + params?: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options?: MethodOptions + ): GaxiosPromise; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+name}:commitFunctionUpgrade').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); + } + } + /** * Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error. * @@ -2054,6 +2285,186 @@ export namespace cloudfunctions_v2alpha { } } + /** + * Changes the traffic target of a function from the original 1st Gen function to the 2nd Gen copy. This is the second step of the multi step process to upgrade 1st Gen functions to 2nd Gen. After this operation, all new traffic will be served by 2nd Gen copy. + * + * @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. + */ + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: StreamMethodOptions + ): GaxiosPromise; + redirectFunctionUpgradeTraffic( + params?: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options?: MethodOptions + ): GaxiosPromise; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2alpha/{+name}:redirectFunctionUpgradeTraffic' + ).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); + } + } + + /** + * Reverts the traffic target of a function from the 2nd Gen copy to the original 1st Gen function. After this operation, all new traffic would be served by the 1st Gen. + * + * @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. + */ + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: StreamMethodOptions + ): GaxiosPromise; + rollbackFunctionUpgradeTraffic( + params?: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options?: MethodOptions + ): GaxiosPromise; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2alpha/{+name}:rollbackFunctionUpgradeTraffic' + ).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); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @@ -2143,6 +2554,96 @@ export namespace cloudfunctions_v2alpha { } } + /** + * Creates a 2nd Gen copy of the function configuration based on the 1st Gen function with the given name. This is the first step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Only 2nd Gen configuration is setup as part of this request and traffic continues to be served by 1st Gen. + * + * @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. + */ + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: StreamMethodOptions + ): GaxiosPromise; + setupFunctionUpgradeConfig( + params?: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options?: MethodOptions + ): GaxiosPromise; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2alpha/{+name}:setupFunctionUpgradeConfig' + ).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); + } + } + /** * 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. * @@ -2240,6 +2741,30 @@ export namespace cloudfunctions_v2alpha { } } + export interface Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade + extends StandardParameters { + /** + * Required. The name of the function for which upgrade should be aborted. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AbortFunctionUpgradeRequest; + } + export interface Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade + extends StandardParameters { + /** + * Required. The name of the function for which upgrade should be finalized. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CommitFunctionUpgradeRequest; + } export interface Params$Resource$Projects$Locations$Functions$Create extends StandardParameters { /** @@ -2344,6 +2869,30 @@ export namespace cloudfunctions_v2alpha { */ requestBody?: Schema$Function; } + export interface Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic + extends StandardParameters { + /** + * Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RedirectFunctionUpgradeTrafficRequest; + } + export interface Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic + extends StandardParameters { + /** + * Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RollbackFunctionUpgradeTrafficRequest; + } export interface Params$Resource$Projects$Locations$Functions$Setiampolicy extends StandardParameters { /** @@ -2356,6 +2905,18 @@ export namespace cloudfunctions_v2alpha { */ requestBody?: Schema$SetIamPolicyRequest; } + export interface Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig + extends StandardParameters { + /** + * Required. The name of the function which should have configuration copied for upgrade. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetupFunctionUpgradeConfigRequest; + } export interface Params$Resource$Projects$Locations$Functions$Testiampermissions extends StandardParameters { /** diff --git a/src/apis/cloudfunctions/v2beta.ts b/src/apis/cloudfunctions/v2beta.ts index 5dd65de063..cad29aa20a 100644 --- a/src/apis/cloudfunctions/v2beta.ts +++ b/src/apis/cloudfunctions/v2beta.ts @@ -124,6 +124,10 @@ export namespace cloudfunctions_v2beta { } } + /** + * Request for the `AbortFunctionUpgrade` method. + */ + export interface Schema$AbortFunctionUpgradeRequest {} /** * 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. */ @@ -228,6 +232,10 @@ export namespace cloudfunctions_v2beta { */ workerPool?: string | null; } + /** + * Request for the `CommitFunctionUpgrade` method. + */ + export interface Schema$CommitFunctionUpgradeRequest {} /** * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp */ @@ -332,6 +340,10 @@ export namespace cloudfunctions_v2beta { * Describes the Build step of the function that builds a container from the given source. */ buildConfig?: Schema$BuildConfig; + /** + * Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions. + */ + createTime?: string | null; /** * User-provided description of a function. */ @@ -376,6 +388,10 @@ export namespace cloudfunctions_v2beta { * Output only. The last update timestamp of a Cloud Function. */ updateTime?: string | null; + /** + * Output only. UpgradeInfo for this Cloud Function + */ + upgradeInfo?: Schema$UpgradeInfo; /** * Output only. The deployed url for the function. */ @@ -901,6 +917,10 @@ export namespace cloudfunctions_v2beta { */ version?: number | null; } + /** + * Request for the `RedirectFunctionUpgradeTraffic` method. + */ + export interface Schema$RedirectFunctionUpgradeTrafficRequest {} /** * Location of the source in a Google Cloud Source Repository. */ @@ -930,6 +950,10 @@ export namespace cloudfunctions_v2beta { */ tagName?: string | null; } + /** + * Request for the `RollbackFunctionUpgradeTraffic` method. + */ + export interface Schema$RollbackFunctionUpgradeTrafficRequest {} /** * Describes a runtime and any special information (e.g., deprecation status) related to it. */ @@ -1108,6 +1132,10 @@ export namespace cloudfunctions_v2beta { */ updateMask?: string | null; } + /** + * Request for the `SetupFunctionUpgradeConfig` method. + */ + export interface Schema$SetupFunctionUpgradeConfigRequest {} /** * The location of the function source code. */ @@ -1194,6 +1222,27 @@ export namespace cloudfunctions_v2beta { */ permissions?: string[] | null; } + /** + * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration * Current state of migration for function undergoing migration. + */ + export interface Schema$UpgradeInfo { + /** + * Describes the Build step of the function that builds a container to prepare for 2nd gen upgrade. + */ + buildConfig?: Schema$BuildConfig; + /** + * Describes the Event trigger which has been setup to prepare for 2nd gen upgrade. + */ + eventTrigger?: Schema$EventTrigger; + /** + * Describes the Cloud Run service which has been setup to prepare for 2nd gen upgrade. + */ + serviceConfig?: Schema$ServiceConfig; + /** + * UpgradeState of the function + */ + upgradeState?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -1338,6 +1387,188 @@ export namespace cloudfunctions_v2beta { this.context = context; } + /** + * Aborts generation upgrade process for a function with the given name from the specified project. Deletes all 2nd Gen copy related configuration and resources which were created during the upgrade process. + * + * @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. + */ + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: StreamMethodOptions + ): GaxiosPromise; + abortFunctionUpgrade( + params?: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options?: MethodOptions + ): GaxiosPromise; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade, + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + callback: BodyResponseCallback + ): void; + abortFunctionUpgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}:abortFunctionUpgrade').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); + } + } + + /** + * Finalizes the upgrade after which function upgrade can not be rolled back. This is the last step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Deletes all original 1st Gen related configuration and resources. + * + * @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. + */ + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: StreamMethodOptions + ): GaxiosPromise; + commitFunctionUpgrade( + params?: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options?: MethodOptions + ): GaxiosPromise; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + params: Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade, + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + callback: BodyResponseCallback + ): void; + commitFunctionUpgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}:commitFunctionUpgrade').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); + } + } + /** * Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error. * @@ -2054,6 +2285,186 @@ export namespace cloudfunctions_v2beta { } } + /** + * Changes the traffic target of a function from the original 1st Gen function to the 2nd Gen copy. This is the second step of the multi step process to upgrade 1st Gen functions to 2nd Gen. After this operation, all new traffic will be served by 2nd Gen copy. + * + * @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. + */ + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: StreamMethodOptions + ): GaxiosPromise; + redirectFunctionUpgradeTraffic( + params?: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options?: MethodOptions + ): GaxiosPromise; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic, + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + callback: BodyResponseCallback + ): void; + redirectFunctionUpgradeTraffic( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta/{+name}:redirectFunctionUpgradeTraffic' + ).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); + } + } + + /** + * Reverts the traffic target of a function from the 2nd Gen copy to the original 1st Gen function. After this operation, all new traffic would be served by the 1st Gen. + * + * @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. + */ + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: StreamMethodOptions + ): GaxiosPromise; + rollbackFunctionUpgradeTraffic( + params?: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options?: MethodOptions + ): GaxiosPromise; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + params: Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic, + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + callback: BodyResponseCallback + ): void; + rollbackFunctionUpgradeTraffic( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta/{+name}:rollbackFunctionUpgradeTraffic' + ).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); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @@ -2143,6 +2554,96 @@ export namespace cloudfunctions_v2beta { } } + /** + * Creates a 2nd Gen copy of the function configuration based on the 1st Gen function with the given name. This is the first step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Only 2nd Gen configuration is setup as part of this request and traffic continues to be served by 1st Gen. + * + * @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. + */ + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: StreamMethodOptions + ): GaxiosPromise; + setupFunctionUpgradeConfig( + params?: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options?: MethodOptions + ): GaxiosPromise; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + params: Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig, + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + callback: BodyResponseCallback + ): void; + setupFunctionUpgradeConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta/{+name}:setupFunctionUpgradeConfig' + ).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); + } + } + /** * 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. * @@ -2240,6 +2741,30 @@ export namespace cloudfunctions_v2beta { } } + export interface Params$Resource$Projects$Locations$Functions$Abortfunctionupgrade + extends StandardParameters { + /** + * Required. The name of the function for which upgrade should be aborted. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AbortFunctionUpgradeRequest; + } + export interface Params$Resource$Projects$Locations$Functions$Commitfunctionupgrade + extends StandardParameters { + /** + * Required. The name of the function for which upgrade should be finalized. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CommitFunctionUpgradeRequest; + } export interface Params$Resource$Projects$Locations$Functions$Create extends StandardParameters { /** @@ -2344,6 +2869,30 @@ export namespace cloudfunctions_v2beta { */ requestBody?: Schema$Function; } + export interface Params$Resource$Projects$Locations$Functions$Redirectfunctionupgradetraffic + extends StandardParameters { + /** + * Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RedirectFunctionUpgradeTrafficRequest; + } + export interface Params$Resource$Projects$Locations$Functions$Rollbackfunctionupgradetraffic + extends StandardParameters { + /** + * Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RollbackFunctionUpgradeTrafficRequest; + } export interface Params$Resource$Projects$Locations$Functions$Setiampolicy extends StandardParameters { /** @@ -2356,6 +2905,18 @@ export namespace cloudfunctions_v2beta { */ requestBody?: Schema$SetIamPolicyRequest; } + export interface Params$Resource$Projects$Locations$Functions$Setupfunctionupgradeconfig + extends StandardParameters { + /** + * Required. The name of the function which should have configuration copied for upgrade. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetupFunctionUpgradeConfigRequest; + } export interface Params$Resource$Projects$Locations$Functions$Testiampermissions extends StandardParameters { /** From c4fa36e26fbcad40c777b67e4daacc5181edda8e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:15 +0000 Subject: [PATCH 08/43] fix(cloudscheduler): update the API #### cloudscheduler:v1beta1 The following keys were changed: - schemas.PubsubMessage.properties.messageId.description - schemas.PubsubMessage.properties.publishTime.description #### cloudscheduler:v1 The following keys were changed: - schemas.PubsubMessage.properties.messageId.description - schemas.PubsubMessage.properties.publishTime.description --- discovery/cloudscheduler-v1.json | 6 +++--- discovery/cloudscheduler-v1beta1.json | 6 +++--- src/apis/cloudscheduler/v1.ts | 4 ++-- src/apis/cloudscheduler/v1beta1.ts | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/discovery/cloudscheduler-v1.json b/discovery/cloudscheduler-v1.json index 95efeaeec0..e24416a741 100644 --- a/discovery/cloudscheduler-v1.json +++ b/discovery/cloudscheduler-v1.json @@ -418,7 +418,7 @@ } } }, - "revision": "20231208", + "revision": "20240126", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -765,7 +765,7 @@ "type": "string" }, "messageId": { - "description": "Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", + "description": "ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", "type": "string" }, "orderingKey": { @@ -773,7 +773,7 @@ "type": "string" }, "publishTime": { - "description": "Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", + "description": "The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", "format": "google-datetime", "type": "string" } diff --git a/discovery/cloudscheduler-v1beta1.json b/discovery/cloudscheduler-v1beta1.json index bbaaee3084..48f216b9d0 100644 --- a/discovery/cloudscheduler-v1beta1.json +++ b/discovery/cloudscheduler-v1beta1.json @@ -433,7 +433,7 @@ } } }, - "revision": "20231208", + "revision": "20240126", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -784,7 +784,7 @@ "type": "string" }, "messageId": { - "description": "Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", + "description": "ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", "type": "string" }, "orderingKey": { @@ -792,7 +792,7 @@ "type": "string" }, "publishTime": { - "description": "Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", + "description": "The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", "format": "google-datetime", "type": "string" } diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index b58db90d7e..38680207ee 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -358,7 +358,7 @@ export namespace cloudscheduler_v1 { */ data?: string | null; /** - * Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. + * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ messageId?: string | null; /** @@ -366,7 +366,7 @@ export namespace cloudscheduler_v1 { */ orderingKey?: string | null; /** - * Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. + * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ publishTime?: string | null; } diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index a8fd2e0bc6..4f9f10c82b 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -362,7 +362,7 @@ export namespace cloudscheduler_v1beta1 { */ data?: string | null; /** - * Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. + * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ messageId?: string | null; /** @@ -370,7 +370,7 @@ export namespace cloudscheduler_v1beta1 { */ orderingKey?: string | null; /** - * Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. + * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ publishTime?: string | null; } From 3f485b86f574f731b8d7124e7b4fca7a87ecff49 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:15 +0000 Subject: [PATCH 09/43] feat(compute): update the API #### compute:alpha The following keys were added: - schemas.NetworkInterface.properties.igmpQuery.description - schemas.NetworkInterface.properties.igmpQuery.enum - schemas.NetworkInterface.properties.igmpQuery.enumDescriptions - schemas.NetworkInterface.properties.igmpQuery.type - schemas.Snapshot.properties.resourceStatus.$ref - schemas.Snapshot.properties.resourceStatus.description - schemas.SnapshotResourceStatus.id - schemas.SnapshotResourceStatus.properties.scheduledDeletionTime.description - schemas.SnapshotResourceStatus.properties.scheduledDeletionTime.format - schemas.SnapshotResourceStatus.properties.scheduledDeletionTime.type - schemas.SnapshotResourceStatus.type The following keys were changed: - schemas.NetworkEndpointGroup.properties.appEngine.description - schemas.NetworkEndpointGroup.properties.clientPortMappingMode.description - schemas.NetworkEndpointGroup.properties.cloudFunction.description - schemas.NetworkEndpointGroup.properties.cloudRun.description - schemas.NetworkEndpointGroup.properties.defaultPort.description - schemas.NetworkEndpointGroup.properties.network.description - schemas.NetworkEndpointGroup.properties.pscTargetService.description - schemas.NetworkEndpointGroup.properties.serverlessDeployment.description - schemas.NetworkEndpointGroupAppEngine.properties.service.description - schemas.NetworkEndpointGroupAppEngine.properties.urlMask.description - schemas.NetworkEndpointGroupAppEngine.properties.version.description - schemas.NetworkEndpointGroupCloudFunction.properties.function.description - schemas.NetworkEndpointGroupCloudFunction.properties.urlMask.description - schemas.NetworkEndpointGroupCloudRun.properties.urlMask.description - schemas.NetworkEndpointGroupLbNetworkEndpointGroup.properties.defaultPort.description - schemas.NetworkEndpointGroupLbNetworkEndpointGroup.properties.network.description - schemas.NetworkEndpointGroupServerlessDeployment.properties.urlMask.description #### compute:beta The following keys were added: - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.futureReservations.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.instantSnapshots.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.nodeGroups.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.nodeTemplates.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.nodeTypes.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.packetMirrorings.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.publicDelegatedPrefixes.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.regionCommitments.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.reservations.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.resourcePolicies.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.routers.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.securityPolicies.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.serviceAttachments.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.sslCertificates.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.sslPolicies.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.subnetworks.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.targetHttpProxies.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.targetHttpsProxies.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.targetInstances.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.targetPools.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.targetTcpProxies.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.targetVpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.urlMaps.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.vpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.vpnTunnels.methods.aggregatedList.parameters.serviceProjectNumber.description - schemas.InstanceGroupManagerResizeRequestStatus.properties.lastAttempt.$ref - schemas.InstanceGroupManagerResizeRequestStatus.properties.lastAttempt.description - 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 The following keys were changed: - schemas.Binding.properties.role.description - schemas.Commitment.properties.type.enum - schemas.Commitment.properties.type.enumDescriptions - schemas.InstanceGroupManagerResizeRequestStatus.properties.error.description - schemas.NetworkEndpoint.properties.instance.description - schemas.NetworkEndpoint.properties.ipAddress.description - schemas.NetworkEndpoint.properties.port.description - schemas.Quota.properties.metric.enum - schemas.Quota.properties.metric.enumDescriptions - schemas.Reservation.properties.deleteAfterDuration.description - schemas.Reservation.properties.deleteAtTime.description --- discovery/compute-alpha.json | 63 ++++++++++++------ discovery/compute-beta.json | 121 +++++++++++++++++++++++++++++++--- src/apis/compute/alpha.ts | 48 +++++++++----- src/apis/compute/beta.ts | 122 +++++++++++++++++++++-------------- 4 files changed, 261 insertions(+), 93 deletions(-) diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index 4d242d825e..3849ba93ed 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -43863,7 +43863,7 @@ } } }, - "revision": "20240129", + "revision": "20240130", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -68587,10 +68587,10 @@ }, "appEngine": { "$ref": "NetworkEndpointGroupAppEngine", - "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set." + "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, "clientPortMappingMode": { - "description": "Only valid when networkEndpointType is \"GCE_VM_IP_PORT\" and the NEG is regional.", + "description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", "enum": [ "CLIENT_PORT_PER_ENDPOINT", "PORT_MAPPING_DISABLED" @@ -68603,18 +68603,18 @@ }, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", - "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set." + "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, "cloudRun": { "$ref": "NetworkEndpointGroupCloudRun", - "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set." + "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "defaultPort": { - "description": "The default port used if the port number is not specified in the network endpoint.", + "description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.", "format": "int32", "type": "integer" }, @@ -68642,7 +68642,7 @@ "type": "string" }, "network": { - "description": "The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified.", + "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.", "type": "string" }, "networkEndpointType": { @@ -68671,7 +68671,7 @@ "$ref": "NetworkEndpointGroupPscData" }, "pscTargetService": { - "description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: \"asia-northeast3-cloudkms.googleapis.com\"", + "description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com", "type": "string" }, "region": { @@ -68688,7 +68688,7 @@ }, "serverlessDeployment": { "$ref": "NetworkEndpointGroupServerlessDeployment", - "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set." + "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set." }, "size": { "description": "[Output only] Number of network endpoints in the network endpoint group.", @@ -68880,15 +68880,15 @@ "id": "NetworkEndpointGroupAppEngine", "properties": { "service": { - "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: \"default\", \"my-service\".", + "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.", "type": "string" }, "urlMask": { - "description": "A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs \"foo1-dot-appname.appspot.com/v1\" and \"foo1-dot-appname.appspot.com/v2\" can be backed by the same Serverless NEG with URL mask \"-dot-appname.appspot.com/\". The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask -dot-appname.appspot.com/. The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", "type": "string" }, "version": { - "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: \"v1\", \"v2\".", + "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.", "type": "string" } }, @@ -68899,11 +68899,11 @@ "id": "NetworkEndpointGroupCloudFunction", "properties": { "function": { - "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: \"func1\".", + "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.", "type": "string" }, "urlMask": { - "description": "A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs \" mydomain.com/function1\" and \"mydomain.com/function2\" can be backed by the same Serverless NEG with URL mask \"/\". The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /. The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", "type": "string" } }, @@ -68922,7 +68922,7 @@ "type": "string" }, "urlMask": { - "description": "A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs \"foo1.domain.com/bar1\" and \"foo1.domain.com/bar2\" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask \".domain.com/\". The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask .domain.com/. The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", "type": "string" } }, @@ -68934,13 +68934,13 @@ "properties": { "defaultPort": { "deprecated": true, - "description": "The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.", + "description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. [Deprecated] This field is deprecated.", "format": "int32", "type": "integer" }, "network": { "deprecated": true, - "description": "The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified. [Deprecated] This field is deprecated.", + "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. [Deprecated] This field is deprecated.", "type": "string" }, "subnetwork": { @@ -69156,7 +69156,7 @@ "type": "string" }, "urlMask": { - "description": "A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag ", + "description": "An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag ", "type": "string" }, "version": { @@ -69547,6 +69547,18 @@ "format": "byte", "type": "string" }, + "igmpQuery": { + "description": "Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.", + "enum": [ + "IGMP_QUERY_DISABLED", + "IGMP_QUERY_V2" + ], + "enumDescriptions": [ + "The network interface has disabled IGMP query.", + "The network interface has enabled IGMP query - v2." + ], + "type": "string" + }, "internalIpv6PrefixLength": { "description": "The prefix length of the primary internal IPv6 range.", "format": "int32", @@ -86137,6 +86149,10 @@ "description": "[Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.", "type": "string" }, + "resourceStatus": { + "$ref": "SnapshotResourceStatus", + "description": "[Output only] ResourceStatus of the Snapshot resource" + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -86572,6 +86588,17 @@ }, "type": "object" }, + "SnapshotResourceStatus": { + "id": "SnapshotResourceStatus", + "properties": { + "scheduledDeletionTime": { + "description": "[Output only] Scheduled deletion time of the snapshot. The snapshot will be deleted by the at any point within one hour after the deletion time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "SnapshotSettings": { "id": "SnapshotSettings", "properties": { diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 5acece3100..dc81ba80eb 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -175,6 +175,7 @@ "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" @@ -350,6 +351,7 @@ "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" @@ -760,6 +762,7 @@ "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" @@ -1701,6 +1704,7 @@ "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" @@ -2352,6 +2356,7 @@ "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" @@ -2577,6 +2582,7 @@ "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" @@ -4575,6 +4581,7 @@ "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" @@ -5035,6 +5042,7 @@ "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" @@ -6316,6 +6324,7 @@ "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" @@ -6864,6 +6873,7 @@ "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" @@ -8611,6 +8621,7 @@ "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" @@ -10030,6 +10041,7 @@ "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" @@ -10588,6 +10600,7 @@ "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" @@ -11043,6 +11056,7 @@ "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" @@ -13578,6 +13592,7 @@ "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" @@ -14032,6 +14047,7 @@ "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" @@ -15640,6 +15656,7 @@ "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" @@ -15815,6 +15832,7 @@ "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" @@ -16269,6 +16287,7 @@ "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" @@ -16536,6 +16555,7 @@ "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" @@ -18279,6 +18299,7 @@ "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" @@ -19012,6 +19033,7 @@ "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" @@ -19416,6 +19438,7 @@ "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" @@ -20111,6 +20134,7 @@ "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" @@ -21262,6 +21286,7 @@ "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" @@ -22602,6 +22627,7 @@ "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" @@ -31078,6 +31104,7 @@ "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" @@ -31593,6 +31620,7 @@ "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" @@ -32053,6 +32081,7 @@ "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" @@ -32922,6 +32951,7 @@ "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" @@ -33472,6 +33502,7 @@ "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" @@ -34315,6 +34346,7 @@ "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" @@ -34585,6 +34617,7 @@ "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" @@ -34949,6 +34982,7 @@ "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" @@ -35816,6 +35850,7 @@ "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" @@ -36170,6 +36205,7 @@ "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" @@ -36689,6 +36725,7 @@ "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" @@ -37148,6 +37185,7 @@ "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" @@ -38122,6 +38160,7 @@ "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" @@ -38476,6 +38515,7 @@ "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" @@ -38836,6 +38876,7 @@ "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" @@ -39269,6 +39310,7 @@ "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" @@ -39672,6 +39714,7 @@ "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" @@ -40267,7 +40310,7 @@ } } }, - "revision": "20240109", + "revision": "20240129", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -44824,7 +44867,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`.", + "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" } }, @@ -45200,6 +45243,7 @@ "GRAPHICS_OPTIMIZED", "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", + "STORAGE_OPTIMIZED_Z3", "TYPE_UNSPECIFIED" ], "enumDescriptions": [ @@ -45218,6 +45262,7 @@ "", "", "", + "", "" ], "type": "string" @@ -54623,7 +54668,65 @@ "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. As a contrary to the last_attempt errors, this field is final and errors are never removed from here, as the RR is not going to retry.", + "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.", @@ -63090,11 +63193,11 @@ "type": "string" }, "instance": { - "description": "The name or a URL of a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.", + "description": "The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.", "type": "string" }, "ipAddress": { - "description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.", + "description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.", "type": "string" }, "ipv6Address": { @@ -63102,7 +63205,7 @@ "type": "string" }, "port": { - "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.", + "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.", "format": "int32", "type": "integer" } @@ -69662,6 +69765,7 @@ "COMMITTED_NVIDIA_V100_GPUS", "COMMITTED_T2A_CPUS", "COMMITTED_T2D_CPUS", + "COMMITTED_Z3_CPUS", "CPUS", "CPUS_ALL_REGIONS", "DISKS_TOTAL_GB", @@ -69822,6 +69926,7 @@ "", "", "", + "", "Guest CPUs", "", "", @@ -71733,10 +71838,10 @@ }, "deleteAfterDuration": { "$ref": "Duration", - "description": "Duration time relative to reservation creation when GCE will automatically delete this resource." + "description": "Duration time relative to reservation creation when Compute Engine will automatically delete this resource." }, "deleteAtTime": { - "description": "Absolute time in future when the reservation will be auto-deleted by GCE. Timestamp is represented in RFC3339 text format.", + "description": "Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.", "type": "string" }, "description": { diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 4c08bf585d..694780944e 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -10666,19 +10666,19 @@ export namespace compute_alpha { */ annotations?: {[key: string]: string} | null; /** - * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. + * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ appEngine?: Schema$NetworkEndpointGroupAppEngine; /** - * Only valid when networkEndpointType is "GCE_VM_IP_PORT" and the NEG is regional. + * Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. */ clientPortMappingMode?: string | null; /** - * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. + * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ cloudFunction?: Schema$NetworkEndpointGroupCloudFunction; /** - * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. + * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ cloudRun?: Schema$NetworkEndpointGroupCloudRun; /** @@ -10686,7 +10686,7 @@ export namespace compute_alpha { */ creationTimestamp?: string | null; /** - * The default port used if the port number is not specified in the network endpoint. + * The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. */ defaultPort?: number | null; /** @@ -10710,7 +10710,7 @@ export namespace compute_alpha { */ name?: string | null; /** - * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. + * The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. */ network?: string | null; /** @@ -10719,7 +10719,7 @@ export namespace compute_alpha { networkEndpointType?: string | null; pscData?: Schema$NetworkEndpointGroupPscData; /** - * The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" + * The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com */ pscTargetService?: string | null; /** @@ -10735,7 +10735,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string | null; /** - * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. + * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. */ serverlessDeployment?: Schema$NetworkEndpointGroupServerlessDeployment; /** @@ -10794,15 +10794,15 @@ export namespace compute_alpha { */ export interface Schema$NetworkEndpointGroupAppEngine { /** - * Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: "default", "my-service". + * Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. */ service?: string | null; /** - * A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". The URL mask will parse them to { service = "foo1", version = "v1" \} and { service = "foo1", version = "v2" \} respectively. + * An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask -dot-appname.appspot.com/. The URL mask will parse them to { service = "foo1", version = "v1" \} and { service = "foo1", version = "v2" \} respectively. */ urlMask?: string | null; /** - * Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: "v1", "v2". + * Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. */ version?: string | null; } @@ -10811,11 +10811,11 @@ export namespace compute_alpha { */ export interface Schema$NetworkEndpointGroupCloudFunction { /** - * A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: "func1". + * A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. */ function?: string | null; /** - * A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs " mydomain.com/function1" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" \} and { function = "function2" \} respectively. + * An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /. The URL mask will parse them to { function = "function1" \} and { function = "function2" \} respectively. */ urlMask?: string | null; } @@ -10832,7 +10832,7 @@ export namespace compute_alpha { */ tag?: string | null; /** - * A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" \} and { service="bar2", tag="foo2" \} respectively. + * An URL mask is one of the main components of the Cloud Function. A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask .domain.com/. The URL mask will parse them to { service="bar1", tag="foo1" \} and { service="bar2", tag="foo2" \} respectively. */ urlMask?: string | null; } @@ -10841,11 +10841,11 @@ export namespace compute_alpha { */ export interface Schema$NetworkEndpointGroupLbNetworkEndpointGroup { /** - * The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. + * The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. [Deprecated] This field is deprecated. */ defaultPort?: number | null; /** - * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated. + * The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. [Deprecated] This field is deprecated. */ network?: string | null; /** @@ -10929,7 +10929,7 @@ export namespace compute_alpha { */ resource?: string | null; /** - * A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag + * An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag */ urlMask?: string | null; /** @@ -11016,6 +11016,10 @@ export namespace compute_alpha { * Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. */ fingerprint?: string | null; + /** + * Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported. + */ + igmpQuery?: string | null; /** * The prefix length of the primary internal IPv6 range. */ @@ -17343,6 +17347,10 @@ export namespace compute_alpha { * [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots. */ region?: string | null; + /** + * [Output only] ResourceStatus of the Snapshot resource + */ + resourceStatus?: Schema$SnapshotResourceStatus; /** * Output only. Reserved for future use. */ @@ -17492,6 +17500,12 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$SnapshotResourceStatus { + /** + * [Output only] Scheduled deletion time of the snapshot. The snapshot will be deleted by the at any point within one hour after the deletion time. + */ + scheduledDeletionTime?: string | null; + } export interface Schema$SnapshotSettings { /** * (Regional snapshots use only)Policy of which location is allowed to access snapshot. diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 92437d9746..0fd14cec26 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -2274,7 +2274,7 @@ export namespace compute_beta { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -6567,7 +6567,29 @@ export namespace compute_beta { } 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. As a contrary to the last_attempt errors, this field is final and errors are never removed from here, as the RR is not going to retry. + * [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<{ @@ -9747,11 +9769,11 @@ export namespace compute_beta { */ fqdn?: string | null; /** - * The name or a URL of a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + * The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. */ instance?: string | null; /** - * Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. + * Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. */ ipAddress?: string | null; /** @@ -9759,7 +9781,7 @@ export namespace compute_beta { */ ipv6Address?: string | null; /** - * Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. + * Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. */ port?: number | null; } @@ -12726,11 +12748,11 @@ export namespace compute_beta { */ creationTimestamp?: string | null; /** - * Duration time relative to reservation creation when GCE will automatically delete this resource. + * Duration time relative to reservation creation when Compute Engine will automatically delete this resource. */ deleteAfterDuration?: Schema$Duration; /** - * Absolute time in future when the reservation will be auto-deleted by GCE. Timestamp is represented in RFC3339 text format. + * Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. */ deleteAtTime?: string | null; /** @@ -18888,7 +18910,7 @@ export namespace compute_beta { */ 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; } @@ -19681,7 +19703,7 @@ export namespace compute_beta { */ 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; } @@ -20580,7 +20602,7 @@ export namespace compute_beta { */ 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; } @@ -23498,7 +23520,7 @@ export namespace compute_beta { */ 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; } @@ -25398,7 +25420,7 @@ export namespace compute_beta { */ 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; } @@ -26061,7 +26083,7 @@ export namespace compute_beta { */ 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; } @@ -30189,7 +30211,7 @@ export namespace compute_beta { */ 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; } @@ -31039,7 +31061,7 @@ export namespace compute_beta { */ 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; } @@ -34037,7 +34059,7 @@ export namespace compute_beta { */ 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; } @@ -35704,7 +35726,7 @@ export namespace compute_beta { */ 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; } @@ -41776,7 +41798,7 @@ export namespace compute_beta { */ 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; } @@ -43370,7 +43392,7 @@ export namespace compute_beta { */ 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; } @@ -48160,7 +48182,7 @@ export namespace compute_beta { */ 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; } @@ -50234,7 +50256,7 @@ export namespace compute_beta { */ 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; } @@ -51195,7 +51217,7 @@ export namespace compute_beta { */ 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; } @@ -52131,7 +52153,7 @@ export namespace compute_beta { */ 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; } @@ -55712,7 +55734,7 @@ export namespace compute_beta { */ 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; } @@ -56607,7 +56629,7 @@ export namespace compute_beta { */ 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; } @@ -57270,7 +57292,7 @@ export namespace compute_beta { */ 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; } @@ -58228,7 +58250,7 @@ export namespace compute_beta { */ 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; } @@ -62826,7 +62848,7 @@ export namespace compute_beta { */ 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; } @@ -63879,7 +63901,7 @@ export namespace compute_beta { */ 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; } @@ -64331,7 +64353,7 @@ export namespace compute_beta { */ 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; } @@ -66605,7 +66627,7 @@ export namespace compute_beta { */ 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; } @@ -69693,7 +69715,7 @@ export namespace compute_beta { */ 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; } @@ -72631,7 +72653,7 @@ export namespace compute_beta { */ 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; } @@ -91924,7 +91946,7 @@ export namespace compute_beta { */ 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; } @@ -92968,7 +92990,7 @@ export namespace compute_beta { */ 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; } @@ -94259,7 +94281,7 @@ export namespace compute_beta { */ 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; } @@ -96247,7 +96269,7 @@ export namespace compute_beta { */ 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; } @@ -97311,7 +97333,7 @@ export namespace compute_beta { */ 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; } @@ -99105,7 +99127,7 @@ export namespace compute_beta { */ 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; } @@ -99948,7 +99970,7 @@ export namespace compute_beta { */ 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; } @@ -101188,7 +101210,7 @@ export namespace compute_beta { */ 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; } @@ -102840,7 +102862,7 @@ export namespace compute_beta { */ 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; } @@ -104073,7 +104095,7 @@ export namespace compute_beta { */ 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; } @@ -104949,7 +104971,7 @@ export namespace compute_beta { */ 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; } @@ -106319,7 +106341,7 @@ export namespace compute_beta { */ 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; } @@ -108373,7 +108395,7 @@ export namespace compute_beta { */ 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; } @@ -109171,7 +109193,7 @@ export namespace compute_beta { */ 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; } @@ -110224,7 +110246,7 @@ export namespace compute_beta { */ 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; } @@ -111138,7 +111160,7 @@ export namespace compute_beta { */ 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; } @@ -111943,7 +111965,7 @@ export namespace compute_beta { */ 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; } From 76b839c79f0f843129ad55ef96cfc726aee0f980 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:15 +0000 Subject: [PATCH 10/43] fix(dataform): update the API #### dataform:v1beta1 The following keys were changed: - schemas.CompilationResult.properties.releaseConfig.description - schemas.ReleaseConfig.properties.releaseCompilationResult.description --- discovery/dataform-v1beta1.json | 6 +++--- src/apis/dataform/v1beta1.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index 3fd1117e09..b6b8a36b39 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -2103,7 +2103,7 @@ } } }, - "revision": "20240121", + "revision": "20240127", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { @@ -2406,7 +2406,7 @@ "type": "string" }, "releaseConfig": { - "description": "Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.", + "description": "Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.", "type": "string" }, "resolvedGitCommitSha": { @@ -3444,7 +3444,7 @@ "type": "array" }, "releaseCompilationResult": { - "description": "Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", + "description": "Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", "type": "string" }, "timeZone": { diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index bb4e88cb01..d59f9e1da6 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -364,7 +364,7 @@ export namespace dataform_v1beta1 { */ name?: string | null; /** - * Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/x/locations/x/repositories/x/releaseConfigs/x`. + * Immutable. The name of the release config to compile. Must be in the format `projects/x/locations/x/repositories/x/releaseConfigs/x`. */ releaseConfig?: string | null; /** @@ -1122,7 +1122,7 @@ export namespace dataform_v1beta1 { */ recentScheduledReleaseRecords?: Schema$ScheduledReleaseRecord[]; /** - * Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/x/locations/x/repositories/x/compilationResults/x`. + * Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/x/locations/x/repositories/x/compilationResults/x`. */ releaseCompilationResult?: string | null; /** From 347ceb97d0ead299c77d5c3969637b774130b524 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:15 +0000 Subject: [PATCH 11/43] fix(datamigration): update the API #### datamigration:v1beta1 The following keys were changed: - schemas.Binding.properties.role.description #### datamigration:v1 The following keys were changed: - schemas.Binding.properties.role.description --- discovery/datamigration-v1.json | 4 ++-- discovery/datamigration-v1beta1.json | 4 ++-- src/apis/datamigration/v1.ts | 2 +- src/apis/datamigration/v1beta1.ts | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index d14dffff07..38d5e7d22f 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -2125,7 +2125,7 @@ } } }, - "revision": "20240114", + "revision": "20240122", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2396,7 +2396,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`.", + "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" } }, diff --git a/discovery/datamigration-v1beta1.json b/discovery/datamigration-v1beta1.json index dca73939b5..de2942cde9 100644 --- a/discovery/datamigration-v1beta1.json +++ b/discovery/datamigration-v1beta1.json @@ -1049,7 +1049,7 @@ } } }, - "revision": "20231214", + "revision": "20240122", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { @@ -1116,7 +1116,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`.", + "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" } }, diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index 7f1562932a..95c1c652ef 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -303,7 +303,7 @@ export namespace datamigration_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } diff --git a/src/apis/datamigration/v1beta1.ts b/src/apis/datamigration/v1beta1.ts index e417030773..b036f5cbb5 100644 --- a/src/apis/datamigration/v1beta1.ts +++ b/src/apis/datamigration/v1beta1.ts @@ -163,7 +163,7 @@ export namespace datamigration_v1beta1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } From 0e53caa4e676d486ee3602e35ad32103d96fa413 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:16 +0000 Subject: [PATCH 12/43] fix(dataplex): update the API #### dataplex:v1 The following keys were changed: - schemas.GoogleIamV1Binding.properties.role.description --- discovery/dataplex-v1.json | 4 ++-- src/apis/dataplex/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 84ad0a9c7e..a7c09f9d10 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -4360,7 +4360,7 @@ } } }, - "revision": "20240115", + "revision": "20240124", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -9128,7 +9128,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.", + "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" } }, diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index a72933f36f..9527e4a9e8 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -3284,7 +3284,7 @@ export namespace dataplex_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. + * 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; } From f9436dd539e42a60c1557da134923cd8abacedc9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:16 +0000 Subject: [PATCH 13/43] feat(datastore)!: update the API BREAKING CHANGE: This release has breaking changes. #### datastore:v1beta3 The following keys were deleted: - schemas.QueryPlan.description - schemas.QueryPlan.id - schemas.QueryPlan.properties.planInfo.additionalProperties.description - schemas.QueryPlan.properties.planInfo.additionalProperties.type - schemas.QueryPlan.properties.planInfo.description - schemas.QueryPlan.properties.planInfo.type - schemas.QueryPlan.type - schemas.ResultSetStats.description - schemas.ResultSetStats.id - schemas.ResultSetStats.properties.queryPlan.$ref - schemas.ResultSetStats.properties.queryPlan.description - schemas.ResultSetStats.properties.queryStats.additionalProperties.description - schemas.ResultSetStats.properties.queryStats.additionalProperties.type - schemas.ResultSetStats.properties.queryStats.description - schemas.ResultSetStats.properties.queryStats.type - schemas.ResultSetStats.type - schemas.RunAggregationQueryRequest.properties.mode.description - schemas.RunAggregationQueryRequest.properties.mode.enum - schemas.RunAggregationQueryRequest.properties.mode.enumDescriptions - schemas.RunAggregationQueryRequest.properties.mode.type - schemas.RunAggregationQueryResponse.properties.stats.$ref - schemas.RunAggregationQueryResponse.properties.stats.description - schemas.RunQueryRequest.properties.mode.description - schemas.RunQueryRequest.properties.mode.enum - schemas.RunQueryRequest.properties.mode.enumDescriptions - schemas.RunQueryRequest.properties.mode.type - schemas.RunQueryResponse.properties.stats.$ref - schemas.RunQueryResponse.properties.stats.description #### datastore:v1 The following keys were deleted: - schemas.QueryPlan.description - schemas.QueryPlan.id - schemas.QueryPlan.properties.planInfo.additionalProperties.description - schemas.QueryPlan.properties.planInfo.additionalProperties.type - schemas.QueryPlan.properties.planInfo.description - schemas.QueryPlan.properties.planInfo.type - schemas.QueryPlan.type - schemas.ResultSetStats.description - schemas.ResultSetStats.id - schemas.ResultSetStats.properties.queryPlan.$ref - schemas.ResultSetStats.properties.queryPlan.description - schemas.ResultSetStats.properties.queryStats.additionalProperties.description - schemas.ResultSetStats.properties.queryStats.additionalProperties.type - schemas.ResultSetStats.properties.queryStats.description - schemas.ResultSetStats.properties.queryStats.type - schemas.ResultSetStats.type - schemas.RunAggregationQueryRequest.properties.mode.description - schemas.RunAggregationQueryRequest.properties.mode.enum - schemas.RunAggregationQueryRequest.properties.mode.enumDescriptions - schemas.RunAggregationQueryRequest.properties.mode.type - schemas.RunAggregationQueryResponse.properties.stats.$ref - schemas.RunAggregationQueryResponse.properties.stats.description - schemas.RunQueryRequest.properties.mode.description - schemas.RunQueryRequest.properties.mode.enum - schemas.RunQueryRequest.properties.mode.enumDescriptions - schemas.RunQueryRequest.properties.mode.type - schemas.RunQueryResponse.properties.stats.$ref - schemas.RunQueryResponse.properties.stats.description --- discovery/datastore-v1.json | 72 +------------------------------- discovery/datastore-v1beta3.json | 72 +------------------------------- src/apis/datastore/v1.ts | 38 ----------------- src/apis/datastore/v1beta3.ts | 38 ----------------- 4 files changed, 2 insertions(+), 218 deletions(-) diff --git a/discovery/datastore-v1.json b/discovery/datastore-v1.json index 4f96744fcb..1e133c16d2 100644 --- a/discovery/datastore-v1.json +++ b/discovery/datastore-v1.json @@ -654,7 +654,7 @@ } } }, - "revision": "20240117", + "revision": "20240131", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -2119,21 +2119,6 @@ }, "type": "object" }, - "QueryPlan": { - "description": "Plan for the query.", - "id": "QueryPlan", - "properties": { - "planInfo": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Planning phase information for the query. It will include: { \"indexes_used\": [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ] }", - "type": "object" - } - }, - "type": "object" - }, "QueryResultBatch": { "description": "A batch of results produced by a query.", "id": "QueryResultBatch", @@ -2290,25 +2275,6 @@ "properties": {}, "type": "object" }, - "ResultSetStats": { - "description": "Planning and execution statistics for the query.", - "id": "ResultSetStats", - "properties": { - "queryPlan": { - "$ref": "QueryPlan", - "description": "Plan for the query." - }, - "queryStats": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { \"results_returned\": \"20\", \"documents_scanned\": \"20\", \"indexes_entries_scanned\": \"10050\", \"total_execution_time\": \"100.7 msecs\" }", - "type": "object" - } - }, - "type": "object" - }, "RollbackRequest": { "description": "The request for Datastore.Rollback.", "id": "RollbackRequest", @@ -2347,20 +2313,6 @@ "$ref": "GqlQuery", "description": "The GQL query to run. This query must be an aggregation query." }, - "mode": { - "description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.", - "enum": [ - "NORMAL", - "PLAN", - "PROFILE" - ], - "enumDescriptions": [ - "The default mode. Only the query results are returned.", - "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." - ], - "type": "string" - }, "partitionId": { "$ref": "PartitionId", "description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID." @@ -2384,10 +2336,6 @@ "$ref": "AggregationQuery", "description": "The parsed form of the `GqlQuery` from the request, if it was set." }, - "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`." - }, "transaction": { "description": "The identifier of the transaction that was started as part of this RunAggregationQuery request. Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.", "format": "byte", @@ -2408,20 +2356,6 @@ "$ref": "GqlQuery", "description": "The GQL query to run. This query must be a non-aggregation query." }, - "mode": { - "description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.", - "enum": [ - "NORMAL", - "PLAN", - "PROFILE" - ], - "enumDescriptions": [ - "The default mode. Only the query results are returned.", - "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." - ], - "type": "string" - }, "partitionId": { "$ref": "PartitionId", "description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID." @@ -2449,10 +2383,6 @@ "$ref": "Query", "description": "The parsed form of the `GqlQuery` from the request, if it was set." }, - "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`." - }, "transaction": { "description": "The identifier of the transaction that was started as part of this RunQuery request. Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options.", "format": "byte", diff --git a/discovery/datastore-v1beta3.json b/discovery/datastore-v1beta3.json index 544dc71a95..bfb6da8dae 100644 --- a/discovery/datastore-v1beta3.json +++ b/discovery/datastore-v1beta3.json @@ -336,7 +336,7 @@ } } }, - "revision": "20240117", + "revision": "20240131", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -1565,21 +1565,6 @@ }, "type": "object" }, - "QueryPlan": { - "description": "Plan for the query.", - "id": "QueryPlan", - "properties": { - "planInfo": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Planning phase information for the query. It will include: { \"indexes_used\": [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ] }", - "type": "object" - } - }, - "type": "object" - }, "QueryResultBatch": { "description": "A batch of results produced by a query.", "id": "QueryResultBatch", @@ -1732,25 +1717,6 @@ "properties": {}, "type": "object" }, - "ResultSetStats": { - "description": "Planning and execution statistics for the query.", - "id": "ResultSetStats", - "properties": { - "queryPlan": { - "$ref": "QueryPlan", - "description": "Plan for the query." - }, - "queryStats": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { \"results_returned\": \"20\", \"documents_scanned\": \"20\", \"indexes_entries_scanned\": \"10050\", \"total_execution_time\": \"100.7 msecs\" }", - "type": "object" - } - }, - "type": "object" - }, "RollbackRequest": { "description": "The request for Datastore.Rollback.", "id": "RollbackRequest", @@ -1781,20 +1747,6 @@ "$ref": "GqlQuery", "description": "The GQL query to run. This query must be an aggregation query." }, - "mode": { - "description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.", - "enum": [ - "NORMAL", - "PLAN", - "PROFILE" - ], - "enumDescriptions": [ - "The default mode. Only the query results are returned.", - "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." - ], - "type": "string" - }, "partitionId": { "$ref": "PartitionId", "description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID." @@ -1817,10 +1769,6 @@ "query": { "$ref": "AggregationQuery", "description": "The parsed form of the `GqlQuery` from the request, if it was set." - }, - "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`." } }, "type": "object" @@ -1833,20 +1781,6 @@ "$ref": "GqlQuery", "description": "The GQL query to run. This query must be a non-aggregation query." }, - "mode": { - "description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.", - "enum": [ - "NORMAL", - "PLAN", - "PROFILE" - ], - "enumDescriptions": [ - "The default mode. Only the query results are returned.", - "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." - ], - "type": "string" - }, "partitionId": { "$ref": "PartitionId", "description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID." @@ -1873,10 +1807,6 @@ "query": { "$ref": "Query", "description": "The parsed form of the `GqlQuery` from the request, if it was set." - }, - "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`." } }, "type": "object" diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index 8bed83106a..f6ef2f4d09 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -1074,15 +1074,6 @@ export namespace datastore_v1 { */ startCursor?: string | null; } - /** - * Plan for the query. - */ - export interface Schema$QueryPlan { - /** - * Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ] \} - */ - planInfo?: {[key: string]: any} | null; - } /** * A batch of results produced by a query. */ @@ -1176,19 +1167,6 @@ export namespace datastore_v1 { * The response for Datastore.ReserveIds. */ export interface Schema$ReserveIdsResponse {} - /** - * Planning and execution statistics for the query. - */ - export interface Schema$ResultSetStats { - /** - * Plan for the query. - */ - queryPlan?: Schema$QueryPlan; - /** - * Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" \} - */ - queryStats?: {[key: string]: any} | null; - } /** * The request for Datastore.Rollback. */ @@ -1222,10 +1200,6 @@ export namespace datastore_v1 { * The GQL query to run. This query must be an aggregation query. */ gqlQuery?: Schema$GqlQuery; - /** - * Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. - */ - mode?: string | null; /** * Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */ @@ -1247,10 +1221,6 @@ export namespace datastore_v1 { * The parsed form of the `GqlQuery` from the request, if it was set. */ query?: Schema$AggregationQuery; - /** - * Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`. - */ - stats?: Schema$ResultSetStats; /** * The identifier of the transaction that was started as part of this RunAggregationQuery request. Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options. */ @@ -1268,10 +1238,6 @@ export namespace datastore_v1 { * The GQL query to run. This query must be a non-aggregation query. */ gqlQuery?: Schema$GqlQuery; - /** - * Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. - */ - mode?: string | null; /** * Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */ @@ -1297,10 +1263,6 @@ export namespace datastore_v1 { * The parsed form of the `GqlQuery` from the request, if it was set. */ query?: Schema$Query; - /** - * Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`. - */ - stats?: Schema$ResultSetStats; /** * The identifier of the transaction that was started as part of this RunQuery request. Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options. */ diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index c2aac1da0f..5d17bf3e5a 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -915,15 +915,6 @@ export namespace datastore_v1beta3 { */ startCursor?: string | null; } - /** - * Plan for the query. - */ - export interface Schema$QueryPlan { - /** - * Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ] \} - */ - planInfo?: {[key: string]: any} | null; - } /** * A batch of results produced by a query. */ @@ -1013,19 +1004,6 @@ export namespace datastore_v1beta3 { * The response for Datastore.ReserveIds. */ export interface Schema$ReserveIdsResponse {} - /** - * Planning and execution statistics for the query. - */ - export interface Schema$ResultSetStats { - /** - * Plan for the query. - */ - queryPlan?: Schema$QueryPlan; - /** - * Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" \} - */ - queryStats?: {[key: string]: any} | null; - } /** * The request for Datastore.Rollback. */ @@ -1051,10 +1029,6 @@ export namespace datastore_v1beta3 { * The GQL query to run. This query must be an aggregation query. */ gqlQuery?: Schema$GqlQuery; - /** - * Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. - */ - mode?: string | null; /** * Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */ @@ -1076,10 +1050,6 @@ export namespace datastore_v1beta3 { * The parsed form of the `GqlQuery` from the request, if it was set. */ query?: Schema$AggregationQuery; - /** - * Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`. - */ - stats?: Schema$ResultSetStats; } /** * The request for Datastore.RunQuery. @@ -1089,10 +1059,6 @@ export namespace datastore_v1beta3 { * The GQL query to run. This query must be a non-aggregation query. */ gqlQuery?: Schema$GqlQuery; - /** - * Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. - */ - mode?: string | null; /** * Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */ @@ -1118,10 +1084,6 @@ export namespace datastore_v1beta3 { * The parsed form of the `GqlQuery` from the request, if it was set. */ query?: Schema$Query; - /** - * Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`. - */ - stats?: Schema$ResultSetStats; } /** * Sum of the values of the requested property. * Only numeric values will be aggregated. All non-numeric values including `NULL` are skipped. * If the aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754 standards. * If the aggregated value set is empty, returns 0. * Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision. * When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers. From 5c206202600a0ac3d72cd6198d0c366352d85f0f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:16 +0000 Subject: [PATCH 14/43] feat(dfareporting): update the API #### dfareporting:v4 The following keys were added: - schemas.Conversion.properties.adUserDataConsent.description - schemas.Conversion.properties.adUserDataConsent.enum - schemas.Conversion.properties.adUserDataConsent.enumDescriptions - schemas.Conversion.properties.adUserDataConsent.type - schemas.Placement.properties.conversionDomainOverride.$ref - schemas.Placement.properties.conversionDomainOverride.description - schemas.PlacementConversionDomainOverride.id - schemas.PlacementConversionDomainOverride.properties.conversionDomains.items.$ref - schemas.PlacementConversionDomainOverride.properties.conversionDomains.type - schemas.PlacementConversionDomainOverride.type - schemas.PlacementSingleConversionDomain.id - schemas.PlacementSingleConversionDomain.properties.conversionDomainId.format - schemas.PlacementSingleConversionDomain.properties.conversionDomainId.type - schemas.PlacementSingleConversionDomain.properties.conversionDomainValue.type - schemas.PlacementSingleConversionDomain.type The following keys were changed: - schemas.TagSetting.properties.includeClickThroughUrls.description - schemas.UniversalAdId.properties.registry.enum - schemas.UniversalAdId.properties.registry.enumDescriptions --- discovery/dfareporting-v4.json | 49 +++++++++++++++++++++++++++++++--- src/apis/dfareporting/v4.ts | 17 +++++++++++- 2 files changed, 62 insertions(+), 4 deletions(-) diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json index 4d280d9947..3d15676433 100644 --- a/discovery/dfareporting-v4.json +++ b/discovery/dfareporting-v4.json @@ -10067,7 +10067,7 @@ } } }, - "revision": "20230918", + "revision": "20240201", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -12094,6 +12094,18 @@ "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.", "id": "Conversion", "properties": { + "adUserDataConsent": { + "description": "This represents consent for ad user data.", + "enum": [ + "GRANTED", + "DENIED" + ], + "enumDescriptions": [ + "Granted.", + "Denied." + ], + "type": "string" + }, "childDirectedTreatment": { "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.", "type": "boolean" @@ -17861,6 +17873,10 @@ "format": "int64", "type": "string" }, + "conversionDomainOverride": { + "$ref": "PlacementConversionDomainOverride", + "description": "Optional. Conversion domain overrides for a placement." + }, "createInfo": { "$ref": "LastModifiedInfo", "description": "Information about the creation of this placement. This is a read-only field." @@ -18105,6 +18121,18 @@ }, "type": "object" }, + "PlacementConversionDomainOverride": { + "id": "PlacementConversionDomainOverride", + "properties": { + "conversionDomains": { + "items": { + "$ref": "PlacementSingleConversionDomain" + }, + "type": "array" + } + }, + "type": "object" + }, "PlacementGroup": { "description": "Contains properties of a package or roadblock.", "id": "PlacementGroup", @@ -18274,6 +18302,19 @@ }, "type": "object" }, + "PlacementSingleConversionDomain": { + "id": "PlacementSingleConversionDomain", + "properties": { + "conversionDomainId": { + "format": "int64", + "type": "string" + }, + "conversionDomainValue": { + "type": "string" + } + }, + "type": "object" + }, "PlacementStrategiesListResponse": { "description": "Placement Strategy List Response", "id": "PlacementStrategiesListResponse", @@ -20351,7 +20392,7 @@ "type": "string" }, "includeClickThroughUrls": { - "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements.", + "description": "Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.", "type": "boolean" }, "includeClickTracking": { @@ -20759,12 +20800,14 @@ "OTHER", "AD_ID_OFFICIAL", "CLEARCAST", - "DCM" + "DCM", + "ARPP" ], "enumDescriptions": [ "", "", "", + "", "" ], "type": "string" diff --git a/src/apis/dfareporting/v4.ts b/src/apis/dfareporting/v4.ts index 3f500d4e2a..c03eaa9e40 100644 --- a/src/apis/dfareporting/v4.ts +++ b/src/apis/dfareporting/v4.ts @@ -1739,6 +1739,10 @@ export namespace dfareporting_v4 { * A Conversion represents when a user successfully performs a desired action after seeing an ad. */ export interface Schema$Conversion { + /** + * This represents consent for ad user data. + */ + adUserDataConsent?: string | null; /** * Whether this particular request may come from a user under the age of 13, under COPPA compliance. */ @@ -4962,6 +4966,10 @@ export namespace dfareporting_v4 { * ID of the content category assigned to this placement. */ contentCategoryId?: string | null; + /** + * Optional. Conversion domain overrides for a placement. + */ + conversionDomainOverride?: Schema$PlacementConversionDomainOverride; /** * Information about the creation of this placement. This is a read-only field. */ @@ -5112,6 +5120,9 @@ export namespace dfareporting_v4 { */ sslRequired?: boolean | null; } + export interface Schema$PlacementConversionDomainOverride { + conversionDomains?: Schema$PlacementSingleConversionDomain[]; + } /** * Contains properties of a package or roadblock. */ @@ -5251,6 +5262,10 @@ export namespace dfareporting_v4 { */ placementTags?: Schema$PlacementTag[]; } + export interface Schema$PlacementSingleConversionDomain { + conversionDomainId?: string | null; + conversionDomainValue?: string | null; + } /** * Placement List Response */ @@ -6434,7 +6449,7 @@ export namespace dfareporting_v4 { */ additionalKeyValues?: string | null; /** - * Whether static landing page URLs should be included in the tags. This setting applies only to placements. + * Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. */ includeClickThroughUrls?: boolean | null; /** From 097d2ebd1d5e7ae59a892507be9ca786431ebebe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:16 +0000 Subject: [PATCH 15/43] feat(discoveryengine): update the API #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameterOrder - 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.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.type - 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.list.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameterOrder - 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.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.type - 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.list.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.scopes - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.id - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.path - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.scopes - schemas.GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec.properties.enableSearchAdaptor.description - schemas.GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec.properties.enableSearchAdaptor.type - schemas.GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaEmbeddingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaEmbeddingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaEmbeddingConfig.properties.fieldPath.description - schemas.GoogleCloudDiscoveryengineV1alphaEmbeddingConfig.properties.fieldPath.type - schemas.GoogleCloudDiscoveryengineV1alphaEmbeddingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.properties.enableRefinementAttributes.description - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.properties.enableRefinementAttributes.type - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.properties.enableRelatedQuestions.description - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.properties.enableRelatedQuestions.type - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.properties.maxRelatedQuestions.description - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.properties.maxRelatedQuestions.format - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.properties.maxRelatedQuestions.type - schemas.GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse.properties.servingConfigs.description - schemas.GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse.properties.servingConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse.properties.servingConfigs.type - schemas.GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.boostControlIds.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.boostControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.boostControlIds.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.createTime.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.customFineTuningSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.customFineTuningSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.dissociateControlIds.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.dissociateControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.dissociateControlIds.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.diversityLevel.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.diversityLevel.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.embeddingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.embeddingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.filterControlIds.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.filterControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.filterControlIds.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.genericConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.genericConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.guidedSearchSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.guidedSearchSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.ignoreControlIds.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.ignoreControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.ignoreControlIds.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.mediaConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.mediaConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.modelId.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.modelId.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.onewaySynonymsControlIds.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.onewaySynonymsControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.onewaySynonymsControlIds.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.rankingExpression.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.redirectControlIds.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.redirectControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.redirectControlIds.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.replacementControlIds.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.replacementControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.replacementControlIds.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.solutionType.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.solutionType.enum - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.solutionType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.solutionType.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.synonymsControlIds.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.synonymsControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.synonymsControlIds.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.updateTime.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig.properties.contentSearchSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig.properties.contentSearchSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentFreshnessCutoffDays.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentFreshnessCutoffDays.format - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentFreshnessCutoffDays.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.format - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedPercentageThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedPercentageThreshold.format - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedPercentageThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedSecondsThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedSecondsThreshold.format - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.contentWatchedSecondsThreshold.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.demotionEventType.description - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.properties.demotionEventType.type - schemas.GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig.type The following keys were changed: - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec.properties.version.description #### discoveryengine:v1beta The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameterOrder - 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.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.type - 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.list.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameterOrder - 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.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.type - 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.list.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.scopes - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.id - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.path - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.scopes - schemas.GoogleCloudDiscoveryengineV1betaEmbeddingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaEmbeddingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaEmbeddingConfig.properties.fieldPath.description - schemas.GoogleCloudDiscoveryengineV1betaEmbeddingConfig.properties.fieldPath.type - schemas.GoogleCloudDiscoveryengineV1betaEmbeddingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaListServingConfigsResponse.description - schemas.GoogleCloudDiscoveryengineV1betaListServingConfigsResponse.id - schemas.GoogleCloudDiscoveryengineV1betaListServingConfigsResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1betaListServingConfigsResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1betaListServingConfigsResponse.properties.servingConfigs.description - schemas.GoogleCloudDiscoveryengineV1betaListServingConfigsResponse.properties.servingConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaListServingConfigsResponse.properties.servingConfigs.type - schemas.GoogleCloudDiscoveryengineV1betaListServingConfigsResponse.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.id - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.boostControlIds.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.boostControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.boostControlIds.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.createTime.readOnly - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.dissociateControlIds.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.dissociateControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.dissociateControlIds.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.diversityLevel.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.diversityLevel.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.embeddingConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.embeddingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.filterControlIds.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.filterControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.filterControlIds.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.genericConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.genericConfig.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.ignoreControlIds.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.ignoreControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.ignoreControlIds.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.mediaConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.mediaConfig.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.modelId.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.modelId.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.name.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.onewaySynonymsControlIds.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.onewaySynonymsControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.onewaySynonymsControlIds.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.rankingExpression.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.redirectControlIds.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.redirectControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.redirectControlIds.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.replacementControlIds.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.replacementControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.replacementControlIds.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.solutionType.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.solutionType.enum - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.solutionType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.solutionType.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.synonymsControlIds.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.synonymsControlIds.items.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.synonymsControlIds.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.updateTime.readOnly - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig.id - schemas.GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig.properties.contentSearchSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig.properties.contentSearchSpec.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.id - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentFreshnessCutoffDays.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentFreshnessCutoffDays.format - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentFreshnessCutoffDays.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.deprecated - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.format - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedMinutesThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedPercentageThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedPercentageThreshold.format - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedPercentageThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedSecondsThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedSecondsThreshold.format - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.contentWatchedSecondsThreshold.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.demotionEventType.description - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.properties.demotionEventType.type - schemas.GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig.type The following keys were changed: - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec.properties.version.description --- discovery/discoveryengine-v1alpha.json | 522 ++++++++- discovery/discoveryengine-v1beta.json | 483 +++++++- src/apis/discoveryengine/v1alpha.ts | 1412 +++++++++++++++++++++--- src/apis/discoveryengine/v1beta.ts | 1400 ++++++++++++++++++++--- 4 files changed, 3536 insertions(+), 281 deletions(-) diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index 872233e123..a073acc357 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -1505,6 +1505,101 @@ }, "servingConfigs": { "methods": { + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "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}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", @@ -2732,6 +2827,101 @@ }, "servingConfigs": { "methods": { + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "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}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend", @@ -3938,6 +4128,101 @@ }, "servingConfigs": { "methods": { + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "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}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", @@ -4596,7 +4881,7 @@ } } }, - "revision": "20240131", + "revision": "20240206", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6060,6 +6345,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { + "description": "Defines custom fine tuning spec.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "properties": { + "enableSearchAdaptor": { + "description": "Whether or not to enable and include custom fine tuned search adaptor model.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1alphaDataStore", @@ -6398,6 +6694,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig": { + "description": "Defines embedding config, used for bring your own embeddings feature.", + "id": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", + "properties": { + "fieldPath": { + "description": "Full field path in the schema mapped as embedding field.", + "type": "string" + } + }, + "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", @@ -6980,6 +7287,26 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": { + "description": "Defines guided search spec.", + "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", + "properties": { + "enableRefinementAttributes": { + "description": "Whether or not to enable and include refinement attributes in gudied search result.", + "type": "boolean" + }, + "enableRelatedQuestions": { + "description": "Whether or not to enable and include related questions in search response.", + "type": "boolean" + }, + "maxRelatedQuestions": { + "description": "Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", @@ -7380,6 +7707,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse": { + "description": "Response for ListServingConfigs method.", + "id": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse", + "properties": { + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", + "type": "string" + }, + "servingConfigs": { + "description": "All the ServingConfigs for a given dataStore.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { "description": "Response message for SiteSearchEngineService.ListTargetSites method.", "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", @@ -8268,7 +8613,7 @@ "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 version of the text-bison@001 model. LINT.IfChange * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/pages/configurations/widget_tab.ts)", "type": "string" } }, @@ -8790,6 +9135,179 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaServingConfig": { + "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfig", + "properties": { + "boostControlIds": { + "description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. ServingConfig created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs." + }, + "displayName": { + "description": "Required. The human readable serving 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" + }, + "dissociateControlIds": { + "description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "diversityLevel": { + "description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", + "type": "string" + }, + "embeddingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", + "description": "Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config." + }, + "filterControlIds": { + "description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.", + "items": { + "type": "string" + }, + "type": "array" + }, + "genericConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", + "description": "The GenericConfig of the serving configuration." + }, + "guidedSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", + "description": "Guided search configs." + }, + "ignoreControlIds": { + "description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mediaConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", + "description": "The MediaConfig of the serving configuration." + }, + "modelId": { + "description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.", + "type": "string" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "type": "string" + }, + "onewaySynonymsControlIds": { + "description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "rankingExpression": { + "type": "string" + }, + "redirectControlIds": { + "description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "replacementControlIds": { + "description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "solutionType": { + "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent." + ], + "type": "string" + }, + "synonymsControlIds": { + "description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. ServingConfig updated timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { + "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", + "properties": { + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig": { + "description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", + "properties": { + "contentFreshnessCutoffDays": { + "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.", + "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", + "type": "number" + }, + "contentWatchedSecondsThreshold": { + "description": "Specifies the content watched minutes threshold for demotion.", + "format": "float", + "type": "number" + }, + "demotionEventType": { + "description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index b58c5bd400..85a32c186d 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -1272,6 +1272,101 @@ }, "servingConfigs": { "methods": { + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "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}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", @@ -2387,6 +2482,101 @@ }, "servingConfigs": { "methods": { + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "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}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend", @@ -3534,6 +3724,101 @@ }, "servingConfigs": { "methods": { + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "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}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", @@ -4164,7 +4449,7 @@ } } }, - "revision": "20240131", + "revision": "20240206", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -7334,6 +7619,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaEmbeddingConfig": { + "description": "Defines embedding config, used for bring your own embeddings feature.", + "id": "GoogleCloudDiscoveryengineV1betaEmbeddingConfig", + "properties": { + "fieldPath": { + "description": "Full field path in the schema mapped as embedding field.", + "type": "string" + } + }, + "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", @@ -7975,6 +8271,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse": { + "description": "Response for ListServingConfigs method.", + "id": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse", + "properties": { + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", + "type": "string" + }, + "servingConfigs": { + "description": "All the ServingConfigs for a given dataStore.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse": { "description": "Response message for SiteSearchEngineService.ListTargetSites method.", "id": "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse", @@ -8614,7 +8928,7 @@ "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 version of the text-bison@001 model. LINT.IfChange * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/pages/configurations/widget_tab.ts)", "type": "string" } }, @@ -9136,6 +9450,171 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaServingConfig": { + "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.", + "id": "GoogleCloudDiscoveryengineV1betaServingConfig", + "properties": { + "boostControlIds": { + "description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. ServingConfig created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The human readable serving 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" + }, + "dissociateControlIds": { + "description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "diversityLevel": { + "description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", + "type": "string" + }, + "embeddingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEmbeddingConfig", + "description": "Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config." + }, + "filterControlIds": { + "description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.", + "items": { + "type": "string" + }, + "type": "array" + }, + "genericConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig", + "description": "The GenericConfig of the serving configuration." + }, + "ignoreControlIds": { + "description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mediaConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig", + "description": "The MediaConfig of the serving configuration." + }, + "modelId": { + "description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.", + "type": "string" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`", + "type": "string" + }, + "onewaySynonymsControlIds": { + "description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "rankingExpression": { + "type": "string" + }, + "redirectControlIds": { + "description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "replacementControlIds": { + "description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "solutionType": { + "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent." + ], + "type": "string" + }, + "synonymsControlIds": { + "description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. ServingConfig updated timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig": { + "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", + "id": "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig", + "properties": { + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", + "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig": { + "description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", + "id": "GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig", + "properties": { + "contentFreshnessCutoffDays": { + "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.", + "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", + "type": "number" + }, + "contentWatchedSecondsThreshold": { + "description": "Specifies the content watched minutes threshold for demotion.", + "format": "float", + "type": "number" + }, + "demotionEventType": { + "description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1betaSiteSearchEngine", diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 9df9774372..ac338c2d53 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -573,6 +573,15 @@ export namespace discoveryengine_v1alpha { */ text?: string[] | null; } + /** + * Defines custom fine tuning spec. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec { + /** + * Whether or not to enable and include custom fine tuned search adaptor model. + */ + enableSearchAdaptor?: boolean | null; + } /** * DataStore captures global settings and configs at the DataStore level. */ @@ -813,6 +822,15 @@ export namespace discoveryengine_v1alpha { */ values?: number[] | null; } + /** + * Defines embedding config, used for bring your own embeddings feature. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig { + /** + * Full field path in the schema mapped as embedding field. + */ + fieldPath?: string | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -1164,6 +1182,23 @@ export namespace discoveryengine_v1alpha { */ inputUris?: string[] | null; } + /** + * Defines guided search spec. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec { + /** + * Whether or not to enable and include refinement attributes in gudied search result. + */ + enableRefinementAttributes?: boolean | null; + /** + * Whether or not to enable and include related questions in search response. + */ + enableRelatedQuestions?: boolean | null; + /** + * Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3. + */ + maxRelatedQuestions?: number | null; + } /** * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -1463,6 +1498,19 @@ export namespace discoveryengine_v1alpha { */ schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[]; } + /** + * Response for ListServingConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse { + /** + * Pagination token, if not returned indicates the last page. + */ + nextPageToken?: string | null; + /** + * All the ServingConfigs for a given dataStore. + */ + servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[]; + } /** * Response message for SiteSearchEngineService.ListTargetSites method. */ @@ -2152,7 +2200,7 @@ 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 version of the text-bison@001 model. LINT.IfChange * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/pages/configurations/widget_tab.ts) */ version?: string | null; } @@ -2518,6 +2566,126 @@ export namespace discoveryengine_v1alpha { */ summary?: string | null; } + /** + * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfig { + /** + * Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. + */ + boostControlIds?: string[] | null; + /** + * Output only. ServingConfig created timestamp. + */ + createTime?: string | null; + /** + * Custom fine tuning configs. + */ + customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; + /** + * Required. The human readable serving 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. + */ + displayName?: string | null; + /** + * Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + dissociateControlIds?: string[] | null; + /** + * How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + */ + diversityLevel?: string | null; + /** + * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config. + */ + embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig; + /** + * Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. + */ + filterControlIds?: string[] | null; + /** + * The GenericConfig of the serving configuration. + */ + genericConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig; + /** + * Guided search configs. + */ + guidedSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec; + /** + * Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. + */ + ignoreControlIds?: string[] | null; + /** + * The MediaConfig of the serving configuration. + */ + mediaConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig; + /** + * The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. + */ + modelId?: string | null; + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string | null; + /** + * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + onewaySynonymsControlIds?: string[] | null; + rankingExpression?: string | null; + /** + * IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + redirectControlIds?: string[] | null; + /** + * Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + replacementControlIds?: string[] | null; + /** + * Required. Immutable. Specifies the solution type that a serving config can be associated with. + */ + solutionType?: string | null; + /** + * Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + synonymsControlIds?: string[] | null; + /** + * Output only. ServingConfig updated timestamp. + */ + updateTime?: string | null; + } + /** + * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig { + /** + * Specifies the expected behavior of content search. Only valid for content-search enabled data store. + */ + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec; + } + /** + * Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig { + /** + * 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. + */ + contentWatchedPercentageThreshold?: number | null; + /** + * Specifies the content watched minutes threshold for demotion. + */ + contentWatchedSecondsThreshold?: number | null; + /** + * Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. + */ + demotionEventType?: string | null; + } /** * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. */ @@ -9243,65 +9411,65 @@ export namespace discoveryengine_v1alpha { } /** - * Makes a recommendation, which requires a contextual user event. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @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. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - recommend( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$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$Collections$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; options = {}; } @@ -9315,91 +9483,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Lists all ServingConfigs linked to this dataStore. * * @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. */ - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - search( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$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$Collections$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; options = {}; } @@ -9413,127 +9578,456 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + 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$Collections$Datastores$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; - targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( - this.context - ); - this.targetSites = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @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. */ - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + 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: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Makes a recommendation, which requires a contextual user event. + * + * @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. + */ + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: StreamMethodOptions + ): GaxiosPromise; + recommend( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options?: MethodOptions + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback + ): void; + recommend( + callback: BodyResponseCallback + ): void; + recommend( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Performs a search. + * + * @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. + */ + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + 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\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + 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\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; + targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( + this.context + ); + this.targetSites = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( + this.context + ); + } + + /** + * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * + * @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. + */ + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + options: StreamMethodOptions + ): GaxiosPromise; + batchVerifyTargetSites( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + options?: MethodOptions + ): GaxiosPromise; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + callback: BodyResponseCallback + ): void; + batchVerifyTargetSites( + callback: BodyResponseCallback + ): void; + batchVerifyTargetSites( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { @@ -13571,6 +14065,294 @@ export namespace discoveryengine_v1alpha { this.context = context; } + /** + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * + * @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$Engines$Servingconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$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 + ); + } + } + + /** + * Lists all ServingConfigs linked to this dataStore. + * + * @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$Engines$Servingconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$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}/servingConfigs').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 a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * + * @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$Collections$Engines$Servingconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + 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: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Makes a recommendation, which requires a contextual user event. * @@ -13767,7 +14549,45 @@ 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\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + 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\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters { /** @@ -17711,6 +18531,294 @@ export namespace discoveryengine_v1alpha { this.context = context; } + /** + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * + * @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$Servingconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$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 + ); + } + } + + /** + * Lists all ServingConfigs linked to this dataStore. + * + * @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$Servingconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$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}/servingConfigs').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 a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * + * @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$Datastores$Servingconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + 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: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Makes a recommendation, which requires a contextual user event. * @@ -17908,6 +19016,44 @@ 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\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + 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\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters { /** diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index bdf0bfcbff..8d86f3ed3f 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -1706,6 +1706,15 @@ export namespace discoveryengine_v1beta { */ values?: number[] | null; } + /** + * Defines embedding config, used for bring your own embeddings feature. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig { + /** + * Full field path in the schema mapped as embedding field. + */ + fieldPath?: string | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -2166,6 +2175,19 @@ export namespace discoveryengine_v1beta { */ schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[]; } + /** + * Response for ListServingConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse { + /** + * Pagination token, if not returned indicates the last page. + */ + nextPageToken?: string | null; + /** + * All the ServingConfigs for a given dataStore. + */ + servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[]; + } /** * Response message for SiteSearchEngineService.ListTargetSites method. */ @@ -2676,7 +2698,7 @@ 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 version of the text-bison@001 model. LINT.IfChange * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/pages/configurations/widget_tab.ts) */ version?: string | null; } @@ -3042,6 +3064,118 @@ export namespace discoveryengine_v1beta { */ summary?: string | null; } + /** + * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig { + /** + * Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. + */ + boostControlIds?: string[] | null; + /** + * Output only. ServingConfig created timestamp. + */ + createTime?: string | null; + /** + * Required. The human readable serving 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. + */ + displayName?: string | null; + /** + * Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + dissociateControlIds?: string[] | null; + /** + * How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + */ + diversityLevel?: string | null; + /** + * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config. + */ + embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig; + /** + * Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. + */ + filterControlIds?: string[] | null; + /** + * The GenericConfig of the serving configuration. + */ + genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig; + /** + * Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. + */ + ignoreControlIds?: string[] | null; + /** + * The MediaConfig of the serving configuration. + */ + mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig; + /** + * The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. + */ + modelId?: string | null; + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string | null; + /** + * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + onewaySynonymsControlIds?: string[] | null; + rankingExpression?: string | null; + /** + * IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + redirectControlIds?: string[] | null; + /** + * Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + replacementControlIds?: string[] | null; + /** + * Required. Immutable. Specifies the solution type that a serving config can be associated with. + */ + solutionType?: string | null; + /** + * Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + synonymsControlIds?: string[] | null; + /** + * Output only. ServingConfig updated timestamp. + */ + updateTime?: string | null; + } + /** + * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig { + /** + * Specifies the expected behavior of content search. Only valid for content-search enabled data store. + */ + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; + } + /** + * Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig { + /** + * 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. + */ + contentWatchedPercentageThreshold?: number | null; + /** + * Specifies the content watched minutes threshold for demotion. + */ + contentWatchedSecondsThreshold?: number | null; + /** + * Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. + */ + demotionEventType?: string | null; + } /** * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. */ @@ -7956,65 +8090,65 @@ export namespace discoveryengine_v1beta { } /** - * Makes a recommendation, which requires a contextual user event. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @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. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - recommend( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$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$Collections$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; options = {}; } @@ -8028,91 +8162,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Lists all ServingConfigs linked to this dataStore. * * @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. */ - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - search( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$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$Collections$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; options = {}; } @@ -8126,133 +8257,91 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + 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$Collections$Datastores$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; - targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( - this.context - ); - this.targetSites = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @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. */ - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; options = {}; } @@ -8266,31 +8355,402 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}:batchVerifyTargetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+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 + ); } } /** - * Downgrade from advanced site search to basic site search. + * Makes a recommendation, which requires a contextual user event. + * + * @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. + */ + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: StreamMethodOptions + ): GaxiosPromise; + recommend( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options?: MethodOptions + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback + ): void; + recommend( + callback: BodyResponseCallback + ): void; + recommend( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Performs a search. + * + * @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. + */ + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + 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\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + 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\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; + targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( + this.context + ); + this.targetSites = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( + this.context + ); + } + + /** + * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * + * @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. + */ + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + options: StreamMethodOptions + ): GaxiosPromise; + batchVerifyTargetSites( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + options?: MethodOptions + ): GaxiosPromise; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + callback: BodyResponseCallback + ): void; + batchVerifyTargetSites( + callback: BodyResponseCallback + ): void; + batchVerifyTargetSites( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}:batchVerifyTargetSites').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); + } + } + + /** + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11849,6 +12309,294 @@ export namespace discoveryengine_v1beta { this.context = context; } + /** + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * + * @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$Engines$Servingconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.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 all ServingConfigs linked to this dataStore. + * + * @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$Engines$Servingconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').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 a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * + * @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$Collections$Engines$Servingconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+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 + ); + } + } + /** * Makes a recommendation, which requires a contextual user event. * @@ -12045,7 +12793,45 @@ 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\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + 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\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + } export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters { /** @@ -15776,6 +16562,294 @@ export namespace discoveryengine_v1beta { this.context = context; } + /** + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * + * @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$Servingconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.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 all ServingConfigs linked to this dataStore. + * + * @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$Servingconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').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 a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * + * @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$Datastores$Servingconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+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 + ); + } + } + /** * Makes a recommendation, which requires a contextual user event. * @@ -15973,6 +17047,44 @@ 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\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + 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\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + } export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters { /** From fcd146315329115f1e2185aea8b21c7b7eae6346 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:16 +0000 Subject: [PATCH 16/43] fix(dlp): update the API --- src/apis/dlp/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/apis/dlp/README.md b/src/apis/dlp/README.md index fc52b8cd83..0c717df527 100644 --- a/src/apis/dlp/README.md +++ b/src/apis/dlp/README.md @@ -2,7 +2,7 @@ # dlp -> Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories. +> Discover and protect your sensitive data. A fully managed service designed to help you discover, classify, and protect your valuable data assets with ease. ## Support status **Note**: Google provides multiple libraries for this service. This library is in From b7139e60bd9d355096c431be8664ae0a31eb550d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:16 +0000 Subject: [PATCH 17/43] fix(domains): update the API #### domains:v1alpha2 The following keys were changed: - schemas.Binding.properties.role.description #### domains:v1beta1 The following keys were changed: - schemas.Binding.properties.role.description #### domains:v1 The following keys were changed: - schemas.Binding.properties.role.description --- discovery/domains-v1.json | 4 ++-- discovery/domains-v1alpha2.json | 4 ++-- discovery/domains-v1beta1.json | 4 ++-- src/apis/domains/v1.ts | 2 +- src/apis/domains/v1alpha2.ts | 2 +- src/apis/domains/v1beta1.ts | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/domains-v1.json b/discovery/domains-v1.json index 5fb5af065f..4bf59b7977 100644 --- a/discovery/domains-v1.json +++ b/discovery/domains-v1.json @@ -848,7 +848,7 @@ } } }, - "revision": "20240113", + "revision": "20240125", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -926,7 +926,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`.", + "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" } }, diff --git a/discovery/domains-v1alpha2.json b/discovery/domains-v1alpha2.json index b2da13659d..8e35456a2b 100644 --- a/discovery/domains-v1alpha2.json +++ b/discovery/domains-v1alpha2.json @@ -848,7 +848,7 @@ } } }, - "revision": "20240113", + "revision": "20240125", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -926,7 +926,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`.", + "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" } }, diff --git a/discovery/domains-v1beta1.json b/discovery/domains-v1beta1.json index 9e9635801d..d7207265c6 100644 --- a/discovery/domains-v1beta1.json +++ b/discovery/domains-v1beta1.json @@ -848,7 +848,7 @@ } } }, - "revision": "20240113", + "revision": "20240125", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -926,7 +926,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`.", + "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" } }, diff --git a/src/apis/domains/v1.ts b/src/apis/domains/v1.ts index ef84156657..6a49955910 100644 --- a/src/apis/domains/v1.ts +++ b/src/apis/domains/v1.ts @@ -172,7 +172,7 @@ export namespace domains_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } diff --git a/src/apis/domains/v1alpha2.ts b/src/apis/domains/v1alpha2.ts index 610e5d0a69..5bc771cc0e 100644 --- a/src/apis/domains/v1alpha2.ts +++ b/src/apis/domains/v1alpha2.ts @@ -172,7 +172,7 @@ export namespace domains_v1alpha2 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } diff --git a/src/apis/domains/v1beta1.ts b/src/apis/domains/v1beta1.ts index 754cb72452..e75d8c40fd 100644 --- a/src/apis/domains/v1beta1.ts +++ b/src/apis/domains/v1beta1.ts @@ -172,7 +172,7 @@ export namespace domains_v1beta1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } From 7a851f093a7b3147c128127a7bcf701c59ce591c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:16 +0000 Subject: [PATCH 18/43] feat(firestore)!: update the API BREAKING CHANGE: This release has breaking changes. #### firestore:v1beta1 The following keys were deleted: - schemas.QueryPlan.description - schemas.QueryPlan.id - schemas.QueryPlan.properties.planInfo.additionalProperties.description - schemas.QueryPlan.properties.planInfo.additionalProperties.type - schemas.QueryPlan.properties.planInfo.description - schemas.QueryPlan.properties.planInfo.type - schemas.QueryPlan.type - schemas.ResultSetStats.description - schemas.ResultSetStats.id - schemas.ResultSetStats.properties.queryPlan.$ref - schemas.ResultSetStats.properties.queryPlan.description - schemas.ResultSetStats.properties.queryStats.additionalProperties.description - schemas.ResultSetStats.properties.queryStats.additionalProperties.type - schemas.ResultSetStats.properties.queryStats.description - schemas.ResultSetStats.properties.queryStats.type - schemas.ResultSetStats.type - schemas.RunAggregationQueryRequest.properties.mode.description - schemas.RunAggregationQueryRequest.properties.mode.enum - schemas.RunAggregationQueryRequest.properties.mode.enumDescriptions - schemas.RunAggregationQueryRequest.properties.mode.type - schemas.RunAggregationQueryResponse.properties.stats.$ref - schemas.RunAggregationQueryResponse.properties.stats.description - schemas.RunQueryRequest.properties.mode.description - schemas.RunQueryRequest.properties.mode.enum - schemas.RunQueryRequest.properties.mode.enumDescriptions - schemas.RunQueryRequest.properties.mode.type - schemas.RunQueryResponse.properties.stats.$ref - schemas.RunQueryResponse.properties.stats.description #### firestore:v1 The following keys were deleted: - schemas.QueryPlan.description - schemas.QueryPlan.id - schemas.QueryPlan.properties.planInfo.additionalProperties.description - schemas.QueryPlan.properties.planInfo.additionalProperties.type - schemas.QueryPlan.properties.planInfo.description - schemas.QueryPlan.properties.planInfo.type - schemas.QueryPlan.type - schemas.ResultSetStats.description - schemas.ResultSetStats.id - schemas.ResultSetStats.properties.queryPlan.$ref - schemas.ResultSetStats.properties.queryPlan.description - schemas.ResultSetStats.properties.queryStats.additionalProperties.description - schemas.ResultSetStats.properties.queryStats.additionalProperties.type - schemas.ResultSetStats.properties.queryStats.description - schemas.ResultSetStats.properties.queryStats.type - schemas.ResultSetStats.type - schemas.RunAggregationQueryRequest.properties.mode.description - schemas.RunAggregationQueryRequest.properties.mode.enum - schemas.RunAggregationQueryRequest.properties.mode.enumDescriptions - schemas.RunAggregationQueryRequest.properties.mode.type - schemas.RunAggregationQueryResponse.properties.stats.$ref - schemas.RunAggregationQueryResponse.properties.stats.description - schemas.RunQueryRequest.properties.mode.description - schemas.RunQueryRequest.properties.mode.enum - schemas.RunQueryRequest.properties.mode.enumDescriptions - schemas.RunQueryRequest.properties.mode.type - schemas.RunQueryResponse.properties.stats.$ref - schemas.RunQueryResponse.properties.stats.description --- discovery/firestore-v1.json | 72 +------------------------------- discovery/firestore-v1beta1.json | 72 +------------------------------- src/apis/firestore/v1.ts | 38 ----------------- src/apis/firestore/v1beta1.ts | 38 ----------------- 4 files changed, 2 insertions(+), 218 deletions(-) diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index fcbfd57f22..172aec8e56 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1672,7 +1672,7 @@ } } }, - "revision": "20240117", + "revision": "20240131", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -3712,21 +3712,6 @@ }, "type": "object" }, - "QueryPlan": { - "description": "Plan for the query.", - "id": "QueryPlan", - "properties": { - "planInfo": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Planning phase information for the query. It will include: { \"indexes_used\": [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ] }", - "type": "object" - } - }, - "type": "object" - }, "QueryTarget": { "description": "A target specified by a query.", "id": "QueryTarget", @@ -3766,25 +3751,6 @@ }, "type": "object" }, - "ResultSetStats": { - "description": "Planning and execution statistics for the query.", - "id": "ResultSetStats", - "properties": { - "queryPlan": { - "$ref": "QueryPlan", - "description": "Plan for the query." - }, - "queryStats": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { \"results_returned\": \"20\", \"documents_scanned\": \"20\", \"indexes_entries_scanned\": \"10050\", \"total_execution_time\": \"100.7 msecs\" }", - "type": "object" - } - }, - "type": "object" - }, "RollbackRequest": { "description": "The request for Firestore.Rollback.", "id": "RollbackRequest", @@ -3801,20 +3767,6 @@ "description": "The request for Firestore.RunAggregationQuery.", "id": "RunAggregationQueryRequest", "properties": { - "mode": { - "description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.", - "enum": [ - "NORMAL", - "PLAN", - "PROFILE" - ], - "enumDescriptions": [ - "The default mode. Only the query results are returned.", - "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." - ], - "type": "string" - }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream." @@ -3849,10 +3801,6 @@ "$ref": "AggregationResult", "description": "A single aggregation result. Not present when reporting partial progress." }, - "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream." - }, "transaction": { "description": "The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction.", "format": "byte", @@ -3865,20 +3813,6 @@ "description": "The request for Firestore.RunQuery.", "id": "RunQueryRequest", "properties": { - "mode": { - "description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.", - "enum": [ - "NORMAL", - "PLAN", - "PROFILE" - ], - "enumDescriptions": [ - "The default mode. Only the query results are returned.", - "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." - ], - "type": "string" - }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream." @@ -3922,10 +3856,6 @@ "format": "int32", "type": "integer" }, - "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream." - }, "transaction": { "description": "The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.", "format": "byte", diff --git a/discovery/firestore-v1beta1.json b/discovery/firestore-v1beta1.json index 2596572241..32b90143fe 100644 --- a/discovery/firestore-v1beta1.json +++ b/discovery/firestore-v1beta1.json @@ -950,7 +950,7 @@ } } }, - "revision": "20240117", + "revision": "20240131", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2253,21 +2253,6 @@ }, "type": "object" }, - "QueryPlan": { - "description": "Plan for the query.", - "id": "QueryPlan", - "properties": { - "planInfo": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Planning phase information for the query. It will include: { \"indexes_used\": [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ] }", - "type": "object" - } - }, - "type": "object" - }, "QueryTarget": { "description": "A target specified by a query.", "id": "QueryTarget", @@ -2307,25 +2292,6 @@ }, "type": "object" }, - "ResultSetStats": { - "description": "Planning and execution statistics for the query.", - "id": "ResultSetStats", - "properties": { - "queryPlan": { - "$ref": "QueryPlan", - "description": "Plan for the query." - }, - "queryStats": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { \"results_returned\": \"20\", \"documents_scanned\": \"20\", \"indexes_entries_scanned\": \"10050\", \"total_execution_time\": \"100.7 msecs\" }", - "type": "object" - } - }, - "type": "object" - }, "RollbackRequest": { "description": "The request for Firestore.Rollback.", "id": "RollbackRequest", @@ -2342,20 +2308,6 @@ "description": "The request for Firestore.RunAggregationQuery.", "id": "RunAggregationQueryRequest", "properties": { - "mode": { - "description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.", - "enum": [ - "NORMAL", - "PLAN", - "PROFILE" - ], - "enumDescriptions": [ - "The default mode. Only the query results are returned.", - "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." - ], - "type": "string" - }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream." @@ -2390,10 +2342,6 @@ "$ref": "AggregationResult", "description": "A single aggregation result. Not present when reporting partial progress." }, - "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream." - }, "transaction": { "description": "The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction.", "format": "byte", @@ -2406,20 +2354,6 @@ "description": "The request for Firestore.RunQuery.", "id": "RunQueryRequest", "properties": { - "mode": { - "description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.", - "enum": [ - "NORMAL", - "PLAN", - "PROFILE" - ], - "enumDescriptions": [ - "The default mode. Only the query results are returned.", - "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." - ], - "type": "string" - }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream." @@ -2463,10 +2397,6 @@ "format": "int32", "type": "integer" }, - "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream." - }, "transaction": { "description": "The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.", "format": "byte", diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 6a715d09d3..4bf8806e98 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -1447,15 +1447,6 @@ export namespace firestore_v1 { */ fields?: Schema$FieldReference[]; } - /** - * Plan for the query. - */ - export interface Schema$QueryPlan { - /** - * Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ] \} - */ - planInfo?: {[key: string]: any} | null; - } /** * A target specified by a query. */ @@ -1487,19 +1478,6 @@ export namespace firestore_v1 { */ retryTransaction?: string | null; } - /** - * Planning and execution statistics for the query. - */ - export interface Schema$ResultSetStats { - /** - * Plan for the query. - */ - queryPlan?: Schema$QueryPlan; - /** - * Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" \} - */ - queryStats?: {[key: string]: any} | null; - } /** * The request for Firestore.Rollback. */ @@ -1513,10 +1491,6 @@ export namespace firestore_v1 { * The request for Firestore.RunAggregationQuery. */ export interface Schema$RunAggregationQueryRequest { - /** - * Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. - */ - mode?: string | null; /** * Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream. */ @@ -1546,10 +1520,6 @@ export namespace firestore_v1 { * A single aggregation result. Not present when reporting partial progress. */ result?: Schema$AggregationResult; - /** - * Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream. - */ - stats?: Schema$ResultSetStats; /** * The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction. */ @@ -1559,10 +1529,6 @@ export namespace firestore_v1 { * The request for Firestore.RunQuery. */ export interface Schema$RunQueryRequest { - /** - * Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. - */ - mode?: string | null; /** * Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */ @@ -1600,10 +1566,6 @@ export namespace firestore_v1 { * The number of results that have been skipped due to an offset between the last response and the current response. */ skippedResults?: number | null; - /** - * Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream. - */ - stats?: Schema$ResultSetStats; /** * The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response. */ diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index b958d2c880..ae17210517 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -1015,15 +1015,6 @@ export namespace firestore_v1beta1 { */ fields?: Schema$FieldReference[]; } - /** - * Plan for the query. - */ - export interface Schema$QueryPlan { - /** - * Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ] \} - */ - planInfo?: {[key: string]: any} | null; - } /** * A target specified by a query. */ @@ -1055,19 +1046,6 @@ export namespace firestore_v1beta1 { */ retryTransaction?: string | null; } - /** - * Planning and execution statistics for the query. - */ - export interface Schema$ResultSetStats { - /** - * Plan for the query. - */ - queryPlan?: Schema$QueryPlan; - /** - * Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" \} - */ - queryStats?: {[key: string]: any} | null; - } /** * The request for Firestore.Rollback. */ @@ -1081,10 +1059,6 @@ export namespace firestore_v1beta1 { * The request for Firestore.RunAggregationQuery. */ export interface Schema$RunAggregationQueryRequest { - /** - * Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. - */ - mode?: string | null; /** * Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream. */ @@ -1114,10 +1088,6 @@ export namespace firestore_v1beta1 { * A single aggregation result. Not present when reporting partial progress. */ result?: Schema$AggregationResult; - /** - * Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream. - */ - stats?: Schema$ResultSetStats; /** * The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction. */ @@ -1127,10 +1097,6 @@ export namespace firestore_v1beta1 { * The request for Firestore.RunQuery. */ export interface Schema$RunQueryRequest { - /** - * Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. - */ - mode?: string | null; /** * Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */ @@ -1168,10 +1134,6 @@ export namespace firestore_v1beta1 { * The number of results that have been skipped due to an offset between the last response and the current response. */ skippedResults?: number | null; - /** - * Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream. - */ - stats?: Schema$ResultSetStats; /** * The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response. */ From b2cd3b9e056661714053b420f4b359cd220b86eb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:17 +0000 Subject: [PATCH 19/43] feat(gkeonprem)!: update the API BREAKING CHANGE: This release has breaking changes. #### gkeonprem:v1 The following keys were deleted: - schemas.VmwareNetworkConfig.properties.vcenterNetwork.readOnly The following keys were added: - schemas.VmwareCluster.properties.binaryAuthorization.$ref - schemas.VmwareCluster.properties.binaryAuthorization.description - schemas.VmwareDataplaneV2Config.properties.forwardMode.description - schemas.VmwareDataplaneV2Config.properties.forwardMode.type The following keys were changed: - schemas.BareMetalAdminCluster.description - schemas.BareMetalCluster.description - schemas.Binding.properties.members.description - schemas.Binding.properties.role.description - schemas.OperationProgress.description - schemas.VmwareNetworkConfig.properties.vcenterNetwork.description --- discovery/gkeonprem-v1.json | 23 +++++++++++++++-------- src/apis/gkeonprem/v1.ts | 20 ++++++++++++++------ 2 files changed, 29 insertions(+), 14 deletions(-) diff --git a/discovery/gkeonprem-v1.json b/discovery/gkeonprem-v1.json index 2c3d18dfd6..dce68c9acf 100644 --- a/discovery/gkeonprem-v1.json +++ b/discovery/gkeonprem-v1.json @@ -2996,7 +2996,7 @@ } } }, - "revision": "20231204", + "revision": "20240124", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -3029,7 +3029,7 @@ "type": "object" }, "BareMetalAdminCluster": { - "description": "Resource that represents a bare metal admin cluster. LINT.IfChange", + "description": "Resource that represents a bare metal admin cluster.", "id": "BareMetalAdminCluster", "properties": { "annotations": { @@ -3532,7 +3532,7 @@ "type": "object" }, "BareMetalCluster": { - "description": "Resource that represents a bare metal user cluster. LINT.IfChange", + "description": "Resource that represents a bare metal user cluster.", "id": "BareMetalCluster", "properties": { "adminClusterMembership": { @@ -4398,14 +4398,14 @@ "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`. * `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.", + "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`.", + "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" } }, @@ -4986,7 +4986,7 @@ "type": "object" }, "OperationProgress": { - "description": "Information about operation progress. LINT.IfChange", + "description": "Information about operation progress.", "id": "OperationProgress", "properties": { "stages": { @@ -5911,6 +5911,10 @@ "$ref": "VmwareAutoRepairConfig", "description": "Configuration for auto repairing." }, + "binaryAuthorization": { + "$ref": "BinaryAuthorization", + "description": "Binary Authorization related configurations." + }, "controlPlaneNode": { "$ref": "VmwareControlPlaneNodeConfig", "description": "VMware user cluster control plane nodes must have either 1 or 3 replicas." @@ -6125,6 +6129,10 @@ "description": "Enables Dataplane V2.", "type": "boolean" }, + "forwardMode": { + "description": "Configure ForwardMode for Dataplane v2.", + "type": "string" + }, "windowsDataplaneV2Enabled": { "description": "Enable Dataplane V2 for clusters with Windows nodes.", "type": "boolean" @@ -6331,8 +6339,7 @@ "description": "Configuration settings for a static IP configuration." }, "vcenterNetwork": { - "description": "Output only. vcenter_network specifies vCenter network name. Inherited from the admin cluster.", - "readOnly": true, + "description": "vcenter_network specifies vCenter network name. Inherited from the admin cluster.", "type": "string" } }, diff --git a/src/apis/gkeonprem/v1.ts b/src/apis/gkeonprem/v1.ts index 81af5741c8..1aeda31634 100644 --- a/src/apis/gkeonprem/v1.ts +++ b/src/apis/gkeonprem/v1.ts @@ -147,7 +147,7 @@ export namespace gkeonprem_v1 { value?: string | null; } /** - * Resource that represents a bare metal admin cluster. LINT.IfChange + * Resource that represents a bare metal admin cluster. */ export interface Schema$BareMetalAdminCluster { /** @@ -531,7 +531,7 @@ export namespace gkeonprem_v1 { ipAddress?: string | null; } /** - * Resource that represents a bare metal user cluster. LINT.IfChange + * Resource that represents a bare metal user cluster. */ export interface Schema$BareMetalCluster { /** @@ -1168,11 +1168,11 @@ export namespace gkeonprem_v1 { */ 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`. * `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. + * 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`. + * 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; } @@ -1571,7 +1571,7 @@ export namespace gkeonprem_v1 { verb?: string | null; } /** - * Information about operation progress. LINT.IfChange + * Information about operation progress. */ export interface Schema$OperationProgress { /** @@ -2237,6 +2237,10 @@ export namespace gkeonprem_v1 { * Configuration for auto repairing. */ autoRepairConfig?: Schema$VmwareAutoRepairConfig; + /** + * Binary Authorization related configurations. + */ + binaryAuthorization?: Schema$BinaryAuthorization; /** * VMware user cluster control plane nodes must have either 1 or 3 replicas. */ @@ -2406,6 +2410,10 @@ export namespace gkeonprem_v1 { * Enables Dataplane V2. */ dataplaneV2Enabled?: boolean | null; + /** + * Configure ForwardMode for Dataplane v2. + */ + forwardMode?: string | null; /** * Enable Dataplane V2 for clusters with Windows nodes. */ @@ -2568,7 +2576,7 @@ export namespace gkeonprem_v1 { */ staticIpConfig?: Schema$VmwareStaticIpConfig; /** - * Output only. vcenter_network specifies vCenter network name. Inherited from the admin cluster. + * vcenter_network specifies vCenter network name. Inherited from the admin cluster. */ vcenterNetwork?: string | null; } From 0cbb6d398308f8552d2f3cf46bf6a32f5733e0b3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:17 +0000 Subject: [PATCH 20/43] feat(healthcare): update the API #### healthcare:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameters.resourceId.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameters.resourceId.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.parameters.resourceId.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess.scopes - schemas.ConsentAccessorScope.description - schemas.ConsentAccessorScope.id - schemas.ConsentAccessorScope.properties.actor.description - schemas.ConsentAccessorScope.properties.actor.type - schemas.ConsentAccessorScope.properties.environment.description - schemas.ConsentAccessorScope.properties.environment.type - schemas.ConsentAccessorScope.properties.purpose.description - schemas.ConsentAccessorScope.properties.purpose.type - schemas.ConsentAccessorScope.type - schemas.ExplainDataAccessConsentInfo.description - schemas.ExplainDataAccessConsentInfo.id - schemas.ExplainDataAccessConsentInfo.properties.cascadeOrigins.description - schemas.ExplainDataAccessConsentInfo.properties.cascadeOrigins.items.type - schemas.ExplainDataAccessConsentInfo.properties.cascadeOrigins.type - schemas.ExplainDataAccessConsentInfo.properties.consentResource.description - schemas.ExplainDataAccessConsentInfo.properties.consentResource.type - schemas.ExplainDataAccessConsentInfo.properties.enforcementTime.description - schemas.ExplainDataAccessConsentInfo.properties.enforcementTime.format - schemas.ExplainDataAccessConsentInfo.properties.enforcementTime.type - schemas.ExplainDataAccessConsentInfo.properties.matchingAccessorScopes.description - schemas.ExplainDataAccessConsentInfo.properties.matchingAccessorScopes.items.$ref - schemas.ExplainDataAccessConsentInfo.properties.matchingAccessorScopes.type - schemas.ExplainDataAccessConsentInfo.properties.patientConsentOwner.description - schemas.ExplainDataAccessConsentInfo.properties.patientConsentOwner.type - schemas.ExplainDataAccessConsentInfo.properties.type.description - schemas.ExplainDataAccessConsentInfo.properties.type.enum - schemas.ExplainDataAccessConsentInfo.properties.type.enumDescriptions - schemas.ExplainDataAccessConsentInfo.properties.type.type - schemas.ExplainDataAccessConsentInfo.properties.variants.description - schemas.ExplainDataAccessConsentInfo.properties.variants.items.enum - schemas.ExplainDataAccessConsentInfo.properties.variants.items.enumDescriptions - schemas.ExplainDataAccessConsentInfo.properties.variants.items.type - schemas.ExplainDataAccessConsentInfo.properties.variants.type - schemas.ExplainDataAccessConsentInfo.type - schemas.ExplainDataAccessConsentScope.description - schemas.ExplainDataAccessConsentScope.id - schemas.ExplainDataAccessConsentScope.properties.accessorScope.$ref - schemas.ExplainDataAccessConsentScope.properties.accessorScope.description - schemas.ExplainDataAccessConsentScope.properties.decision.description - schemas.ExplainDataAccessConsentScope.properties.decision.enum - schemas.ExplainDataAccessConsentScope.properties.decision.enumDescriptions - schemas.ExplainDataAccessConsentScope.properties.decision.type - schemas.ExplainDataAccessConsentScope.properties.enforcingConsents.description - schemas.ExplainDataAccessConsentScope.properties.enforcingConsents.items.$ref - schemas.ExplainDataAccessConsentScope.properties.enforcingConsents.type - schemas.ExplainDataAccessConsentScope.properties.exceptions.description - schemas.ExplainDataAccessConsentScope.properties.exceptions.items.$ref - schemas.ExplainDataAccessConsentScope.properties.exceptions.type - schemas.ExplainDataAccessConsentScope.type - schemas.ExplainDataAccessResponse.description - schemas.ExplainDataAccessResponse.id - schemas.ExplainDataAccessResponse.properties.consentScopes.description - schemas.ExplainDataAccessResponse.properties.consentScopes.items.$ref - schemas.ExplainDataAccessResponse.properties.consentScopes.type - schemas.ExplainDataAccessResponse.properties.warning.description - schemas.ExplainDataAccessResponse.properties.warning.type - schemas.ExplainDataAccessResponse.type - schemas.Message.properties.name.readOnly The following keys were changed: - resources.projects.resources.locations.resources.datasets.methods.create.parameters.datasetId.description - resources.projects.resources.locations.resources.datasets.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.create.parameters.annotationStoreId.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.evaluate.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.export.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.import.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.create.parameters.hl7V2StoreId.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.export.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.import.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.batchGet.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.ingest.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.patch.parameters.updateMask.description - schemas.AccessDeterminationLogConfig.properties.logLevel.enumDescriptions - schemas.Annotation.properties.annotationSource.description - schemas.Annotation.properties.name.description - schemas.AnnotationStore.properties.name.description - schemas.Binding.properties.role.description - schemas.Consent.properties.name.description - schemas.CreateMessageRequest.properties.message.description - schemas.Dataset.properties.name.description - schemas.EvaluateAnnotationStoreRequest.properties.goldenStore.description - schemas.FhirStore.properties.enableHistoryModifications.description - schemas.Hl7V2Store.properties.name.description - schemas.IngestMessageRequest.properties.message.description - schemas.Message.properties.data.description - schemas.Message.properties.name.description #### healthcare:v1 The following keys were added: - schemas.Message.properties.name.readOnly The following keys were changed: - resources.projects.resources.locations.resources.datasets.methods.create.parameters.datasetId.description - resources.projects.resources.locations.resources.datasets.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.create.parameters.hl7V2StoreId.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.export.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.import.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.ingest.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.patch.parameters.updateMask.description - schemas.Binding.properties.role.description - schemas.Consent.properties.name.description - schemas.ConsentStore.properties.name.description - schemas.CreateMessageRequest.properties.message.description - schemas.Dataset.properties.name.description - schemas.Hl7V2Store.properties.name.description - schemas.IngestMessageRequest.properties.message.description - schemas.Message.properties.data.description - schemas.Message.properties.name.description --- discovery/healthcare-v1.json | 73 ++++---- discovery/healthcare-v1beta1.json | 289 ++++++++++++++++++++++------ src/apis/healthcare/v1.ts | 70 +++---- src/apis/healthcare/v1beta1.ts | 300 ++++++++++++++++++++++++------ 4 files changed, 548 insertions(+), 184 deletions(-) diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index e60c909cf4..aee3c586cf 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -194,12 +194,12 @@ ], "parameters": { "datasetId": { - "description": "The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", + "description": "Required. The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", "location": "query", "type": "string" }, "parent": { - "description": "The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`.", + "description": "Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -257,7 +257,7 @@ ], "parameters": { "name": { - "description": "The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", + "description": "Required. The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -283,7 +283,7 @@ ], "parameters": { "name": { - "description": "The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", + "description": "Required. The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -352,7 +352,7 @@ "type": "string" }, "parent": { - "description": "The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`.", + "description": "Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -378,14 +378,14 @@ ], "parameters": { "name": { - "description": "Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", + "description": "Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "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", + "description": "Required. 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" @@ -693,7 +693,7 @@ ], "parameters": { "name": { - "description": "Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation.", + "description": "Identifier. Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/consentStores/[^/]+$", "required": true, @@ -1333,7 +1333,7 @@ ], "parameters": { "name": { - "description": "Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.", + "description": "Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/consentStores/[^/]+/consents/[^/]+$", "required": true, @@ -3746,12 +3746,12 @@ ], "parameters": { "hl7V2StoreId": { - "description": "The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", + "description": "Required. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", "location": "query", "type": "string" }, "parent": { - "description": "The name of the dataset this HL7v2 store belongs to.", + "description": "Required. The name of the dataset this HL7v2 store belongs to.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -3780,7 +3780,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 store to delete.", + "description": "Required. The resource name of the HL7v2 store to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -3806,7 +3806,7 @@ ], "parameters": { "name": { - "description": "The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`", + "description": "Required. The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -3835,7 +3835,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 store to get.", + "description": "Required. The resource name of the HL7v2 store to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -3861,7 +3861,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "description": "Required. The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -3919,7 +3919,7 @@ ], "parameters": { "name": { - "description": "The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`", + "description": "Required. The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -3964,7 +3964,7 @@ "type": "string" }, "parent": { - "description": "Name of the dataset.", + "description": "Required. Name of the dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -3990,14 +3990,14 @@ ], "parameters": { "name": { - "description": "Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "description": "Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "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", + "description": "Required. 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" @@ -4087,7 +4087,7 @@ ], "parameters": { "parent": { - "description": "The name of the HL7v2 store this message belongs to.", + "description": "Required. The name of the HL7v2 store this message belongs to.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -4116,7 +4116,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 message to delete.", + "description": "Required. The resource name of the HL7v2 message to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+/messages/[^/]+$", "required": true, @@ -4142,7 +4142,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 message to retrieve.", + "description": "Required. The resource name of the HL7v2 message to retrieve.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+/messages/[^/]+$", "required": true, @@ -4189,7 +4189,7 @@ ], "parameters": { "parent": { - "description": "The name of the HL7v2 store this message belongs to.", + "description": "Required. The name of the HL7v2 store this message belongs to.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -4239,7 +4239,7 @@ "type": "string" }, "parent": { - "description": "Name of the HL7v2 store to retrieve messages from.", + "description": "Required. Name of the HL7v2 store to retrieve messages from.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -4286,14 +4286,14 @@ ], "parameters": { "name": { - "description": "Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.", + "description": "Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+/messages/[^/]+$", "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", + "description": "Required. 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" @@ -4460,7 +4460,7 @@ } } }, - "revision": "20240112", + "revision": "20240130", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -4697,7 +4697,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`.", + "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" } }, @@ -4795,7 +4795,7 @@ "type": "object" }, "name": { - "description": "Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.", + "description": "Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.", "type": "string" }, "policies": { @@ -4953,7 +4953,7 @@ "type": "object" }, "name": { - "description": "Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation.", + "description": "Identifier. Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation.", "type": "string" } }, @@ -4965,7 +4965,7 @@ "properties": { "message": { "$ref": "Message", - "description": "HL7v2 message." + "description": "Required. HL7v2 message." } }, "type": "object" @@ -4991,7 +4991,7 @@ "id": "Dataset", "properties": { "name": { - "description": "Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", + "description": "Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "type": "string" }, "timeZone": { @@ -6066,7 +6066,7 @@ "type": "object" }, "name": { - "description": "Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "description": "Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", "type": "string" }, "notificationConfigs": { @@ -6301,7 +6301,7 @@ "properties": { "message": { "$ref": "Message", - "description": "HL7v2 message to ingest." + "description": "Required. HL7v2 message to ingest." } }, "type": "object" @@ -6622,7 +6622,7 @@ "type": "string" }, "data": { - "description": "Raw message bytes.", + "description": "Required. Raw message bytes.", "format": "byte", "type": "string" }, @@ -6638,7 +6638,8 @@ "type": "string" }, "name": { - "description": "Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.", + "description": "Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.", + "readOnly": true, "type": "string" }, "parsedData": { diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index ceb09f01c4..d18c863a76 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -194,12 +194,12 @@ ], "parameters": { "datasetId": { - "description": "The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", + "description": "Required. The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", "location": "query", "type": "string" }, "parent": { - "description": "The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`.", + "description": "Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -257,7 +257,7 @@ ], "parameters": { "name": { - "description": "The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", + "description": "Required. The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -283,7 +283,7 @@ ], "parameters": { "name": { - "description": "The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", + "description": "Required. The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -352,7 +352,7 @@ "type": "string" }, "parent": { - "description": "The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`.", + "description": "Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -378,14 +378,14 @@ ], "parameters": { "name": { - "description": "Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", + "description": "Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "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", + "description": "Required. 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" @@ -475,12 +475,12 @@ ], "parameters": { "annotationStoreId": { - "description": "The ID of the Annotation store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", + "description": "Required. The ID of the Annotation store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", "location": "query", "type": "string" }, "parent": { - "description": "The name of the dataset this Annotation store belongs to.", + "description": "Required. The name of the dataset this Annotation store belongs to.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -509,7 +509,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Annotation store to delete.", + "description": "Required. The resource name of the Annotation store to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$", "required": true, @@ -535,7 +535,7 @@ ], "parameters": { "name": { - "description": "The Annotation store to compare against `golden_store`, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", + "description": "Required. The Annotation store to compare against `golden_store`, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$", "required": true, @@ -564,7 +564,7 @@ ], "parameters": { "name": { - "description": "The name of the Annotation store to export annotations to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", + "description": "Required. The name of the Annotation store to export annotations to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$", "required": true, @@ -593,7 +593,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Annotation store to get.", + "description": "Required. The resource name of the Annotation store to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$", "required": true, @@ -651,7 +651,7 @@ ], "parameters": { "name": { - "description": "The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", + "description": "Required. The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$", "required": true, @@ -696,7 +696,7 @@ "type": "string" }, "parent": { - "description": "Name of the dataset.", + "description": "Required. Name of the dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -722,14 +722,14 @@ ], "parameters": { "name": { - "description": "Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", + "description": "Identifier. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$", "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", + "description": "Required. 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" @@ -819,7 +819,7 @@ ], "parameters": { "parent": { - "description": "The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`.", + "description": "Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$", "required": true, @@ -848,7 +848,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Annotation to delete.", + "description": "Required. The resource name of the Annotation to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$", "required": true, @@ -874,7 +874,7 @@ ], "parameters": { "name": { - "description": "The resource name of the Annotation to retrieve.", + "description": "Required. The resource name of the Annotation to retrieve.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$", "required": true, @@ -916,7 +916,7 @@ "type": "string" }, "parent": { - "description": "Name of the Annotation store to retrieve Annotations from.", + "description": "Required. Name of the Annotation store to retrieve Annotations from.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$", "required": true, @@ -957,14 +957,14 @@ ], "parameters": { "name": { - "description": "Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.", + "description": "Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$", "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", + "description": "Required. 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" @@ -1856,7 +1856,7 @@ ], "parameters": { "name": { - "description": "Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.", + "description": "Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/consentStores/[^/]+/consents/[^/]+$", "required": true, @@ -3585,6 +3585,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "explainDataAccess": { + "description": "Explains all the permitted/denied actor, purpose and environment for a given resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:explainDataAccess", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.explainDataAccess", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FHIR store to enforce, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", + "required": true, + "type": "string" + }, + "resourceId": { + "description": "Required. The ID (`{resourceType}/{id}`) of the resource to explain data access on.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:explainDataAccess", + "response": { + "$ref": "ExplainDataAccessResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "export": { "description": "Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export", @@ -4722,12 +4753,12 @@ ], "parameters": { "hl7V2StoreId": { - "description": "The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", + "description": "Required. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.", "location": "query", "type": "string" }, "parent": { - "description": "The name of the dataset this HL7v2 store belongs to.", + "description": "Required. The name of the dataset this HL7v2 store belongs to.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -4756,7 +4787,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 store to delete.", + "description": "Required. The resource name of the HL7v2 store to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -4782,7 +4813,7 @@ ], "parameters": { "name": { - "description": "The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`", + "description": "Required. The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -4811,7 +4842,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 store to get.", + "description": "Required. The resource name of the HL7v2 store to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -4837,7 +4868,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "description": "Required. The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -4895,7 +4926,7 @@ ], "parameters": { "name": { - "description": "The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`", + "description": "Required. The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -4940,7 +4971,7 @@ "type": "string" }, "parent": { - "description": "Name of the dataset.", + "description": "Required. Name of the dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -4966,14 +4997,14 @@ ], "parameters": { "name": { - "description": "Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "description": "Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "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", + "description": "Required. 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" @@ -5069,7 +5100,7 @@ "type": "string" }, "parent": { - "description": "Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`.", + "description": "Required. Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -5116,7 +5147,7 @@ ], "parameters": { "parent": { - "description": "The name of the HL7v2 store this message belongs to.", + "description": "Required. The name of the HL7v2 store this message belongs to.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -5145,7 +5176,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 message to delete.", + "description": "Required. The resource name of the HL7v2 message to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+/messages/[^/]+$", "required": true, @@ -5171,7 +5202,7 @@ ], "parameters": { "name": { - "description": "The resource name of the HL7v2 message to retrieve.", + "description": "Required. The resource name of the HL7v2 message to retrieve.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+/messages/[^/]+$", "required": true, @@ -5218,7 +5249,7 @@ ], "parameters": { "parent": { - "description": "The name of the HL7v2 store this message belongs to.", + "description": "Required. The name of the HL7v2 store this message belongs to.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -5268,7 +5299,7 @@ "type": "string" }, "parent": { - "description": "Name of the HL7v2 store to retrieve messages from.", + "description": "Required. Name of the HL7v2 store to retrieve messages from.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", "required": true, @@ -5315,14 +5346,14 @@ ], "parameters": { "name": { - "description": "Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.", + "description": "Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+/messages/[^/]+$", "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", + "description": "Required. 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" @@ -5489,7 +5520,7 @@ } } }, - "revision": "20240112", + "revision": "20240130", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5507,8 +5538,8 @@ "enumDescriptions": [ "No log level specified. This value is unused.", "No additional consent-related logging is added to audit logs.", - "The following information is included: - One of the following [`consentMode`](https://cloud.google.com/healthcare-api/docs/fhir-consent#audit_logs) fields: (`off`|`emptyScope`|`enforced`|`btg`|`bypass`). - The accessor's request headers - The `log_level` of the [AccessDeterminationLogConfig](google.cloud.healthcare.v1beta1.fhir.FhirStore.ConsentConfig.AccessDeterminationLogConfig) - The final consent evaluation (`PERMIT`, `DENY`, or `NO_CONSENT`) - A human-readable summary of the evaluation", - "Includes `MINIMUM` and, for each resource owner, returns: - The resource owner's name - Most specific part of the `X-Consent-Scope` resulting in consensual determination - Timestamp of the applied enforcement leading to the decision - Enforcement version at the time the applicable consents were applied - The Consent resource name - The timestamp of the Consent resource used for enforcement - Policy type (PATIENT or ADMIN) Note that this mode adds some overhead to CRUD operations." + "The following information is included: * One of the following [`consentMode`](https://cloud.google.com/healthcare-api/docs/fhir-consent#audit_logs) fields: (`off`|`emptyScope`|`enforced`|`btg`|`bypass`). * The accessor's request headers * The `log_level` of the [AccessDeterminationLogConfig](https://cloud.google.com/healthcare-api/docs/reference/rest/v1beta1/projects.locations.datasets.fhirStores#AccessDeterminationLogConfig) * The final consent evaluation (`PERMIT`, `DENY`, or `NO_CONSENT`) * A human-readable summary of the evaluation", + "Includes `MINIMUM` and, for each resource owner, returns: * The resource owner's name * Most specific part of the `X-Consent-Scope` resulting in consensual determination * Timestamp of the applied enforcement leading to the decision * Enforcement version at the time the applicable consents were applied * The Consent resource name * The timestamp of the Consent resource used for enforcement * Policy type (`PATIENT` or `ADMIN`) Note that this mode adds some overhead to CRUD operations." ], "type": "string" } @@ -5674,7 +5705,7 @@ "properties": { "annotationSource": { "$ref": "AnnotationSource", - "description": "Details of the source." + "description": "Required. Details of the source." }, "customData": { "additionalProperties": { @@ -5688,7 +5719,7 @@ "description": "Annotations for images. For example, bounding polygons." }, "name": { - "description": "Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.", + "description": "Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.", "type": "string" }, "resourceAnnotation": { @@ -5740,7 +5771,7 @@ "type": "object" }, "name": { - "description": "Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", + "description": "Identifier. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", "type": "string" } }, @@ -5984,7 +6015,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`.", + "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" } }, @@ -6213,7 +6244,7 @@ "type": "object" }, "name": { - "description": "Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.", + "description": "Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.", "type": "string" }, "policies": { @@ -6266,6 +6297,25 @@ }, "type": "object" }, + "ConsentAccessorScope": { + "description": "The accessor scope that describes who can access, for what purpose, in which environment.", + "id": "ConsentAccessorScope", + "properties": { + "actor": { + "description": "An individual, group, or access role that identifies the accessor or a characteristic of the accessor. This can be a resource ID (such as `{resourceType}/{id}`) or an external URI. This value must be present.", + "type": "string" + }, + "environment": { + "description": "An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be “*” if it applies to all environments.", + "type": "string" + }, + "purpose": { + "description": "The intent of data use. Can be “*” if it applies to all purposes.", + "type": "string" + } + }, + "type": "object" + }, "ConsentArtifact": { "description": "Documentation of a user's consent.", "id": "ConsentArtifact", @@ -6448,7 +6498,7 @@ "properties": { "message": { "$ref": "Message", - "description": "HL7v2 message." + "description": "Required. HL7v2 message." } }, "type": "object" @@ -6480,7 +6530,7 @@ "id": "Dataset", "properties": { "name": { - "description": "Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", + "description": "Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "type": "string" }, "timeZone": { @@ -6948,7 +6998,7 @@ "type": "object" }, "goldenStore": { - "description": "The Annotation store to use as ground truth, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", + "description": "Required. The Annotation store to use as ground truth, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.", "type": "string" }, "infoTypeConfig": { @@ -7032,6 +7082,128 @@ }, "type": "object" }, + "ExplainDataAccessConsentInfo": { + "description": "The enforcing consent's metadata.", + "id": "ExplainDataAccessConsentInfo", + "properties": { + "cascadeOrigins": { + "description": "The compartment base resources that matched a cascading policy. Each resource has the following format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/{resource_type}/{resource_id}`", + "items": { + "type": "string" + }, + "type": "array" + }, + "consentResource": { + "description": "The resource name of this consent resource. Format: `projects/{projectId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/{resourceType}/{id}`.", + "type": "string" + }, + "enforcementTime": { + "description": "Last enforcement timestamp of this consent resource.", + "format": "google-datetime", + "type": "string" + }, + "matchingAccessorScopes": { + "description": "A list of all the matching accessor scopes of this consent policy that enforced ExplainDataAccessConsentScope.accessor_scope.", + "items": { + "$ref": "ConsentAccessorScope" + }, + "type": "array" + }, + "patientConsentOwner": { + "description": "The patient owning the consent (only applicable for patient consents), in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{patient_id}`", + "type": "string" + }, + "type": { + "description": "The policy type of consent resource (e.g. PATIENT, ADMIN).", + "enum": [ + "CONSENT_POLICY_TYPE_UNSPECIFIED", + "CONSENT_POLICY_TYPE_PATIENT", + "CONSENT_POLICY_TYPE_ADMIN" + ], + "enumDescriptions": [ + "Unspecified policy type.", + "Consent represent a patient consent.", + "Consent represent an admin consent." + ], + "type": "string" + }, + "variants": { + "description": "The consent's variant combinations. A single consent may have multiple variants.", + "items": { + "enum": [ + "VARIANT_UNSPECIFIED", + "VARIANT_STANDARD", + "VARIANT_CASCADE" + ], + "enumDescriptions": [ + "Consent variant unspecified.", + "Consent is a standard patient or admin consent.", + "Consent is a cascading consent." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExplainDataAccessConsentScope": { + "description": "A single consent scope that provides info on who has access to the requested resource scope for a particular purpose and environment, enforced by which consent.", + "id": "ExplainDataAccessConsentScope", + "properties": { + "accessorScope": { + "$ref": "ConsentAccessorScope", + "description": "The accessor scope that describes who can access, for what purpose, and in which environment." + }, + "decision": { + "description": "Whether the current consent scope is permitted or denied access on the requested resource.", + "enum": [ + "CONSENT_DECISION_TYPE_UNSPECIFIED", + "CONSENT_DECISION_TYPE_PERMIT", + "CONSENT_DECISION_TYPE_DENY" + ], + "enumDescriptions": [ + "Unspecified consent decision type.", + "Consent permitted access.", + "Consent denied access." + ], + "type": "string" + }, + "enforcingConsents": { + "description": "Metadata of the consent resources that enforce the consent scope's access.", + "items": { + "$ref": "ExplainDataAccessConsentInfo" + }, + "type": "array" + }, + "exceptions": { + "description": "Other consent scopes that created exceptions within this scope.", + "items": { + "$ref": "ExplainDataAccessConsentScope" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExplainDataAccessResponse": { + "description": "List of consent scopes that are applicable to the explained access on a given resource.", + "id": "ExplainDataAccessResponse", + "properties": { + "consentScopes": { + "description": "List of applicable consent scopes. Sorted in order of actor such that scopes belonging to the same actor will be adjacent to each other in the list.", + "items": { + "$ref": "ExplainDataAccessConsentScope" + }, + "type": "array" + }, + "warning": { + "description": "Warnings associated with this response. It inform user with exceeded scope limit errors.", + "type": "string" + } + }, + "type": "object" + }, "ExportAnnotationsRequest": { "description": "Request to export Annotations. The export operation is not atomic. If a failure occurs, any annotations already exported are not removed.", "id": "ExportAnnotationsRequest", @@ -7303,7 +7475,7 @@ "type": "boolean" }, "enableHistoryModifications": { - "description": "Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Importing resource histories creates resource interactions that have occurred in the past that clients might not allow. If set to false, using history bundles fail with an error.", + "description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error.", "type": "boolean" }, "enableUpdateCreate": { @@ -7947,7 +8119,7 @@ "type": "object" }, "name": { - "description": "Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "description": "Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", "type": "string" }, "notificationConfig": { @@ -8253,7 +8425,7 @@ "properties": { "message": { "$ref": "Message", - "description": "HL7v2 message to ingest." + "description": "Required. HL7v2 message to ingest." } }, "type": "object" @@ -8628,7 +8800,7 @@ "type": "string" }, "data": { - "description": "Raw message bytes.", + "description": "Required. Raw message bytes.", "format": "byte", "type": "string" }, @@ -8644,7 +8816,8 @@ "type": "string" }, "name": { - "description": "Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.", + "description": "Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.", + "readOnly": true, "type": "string" }, "parsedData": { diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index c7a517b7f4..8f4e49c748 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -268,7 +268,7 @@ export namespace healthcare_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -336,7 +336,7 @@ export namespace healthcare_v1 { */ metadata?: {[key: string]: string} | null; /** - * Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation. + * Identifier. Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation. */ name?: string | null; /** @@ -436,7 +436,7 @@ export namespace healthcare_v1 { */ labels?: {[key: string]: string} | null; /** - * Resource name of the consent store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}`. Cannot be changed after creation. + * Identifier. Resource name of the consent store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}`. Cannot be changed after creation. */ name?: string | null; } @@ -445,7 +445,7 @@ export namespace healthcare_v1 { */ export interface Schema$CreateMessageRequest { /** - * HL7v2 message. + * Required. HL7v2 message. */ message?: Schema$Message; } @@ -467,7 +467,7 @@ export namespace healthcare_v1 { */ export interface Schema$Dataset { /** - * Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. + * Identifier. Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string | null; /** @@ -1254,7 +1254,7 @@ export namespace healthcare_v1 { */ labels?: {[key: string]: string} | null; /** - * Resource name of the HL7v2 store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + * Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. */ name?: string | null; /** @@ -1416,7 +1416,7 @@ export namespace healthcare_v1 { */ export interface Schema$IngestMessageRequest { /** - * HL7v2 message to ingest. + * Required. HL7v2 message to ingest. */ message?: Schema$Message; } @@ -1640,7 +1640,7 @@ export namespace healthcare_v1 { */ createTime?: string | null; /** - * Raw message bytes. + * Required. Raw message bytes. */ data?: string | null; /** @@ -1652,7 +1652,7 @@ export namespace healthcare_v1 { */ messageType?: string | null; /** - * Resource name of the Message, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7_v2_store_id\}/messages/{message_id\}`. Assigned by the server. + * Output only. Resource name of the Message, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7_v2_store_id\}/messages/{message_id\}`. Assigned by the server. */ name?: string | null; /** @@ -3386,11 +3386,11 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Create extends StandardParameters { /** - * The ID of the dataset that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. + * Required. The ID of the dataset that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. */ datasetId?: string; /** - * The name of the project where the server creates the dataset. For example, `projects/{project_id\}/locations/{location_id\}`. + * Required. The name of the project where the server creates the dataset. For example, `projects/{project_id\}/locations/{location_id\}`. */ parent?: string; @@ -3414,14 +3414,14 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Delete extends StandardParameters { /** - * The name of the dataset to delete. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. + * Required. The name of the dataset to delete. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Get extends StandardParameters { /** - * The name of the dataset to read. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. + * Required. The name of the dataset to read. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string; } @@ -3447,18 +3447,18 @@ export namespace healthcare_v1 { */ pageToken?: string; /** - * The name of the project whose datasets should be listed. For example, `projects/{project_id\}/locations/{location_id\}`. + * Required. The name of the project whose datasets should be listed. For example, `projects/{project_id\}/locations/{location_id\}`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Datasets$Patch extends StandardParameters { /** - * Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. + * Identifier. Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -4595,7 +4595,7 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Consentstores$Patch extends StandardParameters { /** - * Resource name of the consent store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}`. Cannot be changed after creation. + * Identifier. Resource name of the consent store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}`. Cannot be changed after creation. */ name?: string; /** @@ -6547,7 +6547,7 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Consentstores$Consents$Patch extends StandardParameters { /** - * Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation. + * Identifier. Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation. */ name?: string; /** @@ -14693,11 +14693,11 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create extends StandardParameters { /** - * The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. + * Required. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. */ hl7V2StoreId?: string; /** - * The name of the dataset this HL7v2 store belongs to. + * Required. The name of the dataset this HL7v2 store belongs to. */ parent?: string; @@ -14709,14 +14709,14 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete extends StandardParameters { /** - * The resource name of the HL7v2 store to delete. + * Required. The resource name of the HL7v2 store to delete. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Export extends StandardParameters { /** - * The name of the source HL7v2 store, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}` + * Required. The name of the source HL7v2 store, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}` */ name?: string; @@ -14728,14 +14728,14 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get extends StandardParameters { /** - * The resource name of the HL7v2 store to get. + * Required. The resource name of the HL7v2 store to get. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics extends StandardParameters { /** - * The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + * Required. The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. */ name?: string; } @@ -14753,7 +14753,7 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Import extends StandardParameters { /** - * The name of the target HL7v2 store, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}` + * Required. The name of the target HL7v2 store, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}` */ name?: string; @@ -14777,18 +14777,18 @@ export namespace healthcare_v1 { */ pageToken?: string; /** - * Name of the dataset. + * Required. Name of the dataset. */ parent?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch extends StandardParameters { /** - * Resource name of the HL7v2 store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + * Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -15361,7 +15361,7 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create extends StandardParameters { /** - * The name of the HL7v2 store this message belongs to. + * Required. The name of the HL7v2 store this message belongs to. */ parent?: string; @@ -15373,14 +15373,14 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete extends StandardParameters { /** - * The resource name of the HL7v2 message to delete. + * Required. The resource name of the HL7v2 message to delete. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get extends StandardParameters { /** - * The resource name of the HL7v2 message to retrieve. + * Required. The resource name of the HL7v2 message to retrieve. */ name?: string; /** @@ -15391,7 +15391,7 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest extends StandardParameters { /** - * The name of the HL7v2 store this message belongs to. + * Required. The name of the HL7v2 store this message belongs to. */ parent?: string; @@ -15419,7 +15419,7 @@ export namespace healthcare_v1 { */ pageToken?: string; /** - * Name of the HL7v2 store to retrieve messages from. + * Required. Name of the HL7v2 store to retrieve messages from. */ parent?: string; /** @@ -15430,11 +15430,11 @@ export namespace healthcare_v1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch extends StandardParameters { /** - * Resource name of the Message, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7_v2_store_id\}/messages/{message_id\}`. Assigned by the server. + * Output only. Resource name of the Message, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7_v2_store_id\}/messages/{message_id\}`. Assigned by the server. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index c343c7ab45..6c7012ee5e 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -243,7 +243,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Annotation { /** - * Details of the source. + * Required. Details of the source. */ annotationSource?: Schema$AnnotationSource; /** @@ -255,7 +255,7 @@ export namespace healthcare_v1beta1 { */ imageAnnotation?: Schema$ImageAnnotation; /** - * Resource name of the Annotation, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}/annotations/{annotation_id\}`. + * Identifier. Resource name of the Annotation, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}/annotations/{annotation_id\}`. */ name?: string | null; /** @@ -298,7 +298,7 @@ export namespace healthcare_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Resource name of the Annotation store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. + * Identifier. Resource name of the Annotation store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. */ name?: string | null; } @@ -468,7 +468,7 @@ export namespace healthcare_v1beta1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -613,7 +613,7 @@ export namespace healthcare_v1beta1 { */ metadata?: {[key: string]: string} | null; /** - * Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation. + * Identifier. Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation. */ name?: string | null; /** @@ -641,6 +641,23 @@ export namespace healthcare_v1beta1 { */ userId?: string | null; } + /** + * The accessor scope that describes who can access, for what purpose, in which environment. + */ + export interface Schema$ConsentAccessorScope { + /** + * An individual, group, or access role that identifies the accessor or a characteristic of the accessor. This can be a resource ID (such as `{resourceType\}/{id\}`) or an external URI. This value must be present. + */ + actor?: string | null; + /** + * An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be “*” if it applies to all environments. + */ + environment?: string | null; + /** + * The intent of data use. Can be “*” if it applies to all purposes. + */ + purpose?: string | null; + } /** * Documentation of a user's consent. */ @@ -760,7 +777,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$CreateMessageRequest { /** - * HL7v2 message. + * Required. HL7v2 message. */ message?: Schema$Message; } @@ -786,7 +803,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Dataset { /** - * Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. + * Identifier. Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string | null; /** @@ -1144,7 +1161,7 @@ export namespace healthcare_v1beta1 { */ goldenInfoTypeMapping?: {[key: string]: string} | null; /** - * The Annotation store to use as ground truth, in the format of `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. + * Required. The Annotation store to use as ground truth, in the format of `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. */ goldenStore?: string | null; infoTypeConfig?: Schema$InfoTypeConfig; @@ -1196,6 +1213,73 @@ export namespace healthcare_v1beta1 { */ results?: Schema$Result[]; } + /** + * The enforcing consent's metadata. + */ + export interface Schema$ExplainDataAccessConsentInfo { + /** + * The compartment base resources that matched a cascading policy. Each resource has the following format: `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/{resource_type\}/{resource_id\}` + */ + cascadeOrigins?: string[] | null; + /** + * The resource name of this consent resource. Format: `projects/{projectId\}/datasets/{datasetId\}/fhirStores/{fhirStoreId\}/fhir/{resourceType\}/{id\}`. + */ + consentResource?: string | null; + /** + * Last enforcement timestamp of this consent resource. + */ + enforcementTime?: string | null; + /** + * A list of all the matching accessor scopes of this consent policy that enforced ExplainDataAccessConsentScope.accessor_scope. + */ + matchingAccessorScopes?: Schema$ConsentAccessorScope[]; + /** + * The patient owning the consent (only applicable for patient consents), in the format: `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Patient/{patient_id\}` + */ + patientConsentOwner?: string | null; + /** + * The policy type of consent resource (e.g. PATIENT, ADMIN). + */ + type?: string | null; + /** + * The consent's variant combinations. A single consent may have multiple variants. + */ + variants?: string[] | null; + } + /** + * A single consent scope that provides info on who has access to the requested resource scope for a particular purpose and environment, enforced by which consent. + */ + export interface Schema$ExplainDataAccessConsentScope { + /** + * The accessor scope that describes who can access, for what purpose, and in which environment. + */ + accessorScope?: Schema$ConsentAccessorScope; + /** + * Whether the current consent scope is permitted or denied access on the requested resource. + */ + decision?: string | null; + /** + * Metadata of the consent resources that enforce the consent scope's access. + */ + enforcingConsents?: Schema$ExplainDataAccessConsentInfo[]; + /** + * Other consent scopes that created exceptions within this scope. + */ + exceptions?: Schema$ExplainDataAccessConsentScope[]; + } + /** + * List of consent scopes that are applicable to the explained access on a given resource. + */ + export interface Schema$ExplainDataAccessResponse { + /** + * List of applicable consent scopes. Sorted in order of actor such that scopes belonging to the same actor will be adjacent to each other in the list. + */ + consentScopes?: Schema$ExplainDataAccessConsentScope[]; + /** + * Warnings associated with this response. It inform user with exceeded scope limit errors. + */ + warning?: string | null; + } /** * Request to export Annotations. The export operation is not atomic. If a failure occurs, any annotations already exported are not removed. */ @@ -1408,7 +1492,7 @@ export namespace healthcare_v1beta1 { */ disableResourceVersioning?: boolean | null; /** - * Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Importing resource histories creates resource interactions that have occurred in the past that clients might not allow. If set to false, using history bundles fail with an error. + * Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. */ enableHistoryModifications?: boolean | null; /** @@ -1846,7 +1930,7 @@ export namespace healthcare_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Resource name of the HL7v2 store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + * Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. */ name?: string | null; /** @@ -2054,7 +2138,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$IngestMessageRequest { /** - * HL7v2 message to ingest. + * Required. HL7v2 message to ingest. */ message?: Schema$Message; } @@ -2316,7 +2400,7 @@ export namespace healthcare_v1beta1 { */ createTime?: string | null; /** - * Raw message bytes. + * Required. Raw message bytes. */ data?: string | null; /** @@ -2328,7 +2412,7 @@ export namespace healthcare_v1beta1 { */ messageType?: string | null; /** - * Resource name of the Message, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7_v2_store_id\}/messages/{message_id\}`. Assigned by the server. + * Output only. Resource name of the Message, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7_v2_store_id\}/messages/{message_id\}`. Assigned by the server. */ name?: string | null; /** @@ -4241,11 +4325,11 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Create extends StandardParameters { /** - * The ID of the dataset that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. + * Required. The ID of the dataset that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. */ datasetId?: string; /** - * The name of the project where the server creates the dataset. For example, `projects/{project_id\}/locations/{location_id\}`. + * Required. The name of the project where the server creates the dataset. For example, `projects/{project_id\}/locations/{location_id\}`. */ parent?: string; @@ -4269,14 +4353,14 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Delete extends StandardParameters { /** - * The name of the dataset to delete. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. + * Required. The name of the dataset to delete. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Get extends StandardParameters { /** - * The name of the dataset to read. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. + * Required. The name of the dataset to read. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string; } @@ -4302,18 +4386,18 @@ export namespace healthcare_v1beta1 { */ pageToken?: string; /** - * The name of the project whose datasets should be listed. For example, `projects/{project_id\}/locations/{location_id\}`. + * Required. The name of the project whose datasets should be listed. For example, `projects/{project_id\}/locations/{location_id\}`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Datasets$Patch extends StandardParameters { /** - * Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. + * Identifier. Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -5337,11 +5421,11 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Create extends StandardParameters { /** - * The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. + * Required. The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. */ annotationStoreId?: string; /** - * The name of the dataset this Annotation store belongs to. + * Required. The name of the dataset this Annotation store belongs to. */ parent?: string; @@ -5353,14 +5437,14 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete extends StandardParameters { /** - * The resource name of the Annotation store to delete. + * Required. The resource name of the Annotation store to delete. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Evaluate extends StandardParameters { /** - * The Annotation store to compare against `golden_store`, in the format of `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. + * Required. The Annotation store to compare against `golden_store`, in the format of `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. */ name?: string; @@ -5372,7 +5456,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Export extends StandardParameters { /** - * The name of the Annotation store to export annotations to, in the format of `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. + * Required. The name of the Annotation store to export annotations to, in the format of `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. */ name?: string; @@ -5384,7 +5468,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Get extends StandardParameters { /** - * The resource name of the Annotation store to get. + * Required. The resource name of the Annotation store to get. */ name?: string; } @@ -5402,7 +5486,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Import extends StandardParameters { /** - * The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. + * Required. The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. */ name?: string; @@ -5426,18 +5510,18 @@ export namespace healthcare_v1beta1 { */ pageToken?: string; /** - * Name of the dataset. + * Required. Name of the dataset. */ parent?: string; } export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch extends StandardParameters { /** - * Resource name of the Annotation store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. + * Identifier. Resource name of the Annotation store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -5917,7 +6001,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create extends StandardParameters { /** - * The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. + * Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. */ parent?: string; @@ -5929,14 +6013,14 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete extends StandardParameters { /** - * The resource name of the Annotation to delete. + * Required. The resource name of the Annotation to delete. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get extends StandardParameters { /** - * The resource name of the Annotation to retrieve. + * Required. The resource name of the Annotation to retrieve. */ name?: string; } @@ -5955,7 +6039,7 @@ export namespace healthcare_v1beta1 { */ pageToken?: string; /** - * Name of the Annotation store to retrieve Annotations from. + * Required. Name of the Annotation store to retrieve Annotations from. */ parent?: string; /** @@ -5966,11 +6050,11 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch extends StandardParameters { /** - * Resource name of the Annotation, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}/annotations/{annotation_id\}`. + * Identifier. Resource name of the Annotation, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/annotationStores/{annotation_store_id\}/annotations/{annotation_id\}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -9039,7 +9123,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Consentstores$Consents$Patch extends StandardParameters { /** - * Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation. + * Identifier. Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation. */ name?: string; /** @@ -14118,6 +14202,101 @@ export namespace healthcare_v1beta1 { } } + /** + * Explains all the permitted/denied actor, purpose and environment for 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. + */ + explainDataAccess( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess, + options: StreamMethodOptions + ): GaxiosPromise; + explainDataAccess( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess, + options?: MethodOptions + ): GaxiosPromise; + explainDataAccess( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + explainDataAccess( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + explainDataAccess( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess, + callback: BodyResponseCallback + ): void; + explainDataAccess( + callback: BodyResponseCallback + ): void; + explainDataAccess( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:explainDataAccess').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 resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @@ -15078,6 +15257,17 @@ export namespace healthcare_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Explaindataaccess + extends StandardParameters { + /** + * Required. The name of the FHIR store to enforce, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}`. + */ + name?: string; + /** + * Required. The ID (`{resourceType\}/{id\}`) of the resource to explain data access on. + */ + resourceId?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Export extends StandardParameters { /** @@ -18547,11 +18737,11 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create extends StandardParameters { /** - * The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. + * Required. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L\}\p{N\}_\-\.]{1,256\}`. */ hl7V2StoreId?: string; /** - * The name of the dataset this HL7v2 store belongs to. + * Required. The name of the dataset this HL7v2 store belongs to. */ parent?: string; @@ -18563,14 +18753,14 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete extends StandardParameters { /** - * The resource name of the HL7v2 store to delete. + * Required. The resource name of the HL7v2 store to delete. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Export extends StandardParameters { /** - * The name of the source HL7v2 store, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}` + * Required. The name of the source HL7v2 store, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}` */ name?: string; @@ -18582,14 +18772,14 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get extends StandardParameters { /** - * The resource name of the HL7v2 store to get. + * Required. The resource name of the HL7v2 store to get. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics extends StandardParameters { /** - * The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + * Required. The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. */ name?: string; } @@ -18607,7 +18797,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Import extends StandardParameters { /** - * The name of the target HL7v2 store, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}` + * Required. The name of the target HL7v2 store, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}` */ name?: string; @@ -18631,18 +18821,18 @@ export namespace healthcare_v1beta1 { */ pageToken?: string; /** - * Name of the dataset. + * Required. Name of the dataset. */ parent?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch extends StandardParameters { /** - * Resource name of the HL7v2 store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + * Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -19314,7 +19504,7 @@ export namespace healthcare_v1beta1 { */ ids?: string[]; /** - * Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}`. + * Required. Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7v2Stores/{hl7v2_store_id\}`. */ parent?: string; /** @@ -19325,7 +19515,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create extends StandardParameters { /** - * The name of the HL7v2 store this message belongs to. + * Required. The name of the HL7v2 store this message belongs to. */ parent?: string; @@ -19337,14 +19527,14 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete extends StandardParameters { /** - * The resource name of the HL7v2 message to delete. + * Required. The resource name of the HL7v2 message to delete. */ name?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get extends StandardParameters { /** - * The resource name of the HL7v2 message to retrieve. + * Required. The resource name of the HL7v2 message to retrieve. */ name?: string; /** @@ -19355,7 +19545,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest extends StandardParameters { /** - * The name of the HL7v2 store this message belongs to. + * Required. The name of the HL7v2 store this message belongs to. */ parent?: string; @@ -19383,7 +19573,7 @@ export namespace healthcare_v1beta1 { */ pageToken?: string; /** - * Name of the HL7v2 store to retrieve messages from. + * Required. Name of the HL7v2 store to retrieve messages from. */ parent?: string; /** @@ -19394,11 +19584,11 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch extends StandardParameters { /** - * Resource name of the Message, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7_v2_store_id\}/messages/{message_id\}`. Assigned by the server. + * Output only. Resource name of the Message, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7_v2_store_id\}/messages/{message_id\}`. Assigned by the server. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; From 60bd08a9e2019d9575d27a165456089bfef129fc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:17 +0000 Subject: [PATCH 21/43] fix(monitoring): update the API #### monitoring:v3 The following keys were changed: - schemas.MetricThreshold.properties.evaluationMissingData.description --- discovery/monitoring-v3.json | 4 ++-- src/apis/monitoring/v3.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index a0418b2b06..d5d5fce145 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -2714,7 +2714,7 @@ } } }, - "revision": "20231220", + "revision": "20240128", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -4663,7 +4663,7 @@ "type": "string" }, "evaluationMissingData": { - "description": "A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.", + "description": "A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the duration field must be greater than or equal to 60 seconds.", "enum": [ "EVALUATION_MISSING_DATA_UNSPECIFIED", "EVALUATION_MISSING_DATA_INACTIVE", diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 3841b58c66..a3f75f2df6 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -1425,7 +1425,7 @@ export namespace monitoring_v3 { */ duration?: string | null; /** - * A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. + * A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the duration field must be greater than or equal to 60 seconds. */ evaluationMissingData?: string | null; /** From 904e24080b53357c92dc138ef2f1bc7810781fda Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:17 +0000 Subject: [PATCH 22/43] feat(networkmanagement): update the API #### networkmanagement:v1beta1 The following keys were added: - schemas.LoadBalancerBackendInfo.properties.backendBucketUri.description - schemas.LoadBalancerBackendInfo.properties.backendBucketUri.type - schemas.LoadBalancerBackendInfo.properties.pscGoogleApiTarget.description - schemas.LoadBalancerBackendInfo.properties.pscGoogleApiTarget.type - schemas.LoadBalancerBackendInfo.properties.pscServiceAttachmentUri.description - schemas.LoadBalancerBackendInfo.properties.pscServiceAttachmentUri.type - schemas.Step.properties.loadBalancer.deprecated - schemas.Step.properties.state.enumDeprecated The following keys were changed: - schemas.Binding.properties.role.description - schemas.DropInfo.properties.cause.enum - schemas.DropInfo.properties.cause.enumDescriptions - schemas.Step.properties.loadBalancer.description - schemas.Step.properties.state.enumDescriptions #### networkmanagement:v1 The following keys were added: - schemas.LoadBalancerBackendInfo.properties.backendBucketUri.description - schemas.LoadBalancerBackendInfo.properties.backendBucketUri.type - schemas.LoadBalancerBackendInfo.properties.pscGoogleApiTarget.description - schemas.LoadBalancerBackendInfo.properties.pscGoogleApiTarget.type - schemas.LoadBalancerBackendInfo.properties.pscServiceAttachmentUri.description - schemas.LoadBalancerBackendInfo.properties.pscServiceAttachmentUri.type - schemas.Step.properties.loadBalancer.deprecated - schemas.Step.properties.state.enumDeprecated The following keys were changed: - schemas.Binding.properties.role.description - schemas.DropInfo.properties.cause.enum - schemas.DropInfo.properties.cause.enumDescriptions - schemas.Step.properties.loadBalancer.description --- discovery/networkmanagement-v1.json | 54 ++++++++++++++++++++-- discovery/networkmanagement-v1beta1.json | 58 ++++++++++++++++++++++-- src/apis/networkmanagement/v1.ts | 16 ++++++- src/apis/networkmanagement/v1beta1.ts | 16 ++++++- 4 files changed, 132 insertions(+), 12 deletions(-) diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index 8c83565dbc..e2f5c73596 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240117", + "revision": "20240124", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -764,7 +764,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`.", + "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" } }, @@ -1050,6 +1050,7 @@ "PSC_CONNECTION_NOT_ACCEPTED", "PSC_ENDPOINT_ACCESSED_FROM_PEERED_NETWORK", "PSC_NEG_PRODUCER_ENDPOINT_NO_GLOBAL_ACCESS", + "PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS", "CLOUD_RUN_REVISION_NOT_READY", "DROPPED_INSIDE_PSC_SERVICE_PRODUCER", "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", @@ -1106,6 +1107,7 @@ "The Private Service Connect endpoint is in a project that is not approved to connect to the service.", "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.", "Packet sent from a Cloud Run revision that is not ready.", "Packet was dropped inside Private Service Connect service producer.", "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", @@ -1734,6 +1736,10 @@ "description": "For display only. Metadata associated with the load balancer backend.", "id": "LoadBalancerBackendInfo", "properties": { + "backendBucketUri": { + "description": "URI of the backend bucket this backend targets (if applicable).", + "type": "string" + }, "backendServiceUri": { "description": "URI of the backend service this backend belongs to (if applicable).", "type": "string" @@ -1776,6 +1782,14 @@ "networkEndpointGroupUri": { "description": "URI of the network endpoint group this backend belongs to (if applicable).", "type": "string" + }, + "pscGoogleApiTarget": { + "description": "PSC Google API target this PSC NEG backend targets (if applicable).", + "type": "string" + }, + "pscServiceAttachmentUri": { + "description": "URI of the PSC service attachment this PSC NEG backend targets (if applicable).", + "type": "string" } }, "type": "object" @@ -2501,7 +2515,8 @@ }, "loadBalancer": { "$ref": "LoadBalancerInfo", - "description": "Display information of the load balancers." + "deprecated": true, + "description": "Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests." }, "loadBalancerBackendInfo": { "$ref": "LoadBalancerBackendInfo", @@ -2562,6 +2577,39 @@ "ABORT", "VIEWER_PERMISSION_MISSING" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Unspecified state.", "Initial state: packet originating from a Compute Engine instance. An InstanceInfo is populated with starting instance information.", diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index 97d1e2d497..95b76f76d7 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240117", + "revision": "20240124", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -764,7 +764,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`.", + "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" } }, @@ -1055,6 +1055,7 @@ "PSC_CONNECTION_NOT_ACCEPTED", "PSC_ENDPOINT_ACCESSED_FROM_PEERED_NETWORK", "PSC_NEG_PRODUCER_ENDPOINT_NO_GLOBAL_ACCESS", + "PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS", "CLOUD_RUN_REVISION_NOT_READY", "DROPPED_INSIDE_PSC_SERVICE_PRODUCER", "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", @@ -1111,6 +1112,7 @@ "The Private Service Connect endpoint is in a project that is not approved to connect to the service.", "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.", "Packet sent from a Cloud Run revision that is not ready.", "Packet was dropped inside Private Service Connect service producer.", "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", @@ -1739,6 +1741,10 @@ "description": "For display only. Metadata associated with the load balancer backend.", "id": "LoadBalancerBackendInfo", "properties": { + "backendBucketUri": { + "description": "URI of the backend bucket this backend targets (if applicable).", + "type": "string" + }, "backendServiceUri": { "description": "URI of the backend service this backend belongs to (if applicable).", "type": "string" @@ -1781,6 +1787,14 @@ "networkEndpointGroupUri": { "description": "URI of the network endpoint group this backend belongs to (if applicable).", "type": "string" + }, + "pscGoogleApiTarget": { + "description": "PSC Google API target this PSC NEG backend targets (if applicable).", + "type": "string" + }, + "pscServiceAttachmentUri": { + "description": "URI of the PSC service attachment this PSC NEG backend targets (if applicable).", + "type": "string" } }, "type": "object" @@ -2506,7 +2520,8 @@ }, "loadBalancer": { "$ref": "LoadBalancerInfo", - "description": "Display information of the load balancers." + "deprecated": true, + "description": "Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests." }, "loadBalancerBackendInfo": { "$ref": "LoadBalancerBackendInfo", @@ -2567,6 +2582,39 @@ "ABORT", "VIEWER_PERMISSION_MISSING" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Unspecified state.", "Initial state: packet originating from a Compute Engine instance. An InstanceInfo is populated with starting instance information.", @@ -2587,8 +2635,8 @@ "Config checking state: verify load balancer backend configuration.", "Config checking state: packet sent or received under foreign IP address and allowed.", "Forwarding state: arriving at a Compute Engine instance.", - "Forwarding state: arriving at a Compute Engine internal load balancer.", - "Forwarding state: arriving at a Compute Engine external load balancer.", + "Forwarding state: arriving at a Compute Engine internal load balancer. Deprecated in favor of the `ANALYZE_LOAD_BALANCER_BACKEND` state, not used in new tests.", + "Forwarding state: arriving at a Compute Engine external load balancer. Deprecated in favor of the `ANALYZE_LOAD_BALANCER_BACKEND` state, not used in new tests.", "Forwarding state: arriving at a Cloud VPN gateway.", "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at a VPC connector.", diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index 816eefdedb..37a4ec72e1 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -210,7 +210,7 @@ export namespace networkmanagement_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -790,6 +790,10 @@ export namespace networkmanagement_v1 { * For display only. Metadata associated with the load balancer backend. */ export interface Schema$LoadBalancerBackendInfo { + /** + * URI of the backend bucket this backend targets (if applicable). + */ + backendBucketUri?: string | null; /** * URI of the backend service this backend belongs to (if applicable). */ @@ -818,6 +822,14 @@ export namespace networkmanagement_v1 { * URI of the network endpoint group this backend belongs to (if applicable). */ networkEndpointGroupUri?: string | null; + /** + * PSC Google API target this PSC NEG backend targets (if applicable). + */ + pscGoogleApiTarget?: string | null; + /** + * URI of the PSC service attachment this PSC NEG backend targets (if applicable). + */ + pscServiceAttachmentUri?: string | null; } /** * For display only. Metadata associated with a load balancer. @@ -1305,7 +1317,7 @@ export namespace networkmanagement_v1 { */ instance?: Schema$InstanceInfo; /** - * Display information of the load balancers. + * Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. */ loadBalancer?: Schema$LoadBalancerInfo; /** diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index eb77514336..d8f0868b58 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -210,7 +210,7 @@ export namespace networkmanagement_v1beta1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -794,6 +794,10 @@ export namespace networkmanagement_v1beta1 { * For display only. Metadata associated with the load balancer backend. */ export interface Schema$LoadBalancerBackendInfo { + /** + * URI of the backend bucket this backend targets (if applicable). + */ + backendBucketUri?: string | null; /** * URI of the backend service this backend belongs to (if applicable). */ @@ -822,6 +826,14 @@ export namespace networkmanagement_v1beta1 { * URI of the network endpoint group this backend belongs to (if applicable). */ networkEndpointGroupUri?: string | null; + /** + * PSC Google API target this PSC NEG backend targets (if applicable). + */ + pscGoogleApiTarget?: string | null; + /** + * URI of the PSC service attachment this PSC NEG backend targets (if applicable). + */ + pscServiceAttachmentUri?: string | null; } /** * For display only. Metadata associated with a load balancer. @@ -1309,7 +1321,7 @@ export namespace networkmanagement_v1beta1 { */ instance?: Schema$InstanceInfo; /** - * Display information of the load balancers. + * Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. */ loadBalancer?: Schema$LoadBalancerInfo; /** From a7952efaa312093fa731772686ee8fd5a94c068b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:17 +0000 Subject: [PATCH 23/43] feat(networksecurity): update the API #### networksecurity:v1beta1 The following keys were added: - schemas.ListAddressGroupReferencesResponseAddressGroupReference.properties.securityPolicy.description - schemas.ListAddressGroupReferencesResponseAddressGroupReference.properties.securityPolicy.type The following keys were changed: - schemas.GoogleIamV1Binding.properties.role.description #### networksecurity:v1 The following keys were added: - schemas.ListAddressGroupReferencesResponseAddressGroupReference.properties.securityPolicy.description - schemas.ListAddressGroupReferencesResponseAddressGroupReference.properties.securityPolicy.type The following keys were changed: - schemas.GoogleIamV1Binding.properties.role.description --- discovery/networksecurity-v1.json | 8 ++++++-- discovery/networksecurity-v1beta1.json | 8 ++++++-- src/apis/networksecurity/v1.ts | 6 +++++- src/apis/networksecurity/v1beta1.ts | 6 +++++- 4 files changed, 22 insertions(+), 6 deletions(-) diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index 1a8b170c2a..24a51fcecb 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -2474,7 +2474,7 @@ } } }, - "revision": "20240102", + "revision": "20240130", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -2941,7 +2941,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`.", + "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" } }, @@ -3067,6 +3067,10 @@ "description": "Rule priority of the FirewallPolicy that is using the Address Group.", "format": "int32", "type": "integer" + }, + "securityPolicy": { + "description": "Cloud Armor SecurityPolicy that is using the Address Group.", + "type": "string" } }, "type": "object" diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 5227220bcb..edbba06118 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -3162,7 +3162,7 @@ } } }, - "revision": "20240102", + "revision": "20240130", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3791,7 +3791,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`.", + "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" } }, @@ -3917,6 +3917,10 @@ "description": "Rule priority of the FirewallPolicy that is using the Address Group.", "format": "int32", "type": "integer" + }, + "securityPolicy": { + "description": "Cloud Armor SecurityPolicy that is using the Address Group.", + "type": "string" } }, "type": "object" diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index 8ab067e951..b124194c81 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -453,7 +453,7 @@ export namespace networksecurity_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -547,6 +547,10 @@ export namespace networksecurity_v1 { * Rule priority of the FirewallPolicy that is using the Address Group. */ rulePriority?: number | null; + /** + * Cloud Armor SecurityPolicy that is using the Address Group. + */ + securityPolicy?: string | null; } /** * Response returned by the ListAddressGroups method. diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index fc0569a1b5..8e8fa3a1b7 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -552,7 +552,7 @@ export namespace networksecurity_v1beta1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -646,6 +646,10 @@ export namespace networksecurity_v1beta1 { * Rule priority of the FirewallPolicy that is using the Address Group. */ rulePriority?: number | null; + /** + * Cloud Armor SecurityPolicy that is using the Address Group. + */ + securityPolicy?: string | null; } /** * Response returned by the ListAddressGroups method. From 1db7f06b2e2fa80d5e21de1fcc131940afea2f36 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:17 +0000 Subject: [PATCH 24/43] fix(networkservices): update the API #### networkservices:v1beta1 The following keys were changed: - schemas.Gateway.description #### networkservices:v1 The following keys were changed: - schemas.Gateway.description --- discovery/networkservices-v1.json | 4 ++-- discovery/networkservices-v1beta1.json | 4 ++-- src/apis/networkservices/v1.ts | 2 +- src/apis/networkservices/v1beta1.ts | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index ce2953f0bf..58b6ba97fc 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -2148,7 +2148,7 @@ } } }, - "revision": "20240118", + "revision": "20240125", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2379,7 +2379,7 @@ "type": "object" }, "Gateway": { - "description": "Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. Next id: 29", + "description": "Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. Next id: 30", "id": "Gateway", "properties": { "addresses": { diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 9d5e3fe78a..57555a13a8 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -2483,7 +2483,7 @@ } } }, - "revision": "20240118", + "revision": "20240125", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2760,7 +2760,7 @@ "type": "object" }, "Gateway": { - "description": "Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. Next id: 29", + "description": "Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. Next id: 30", "id": "Gateway", "properties": { "addresses": { diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index eb85c36d4b..f9b01318f7 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -281,7 +281,7 @@ export namespace networkservices_v1 { title?: string | null; } /** - * Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. Next id: 29 + * Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. Next id: 30 */ export interface Schema$Gateway { /** diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 3a65f099a0..5f117bfbce 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -314,7 +314,7 @@ export namespace networkservices_v1beta1 { celExpression?: string | null; } /** - * Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. Next id: 29 + * Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. Next id: 30 */ export interface Schema$Gateway { /** From bf74fcd6cf43f584a968e66382cd2368f01747dd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:17 +0000 Subject: [PATCH 25/43] fix(notebooks): update the API #### notebooks:v2 The following keys were changed: - schemas.Binding.properties.role.description --- discovery/notebooks-v2.json | 4 ++-- src/apis/notebooks/v2.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index b682b714ef..d80ced47f2 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -876,7 +876,7 @@ } } }, - "revision": "20231227", + "revision": "20240118", "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`.", + "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" } }, diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index 0c4727dac3..4634ef758a 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`. + * 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; } From aa11769174eea0a09d2673fb11b32a94eb6c329d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:17 +0000 Subject: [PATCH 26/43] fix(paymentsresellersubscription): update the API #### paymentsresellersubscription:v1 The following keys were changed: - schemas.GoogleCloudPaymentsResellerSubscriptionV1Subscription.description --- discovery/paymentsresellersubscription-v1.json | 4 ++-- src/apis/paymentsresellersubscription/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/paymentsresellersubscription-v1.json b/discovery/paymentsresellersubscription-v1.json index 0011495d99..3d7b48d26d 100644 --- a/discovery/paymentsresellersubscription-v1.json +++ b/discovery/paymentsresellersubscription-v1.json @@ -435,7 +435,7 @@ } } }, - "revision": "20240131", + "revision": "20240205", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { @@ -1018,7 +1018,7 @@ "type": "object" }, "GoogleCloudPaymentsResellerSubscriptionV1Subscription": { - "description": "A Subscription resource managed by 3P Partners.", + "description": "A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy.", "id": "GoogleCloudPaymentsResellerSubscriptionV1Subscription", "properties": { "cancellationDetails": { diff --git a/src/apis/paymentsresellersubscription/v1.ts b/src/apis/paymentsresellersubscription/v1.ts index 80398c9d98..ff7eaa51f5 100644 --- a/src/apis/paymentsresellersubscription/v1.ts +++ b/src/apis/paymentsresellersubscription/v1.ts @@ -481,7 +481,7 @@ export namespace paymentsresellersubscription_v1 { startTime?: string | null; } /** - * A Subscription resource managed by 3P Partners. + * A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. */ export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1Subscription { /** From cf6354cfd2e4ec62ec3376381b6fe8020ce2e20d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:18 +0000 Subject: [PATCH 27/43] fix(playdeveloperreporting): update the API #### playdeveloperreporting:v1alpha1 The following keys were changed: - schemas.GooglePlayDeveloperReportingV1alpha1ErrorIssue.properties.name.description - schemas.GooglePlayDeveloperReportingV1alpha1ErrorReport.properties.name.description #### playdeveloperreporting:v1beta1 The following keys were changed: - schemas.GooglePlayDeveloperReportingV1beta1ErrorIssue.properties.name.description - schemas.GooglePlayDeveloperReportingV1beta1ErrorReport.properties.name.description --- discovery/playdeveloperreporting-v1alpha1.json | 6 +++--- discovery/playdeveloperreporting-v1beta1.json | 6 +++--- src/apis/playdeveloperreporting/v1alpha1.ts | 4 ++-- src/apis/playdeveloperreporting/v1beta1.ts | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/discovery/playdeveloperreporting-v1alpha1.json b/discovery/playdeveloperreporting-v1alpha1.json index dccf3586fb..c96a288adb 100644 --- a/discovery/playdeveloperreporting-v1alpha1.json +++ b/discovery/playdeveloperreporting-v1alpha1.json @@ -941,7 +941,7 @@ } } }, - "revision": "20240103", + "revision": "20240205", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { @@ -1175,7 +1175,7 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the issue. Format: apps/{app}/errorIssues/{issue}", + "description": "Identifier. The resource name of the issue. Format: apps/{app}/{issue}", "type": "string" }, "type": { @@ -1217,7 +1217,7 @@ "type": "string" }, "name": { - "description": "The resource name of the report. Format: apps/{app}/errorReports/{report}", + "description": "The resource name of the report. Format: apps/{app}/{report}", "type": "string" }, "osVersion": { diff --git a/discovery/playdeveloperreporting-v1beta1.json b/discovery/playdeveloperreporting-v1beta1.json index daa3c18ec4..9649390c56 100644 --- a/discovery/playdeveloperreporting-v1beta1.json +++ b/discovery/playdeveloperreporting-v1beta1.json @@ -941,7 +941,7 @@ } } }, - "revision": "20240103", + "revision": "20240205", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { @@ -1175,7 +1175,7 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the issue. Format: apps/{app}/errorIssues/{issue}", + "description": "Identifier. The resource name of the issue. Format: apps/{app}/{issue}", "type": "string" }, "type": { @@ -1217,7 +1217,7 @@ "type": "string" }, "name": { - "description": "The resource name of the report. Format: apps/{app}/errorReports/{report}", + "description": "The resource name of the report. Format: apps/{app}/{report}", "type": "string" }, "osVersion": { diff --git a/src/apis/playdeveloperreporting/v1alpha1.ts b/src/apis/playdeveloperreporting/v1alpha1.ts index cc86aaecdd..6c1940f211 100644 --- a/src/apis/playdeveloperreporting/v1alpha1.ts +++ b/src/apis/playdeveloperreporting/v1alpha1.ts @@ -331,7 +331,7 @@ export namespace playdeveloperreporting_v1alpha1 { */ location?: string | null; /** - * Identifier. The resource name of the issue. Format: apps/{app\}/errorIssues/{issue\} + * Identifier. The resource name of the issue. Format: apps/{app\}/{issue\} */ name?: string | null; /** @@ -360,7 +360,7 @@ export namespace playdeveloperreporting_v1alpha1 { */ issue?: string | null; /** - * The resource name of the report. Format: apps/{app\}/errorReports/{report\} + * The resource name of the report. Format: apps/{app\}/{report\} */ name?: string | null; /** diff --git a/src/apis/playdeveloperreporting/v1beta1.ts b/src/apis/playdeveloperreporting/v1beta1.ts index 90fee5260b..9b3ccaf6dd 100644 --- a/src/apis/playdeveloperreporting/v1beta1.ts +++ b/src/apis/playdeveloperreporting/v1beta1.ts @@ -331,7 +331,7 @@ export namespace playdeveloperreporting_v1beta1 { */ location?: string | null; /** - * Identifier. The resource name of the issue. Format: apps/{app\}/errorIssues/{issue\} + * Identifier. The resource name of the issue. Format: apps/{app\}/{issue\} */ name?: string | null; /** @@ -360,7 +360,7 @@ export namespace playdeveloperreporting_v1beta1 { */ issue?: string | null; /** - * The resource name of the report. Format: apps/{app\}/errorReports/{report\} + * The resource name of the report. Format: apps/{app\}/{report\} */ name?: string | null; /** From f3ac40bb4cf2cc159cb5b3f20e1ed3ccd105a3e6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:18 +0000 Subject: [PATCH 28/43] fix(privateca): update the API #### privateca:v1beta1 The following keys were changed: - schemas.Binding.properties.role.description #### privateca:v1 The following keys were changed: - schemas.Binding.properties.role.description --- discovery/privateca-v1.json | 4 ++-- discovery/privateca-v1beta1.json | 4 ++-- src/apis/privateca/v1.ts | 2 +- src/apis/privateca/v1beta1.ts | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/discovery/privateca-v1.json b/discovery/privateca-v1.json index 097a7bb344..c4b83e9089 100644 --- a/discovery/privateca-v1.json +++ b/discovery/privateca-v1.json @@ -1605,7 +1605,7 @@ } } }, - "revision": "20240117", + "revision": "20240129", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -1724,7 +1724,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`.", + "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" } }, diff --git a/discovery/privateca-v1beta1.json b/discovery/privateca-v1beta1.json index 396d0e0311..ebdc36d17e 100644 --- a/discovery/privateca-v1beta1.json +++ b/discovery/privateca-v1beta1.json @@ -580,7 +580,7 @@ } } }, - "revision": "20240117", + "revision": "20240129", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { @@ -647,7 +647,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`.", + "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" } }, diff --git a/src/apis/privateca/v1.ts b/src/apis/privateca/v1.ts index f673bb3cef..2a206c7f55 100644 --- a/src/apis/privateca/v1.ts +++ b/src/apis/privateca/v1.ts @@ -206,7 +206,7 @@ export namespace privateca_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } diff --git a/src/apis/privateca/v1beta1.ts b/src/apis/privateca/v1beta1.ts index 470793f5a6..54e8a2cffd 100644 --- a/src/apis/privateca/v1beta1.ts +++ b/src/apis/privateca/v1beta1.ts @@ -163,7 +163,7 @@ export namespace privateca_v1beta1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } From d077ee547c4d2655f451909538e73bf8ac8b8edc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:18 +0000 Subject: [PATCH 29/43] feat(retail): update the API #### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2BigQueryOutputResult.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.id - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.datasetId.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.datasetId.type - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.tableId.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.tableId.type - schemas.GoogleCloudRetailV2BigQueryOutputResult.type - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.id - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.type - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorsConfig.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorsConfig.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.outputResult.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.outputResult.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.type - schemas.GoogleCloudRetailV2ExportErrorsConfig.description - schemas.GoogleCloudRetailV2ExportErrorsConfig.id - schemas.GoogleCloudRetailV2ExportErrorsConfig.properties.gcsPrefix.description - schemas.GoogleCloudRetailV2ExportErrorsConfig.properties.gcsPrefix.type - schemas.GoogleCloudRetailV2ExportErrorsConfig.type - schemas.GoogleCloudRetailV2GcsOutputResult.description - schemas.GoogleCloudRetailV2GcsOutputResult.id - schemas.GoogleCloudRetailV2GcsOutputResult.properties.outputUri.description - schemas.GoogleCloudRetailV2GcsOutputResult.properties.outputUri.type - schemas.GoogleCloudRetailV2GcsOutputResult.type - schemas.GoogleCloudRetailV2OutputResult.description - schemas.GoogleCloudRetailV2OutputResult.id - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.description - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.items.$ref - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.type - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.description - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.items.$ref - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.type - schemas.GoogleCloudRetailV2OutputResult.type #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2BigQueryOutputResult.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.id - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.datasetId.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.datasetId.type - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.tableId.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.tableId.type - schemas.GoogleCloudRetailV2BigQueryOutputResult.type - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.id - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.type - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorsConfig.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorsConfig.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.outputResult.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.outputResult.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.type - schemas.GoogleCloudRetailV2ExportErrorsConfig.description - schemas.GoogleCloudRetailV2ExportErrorsConfig.id - schemas.GoogleCloudRetailV2ExportErrorsConfig.properties.gcsPrefix.description - schemas.GoogleCloudRetailV2ExportErrorsConfig.properties.gcsPrefix.type - schemas.GoogleCloudRetailV2ExportErrorsConfig.type - schemas.GoogleCloudRetailV2GcsOutputResult.description - schemas.GoogleCloudRetailV2GcsOutputResult.id - schemas.GoogleCloudRetailV2GcsOutputResult.properties.outputUri.description - schemas.GoogleCloudRetailV2GcsOutputResult.properties.outputUri.type - schemas.GoogleCloudRetailV2GcsOutputResult.type - schemas.GoogleCloudRetailV2OutputResult.description - schemas.GoogleCloudRetailV2OutputResult.id - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.description - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.items.$ref - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.type - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.description - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.items.$ref - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.type - schemas.GoogleCloudRetailV2OutputResult.type #### retail:v2 The following keys were added: - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.description - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.flatPath - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.httpMethod - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.id - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.parameterOrder - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.parameters.catalog.description - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.parameters.catalog.location - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.parameters.catalog.pattern - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.parameters.catalog.required - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.parameters.catalog.type - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.path - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.request.$ref - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.response.$ref - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics.scopes - schemas.GoogleCloudRetailV2BigQueryOutputResult.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.id - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.datasetId.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.datasetId.type - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.tableId.description - schemas.GoogleCloudRetailV2BigQueryOutputResult.properties.tableId.type - schemas.GoogleCloudRetailV2BigQueryOutputResult.type - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsRequest.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsRequest.id - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsRequest.properties.filter.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsRequest.properties.filter.type - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsRequest.properties.outputConfig.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsRequest.properties.outputConfig.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsRequest.type - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.id - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorSamples.type - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorsConfig.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.errorsConfig.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.outputResult.$ref - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.properties.outputResult.description - schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse.type - schemas.GoogleCloudRetailV2ExportErrorsConfig.description - schemas.GoogleCloudRetailV2ExportErrorsConfig.id - schemas.GoogleCloudRetailV2ExportErrorsConfig.properties.gcsPrefix.description - schemas.GoogleCloudRetailV2ExportErrorsConfig.properties.gcsPrefix.type - schemas.GoogleCloudRetailV2ExportErrorsConfig.type - schemas.GoogleCloudRetailV2GcsOutputResult.description - schemas.GoogleCloudRetailV2GcsOutputResult.id - schemas.GoogleCloudRetailV2GcsOutputResult.properties.outputUri.description - schemas.GoogleCloudRetailV2GcsOutputResult.properties.outputUri.type - schemas.GoogleCloudRetailV2GcsOutputResult.type - schemas.GoogleCloudRetailV2OutputConfig.description - schemas.GoogleCloudRetailV2OutputConfig.id - schemas.GoogleCloudRetailV2OutputConfig.properties.bigqueryDestination.$ref - schemas.GoogleCloudRetailV2OutputConfig.properties.bigqueryDestination.description - schemas.GoogleCloudRetailV2OutputConfig.properties.gcsDestination.$ref - schemas.GoogleCloudRetailV2OutputConfig.properties.gcsDestination.description - schemas.GoogleCloudRetailV2OutputConfig.type - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.description - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.id - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.properties.datasetId.description - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.properties.datasetId.type - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.properties.tableIdPrefix.description - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.properties.tableIdPrefix.type - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.properties.tableType.description - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.properties.tableType.type - schemas.GoogleCloudRetailV2OutputConfigBigQueryDestination.type - schemas.GoogleCloudRetailV2OutputConfigGcsDestination.description - schemas.GoogleCloudRetailV2OutputConfigGcsDestination.id - schemas.GoogleCloudRetailV2OutputConfigGcsDestination.properties.outputUriPrefix.description - schemas.GoogleCloudRetailV2OutputConfigGcsDestination.properties.outputUriPrefix.type - schemas.GoogleCloudRetailV2OutputConfigGcsDestination.type - schemas.GoogleCloudRetailV2OutputResult.description - schemas.GoogleCloudRetailV2OutputResult.id - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.description - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.items.$ref - schemas.GoogleCloudRetailV2OutputResult.properties.bigqueryResult.type - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.description - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.items.$ref - schemas.GoogleCloudRetailV2OutputResult.properties.gcsResult.type - schemas.GoogleCloudRetailV2OutputResult.type --- discovery/retail-v2.json | 170 +++++++++++++++++++++++++- discovery/retail-v2alpha.json | 82 ++++++++++++- discovery/retail-v2beta.json | 82 ++++++++++++- src/apis/retail/v2.ts | 220 ++++++++++++++++++++++++++++++++++ src/apis/retail/v2alpha.ts | 61 ++++++++++ src/apis/retail/v2beta.ts | 61 ++++++++++ 6 files changed, 673 insertions(+), 3 deletions(-) diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index 38e8d02ffd..78f2721023 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -173,6 +173,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "exportAnalyticsMetrics": { + "description": "Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:exportAnalyticsMetrics", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.exportAnalyticsMetrics", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Full resource name of the parent catalog. Expected format: `projects/*/locations/*/catalogs/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+catalog}:exportAnalyticsMetrics", + "request": { + "$ref": "GoogleCloudRetailV2ExportAnalyticsMetricsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getAttributesConfig": { "description": "Gets an AttributesConfig.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig", @@ -2059,7 +2087,7 @@ } } }, - "revision": "20240129", + "revision": "20240205", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2367,6 +2395,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2BigQueryOutputResult": { + "description": "A BigQuery output result.", + "id": "GoogleCloudRetailV2BigQueryOutputResult", + "properties": { + "datasetId": { + "description": "The ID of a BigQuery Dataset.", + "type": "string" + }, + "tableId": { + "description": "The ID of a BigQuery Table.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2BigQuerySource": { "description": "BigQuery source import data from.", "id": "GoogleCloudRetailV2BigQuerySource", @@ -2998,6 +3041,54 @@ }, "type": "object" }, + "GoogleCloudRetailV2ExportAnalyticsMetricsRequest": { + "description": "Request message for the `ExportAnalyticsMetrics` method.", + "id": "GoogleCloudRetailV2ExportAnalyticsMetricsRequest", + "properties": { + "filter": { + "description": "A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range. Currently we expect only one types of fields: * `timestamp`: This can be specified twice, once with a less than operator and once with a greater than operator. The `timestamp` restriction should result in one, contiguous, valid, `timestamp` range. Some examples of valid filters expressions: * Example 1: `timestamp > \"2012-04-23T18:25:43.511Z\" timestamp < \"2012-04-23T18:30:43.511Z\"` * Example 2: `timestamp > \"2012-04-23T18:25:43.511Z\"`", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudRetailV2OutputConfig", + "description": "Required. The output location of the data." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ExportAnalyticsMetricsResponse": { + "description": "Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2ExportAnalyticsMetricsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2ExportErrorsConfig", + "description": "This field is never set." + }, + "outputResult": { + "$ref": "GoogleCloudRetailV2OutputResult", + "description": "Output result indicating where the data were exported to." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ExportErrorsConfig": { + "description": "Configuration of destination for Export related errors.", + "id": "GoogleCloudRetailV2ExportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2FulfillmentInfo": { "description": "Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.", "id": "GoogleCloudRetailV2FulfillmentInfo", @@ -3016,6 +3107,17 @@ }, "type": "object" }, + "GoogleCloudRetailV2GcsOutputResult": { + "description": "A Gcs output result.", + "id": "GoogleCloudRetailV2GcsOutputResult", + "properties": { + "outputUri": { + "description": "The uri of Gcs output", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2GcsSource": { "description": "Google Cloud Storage location for input content.", "id": "GoogleCloudRetailV2GcsSource", @@ -3575,6 +3677,72 @@ }, "type": "object" }, + "GoogleCloudRetailV2OutputConfig": { + "description": "The output configuration setting.", + "id": "GoogleCloudRetailV2OutputConfig", + "properties": { + "bigqueryDestination": { + "$ref": "GoogleCloudRetailV2OutputConfigBigQueryDestination", + "description": "The BigQuery location where the output is to be written to." + }, + "gcsDestination": { + "$ref": "GoogleCloudRetailV2OutputConfigGcsDestination", + "description": "The Google Cloud Storage location where the output is to be written to." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2OutputConfigBigQueryDestination": { + "description": "The BigQuery output destination configuration.", + "id": "GoogleCloudRetailV2OutputConfigBigQueryDestination", + "properties": { + "datasetId": { + "description": "Required. The ID of a BigQuery Dataset.", + "type": "string" + }, + "tableIdPrefix": { + "description": "Required. The prefix of exported BigQuery tables.", + "type": "string" + }, + "tableType": { + "description": "Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2OutputConfigGcsDestination": { + "description": "The Google Cloud Storage output destination configuration.", + "id": "GoogleCloudRetailV2OutputConfigGcsDestination", + "properties": { + "outputUriPrefix": { + "description": "Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2OutputResult": { + "description": "Output result that stores the information about where the exported data is stored.", + "id": "GoogleCloudRetailV2OutputResult", + "properties": { + "bigqueryResult": { + "description": "The BigQuery location where the result is stored.", + "items": { + "$ref": "GoogleCloudRetailV2BigQueryOutputResult" + }, + "type": "array" + }, + "gcsResult": { + "description": "The Google Cloud Storage location where the result is stored.", + "items": { + "$ref": "GoogleCloudRetailV2GcsOutputResult" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2PauseModelRequest": { "description": "Request for pausing training of a model.", "id": "GoogleCloudRetailV2PauseModelRequest", diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index e6d584d50d..42609aa5a1 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -2416,7 +2416,7 @@ } } }, - "revision": "20240129", + "revision": "20240205", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2593,6 +2593,21 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2BigQueryOutputResult": { + "description": "A BigQuery output result.", + "id": "GoogleCloudRetailV2BigQueryOutputResult", + "properties": { + "datasetId": { + "description": "The ID of a BigQuery Dataset.", + "type": "string" + }, + "tableId": { + "description": "The ID of a BigQuery Table.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2CreateModelMetadata": { "description": "Metadata associated with a create operation.", "id": "GoogleCloudRetailV2CreateModelMetadata", @@ -2604,6 +2619,50 @@ }, "type": "object" }, + "GoogleCloudRetailV2ExportAnalyticsMetricsResponse": { + "description": "Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2ExportAnalyticsMetricsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2ExportErrorsConfig", + "description": "This field is never set." + }, + "outputResult": { + "$ref": "GoogleCloudRetailV2OutputResult", + "description": "Output result indicating where the data were exported to." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ExportErrorsConfig": { + "description": "Configuration of destination for Export related errors.", + "id": "GoogleCloudRetailV2ExportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2GcsOutputResult": { + "description": "A Gcs output result.", + "id": "GoogleCloudRetailV2GcsOutputResult", + "properties": { + "outputUri": { + "description": "The uri of Gcs output", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2ImportCompletionDataResponse": { "description": "Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "id": "GoogleCloudRetailV2ImportCompletionDataResponse", @@ -2885,6 +2944,27 @@ }, "type": "object" }, + "GoogleCloudRetailV2OutputResult": { + "description": "Output result that stores the information about where the exported data is stored.", + "id": "GoogleCloudRetailV2OutputResult", + "properties": { + "bigqueryResult": { + "description": "The BigQuery location where the result is stored.", + "items": { + "$ref": "GoogleCloudRetailV2BigQueryOutputResult" + }, + "type": "array" + }, + "gcsResult": { + "description": "The Google Cloud Storage location where the result is stored.", + "items": { + "$ref": "GoogleCloudRetailV2GcsOutputResult" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2PurgeMetadata": { "description": "Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2PurgeMetadata", diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index a1e07fc9fa..b65b7d1a03 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -2115,7 +2115,7 @@ } } }, - "revision": "20240129", + "revision": "20240205", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2292,6 +2292,21 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2BigQueryOutputResult": { + "description": "A BigQuery output result.", + "id": "GoogleCloudRetailV2BigQueryOutputResult", + "properties": { + "datasetId": { + "description": "The ID of a BigQuery Dataset.", + "type": "string" + }, + "tableId": { + "description": "The ID of a BigQuery Table.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2CreateModelMetadata": { "description": "Metadata associated with a create operation.", "id": "GoogleCloudRetailV2CreateModelMetadata", @@ -2303,6 +2318,50 @@ }, "type": "object" }, + "GoogleCloudRetailV2ExportAnalyticsMetricsResponse": { + "description": "Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2ExportAnalyticsMetricsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2ExportErrorsConfig", + "description": "This field is never set." + }, + "outputResult": { + "$ref": "GoogleCloudRetailV2OutputResult", + "description": "Output result indicating where the data were exported to." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ExportErrorsConfig": { + "description": "Configuration of destination for Export related errors.", + "id": "GoogleCloudRetailV2ExportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2GcsOutputResult": { + "description": "A Gcs output result.", + "id": "GoogleCloudRetailV2GcsOutputResult", + "properties": { + "outputUri": { + "description": "The uri of Gcs output", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2ImportCompletionDataResponse": { "description": "Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "id": "GoogleCloudRetailV2ImportCompletionDataResponse", @@ -2584,6 +2643,27 @@ }, "type": "object" }, + "GoogleCloudRetailV2OutputResult": { + "description": "Output result that stores the information about where the exported data is stored.", + "id": "GoogleCloudRetailV2OutputResult", + "properties": { + "bigqueryResult": { + "description": "The BigQuery location where the result is stored.", + "items": { + "$ref": "GoogleCloudRetailV2BigQueryOutputResult" + }, + "type": "array" + }, + "gcsResult": { + "description": "The Google Cloud Storage location where the result is stored.", + "items": { + "$ref": "GoogleCloudRetailV2GcsOutputResult" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2PurgeMetadata": { "description": "Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2PurgeMetadata", diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index b39bc9851d..2d3f29aee6 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -1394,6 +1394,19 @@ export namespace retail_v2 { */ unjoinedEventsCount?: string | null; } + /** + * A BigQuery output result. + */ + export interface Schema$GoogleCloudRetailV2BigQueryOutputResult { + /** + * The ID of a BigQuery Dataset. + */ + datasetId?: string | null; + /** + * The ID of a BigQuery Table. + */ + tableId?: string | null; + } /** * BigQuery source import data from. */ @@ -1819,6 +1832,45 @@ export namespace retail_v2 { */ originalServingConfig?: string | null; } + /** + * Request message for the `ExportAnalyticsMetrics` method. + */ + export interface Schema$GoogleCloudRetailV2ExportAnalyticsMetricsRequest { + /** + * A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range. Currently we expect only one types of fields: * `timestamp`: This can be specified twice, once with a less than operator and once with a greater than operator. The `timestamp` restriction should result in one, contiguous, valid, `timestamp` range. Some examples of valid filters expressions: * Example 1: `timestamp \> "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z"` * Example 2: `timestamp \> "2012-04-23T18:25:43.511Z"` + */ + filter?: string | null; + /** + * Required. The output location of the data. + */ + outputConfig?: Schema$GoogleCloudRetailV2OutputConfig; + } + /** + * Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudRetailV2ExportAnalyticsMetricsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * This field is never set. + */ + errorsConfig?: Schema$GoogleCloudRetailV2ExportErrorsConfig; + /** + * Output result indicating where the data were exported to. + */ + outputResult?: Schema$GoogleCloudRetailV2OutputResult; + } + /** + * Configuration of destination for Export related errors. + */ + export interface Schema$GoogleCloudRetailV2ExportErrorsConfig { + /** + * Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message. + */ + gcsPrefix?: string | null; + } /** * Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. */ @@ -1832,6 +1884,15 @@ export namespace retail_v2 { */ type?: string | null; } + /** + * A Gcs output result. + */ + export interface Schema$GoogleCloudRetailV2GcsOutputResult { + /** + * The uri of Gcs output + */ + outputUri?: string | null; + } /** * Google Cloud Storage location for input content. */ @@ -2212,6 +2273,58 @@ export namespace retail_v2 { */ servingConfigIds?: string[] | null; } + /** + * The output configuration setting. + */ + export interface Schema$GoogleCloudRetailV2OutputConfig { + /** + * The BigQuery location where the output is to be written to. + */ + bigqueryDestination?: Schema$GoogleCloudRetailV2OutputConfigBigQueryDestination; + /** + * The Google Cloud Storage location where the output is to be written to. + */ + gcsDestination?: Schema$GoogleCloudRetailV2OutputConfigGcsDestination; + } + /** + * The BigQuery output destination configuration. + */ + export interface Schema$GoogleCloudRetailV2OutputConfigBigQueryDestination { + /** + * Required. The ID of a BigQuery Dataset. + */ + datasetId?: string | null; + /** + * Required. The prefix of exported BigQuery tables. + */ + tableIdPrefix?: string | null; + /** + * Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query. + */ + tableType?: string | null; + } + /** + * The Google Cloud Storage output destination configuration. + */ + export interface Schema$GoogleCloudRetailV2OutputConfigGcsDestination { + /** + * Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json + */ + outputUriPrefix?: string | null; + } + /** + * Output result that stores the information about where the exported data is stored. + */ + export interface Schema$GoogleCloudRetailV2OutputResult { + /** + * The BigQuery location where the result is stored. + */ + bigqueryResult?: Schema$GoogleCloudRetailV2BigQueryOutputResult[]; + /** + * The Google Cloud Storage location where the result is stored. + */ + gcsResult?: Schema$GoogleCloudRetailV2GcsOutputResult[]; + } /** * Request for pausing training of a model. */ @@ -3821,6 +3934,101 @@ export namespace retail_v2 { } } + /** + * Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`. + * + * @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. + */ + exportAnalyticsMetrics( + params: Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics, + options: StreamMethodOptions + ): GaxiosPromise; + exportAnalyticsMetrics( + params?: Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics, + options?: MethodOptions + ): GaxiosPromise; + exportAnalyticsMetrics( + params: Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportAnalyticsMetrics( + params: Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportAnalyticsMetrics( + params: Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics, + callback: BodyResponseCallback + ): void; + exportAnalyticsMetrics( + callback: BodyResponseCallback + ): void; + exportAnalyticsMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+catalog}:exportAnalyticsMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets an AttributesConfig. * @@ -4610,6 +4818,18 @@ export namespace retail_v2 { */ visitorId?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Exportanalyticsmetrics + extends StandardParameters { + /** + * Required. Full resource name of the parent catalog. Expected format: `projects/x/locations/x/catalogs/x` + */ + catalog?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2ExportAnalyticsMetricsRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Getattributesconfig extends StandardParameters { /** diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 2588b07bc6..fc95c17a0c 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -3557,6 +3557,19 @@ export namespace retail_v2alpha { */ unjoinedEventsCount?: string | null; } + /** + * A BigQuery output result. + */ + export interface Schema$GoogleCloudRetailV2BigQueryOutputResult { + /** + * The ID of a BigQuery Dataset. + */ + datasetId?: string | null; + /** + * The ID of a BigQuery Table. + */ + tableId?: string | null; + } /** * Metadata associated with a create operation. */ @@ -3566,6 +3579,41 @@ export namespace retail_v2alpha { */ model?: string | null; } + /** + * Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudRetailV2ExportAnalyticsMetricsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * This field is never set. + */ + errorsConfig?: Schema$GoogleCloudRetailV2ExportErrorsConfig; + /** + * Output result indicating where the data were exported to. + */ + outputResult?: Schema$GoogleCloudRetailV2OutputResult; + } + /** + * Configuration of destination for Export related errors. + */ + export interface Schema$GoogleCloudRetailV2ExportErrorsConfig { + /** + * Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message. + */ + gcsPrefix?: string | null; + } + /** + * A Gcs output result. + */ + export interface Schema$GoogleCloudRetailV2GcsOutputResult { + /** + * The uri of Gcs output + */ + outputUri?: string | null; + } /** * Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. */ @@ -3735,6 +3783,19 @@ export namespace retail_v2alpha { */ servingConfigIds?: string[] | null; } + /** + * Output result that stores the information about where the exported data is stored. + */ + export interface Schema$GoogleCloudRetailV2OutputResult { + /** + * The BigQuery location where the result is stored. + */ + bigqueryResult?: Schema$GoogleCloudRetailV2BigQueryOutputResult[]; + /** + * The Google Cloud Storage location where the result is stored. + */ + gcsResult?: Schema$GoogleCloudRetailV2GcsOutputResult[]; + } /** * Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field. */ diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 591c14efeb..1e0e7003fd 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -3433,6 +3433,19 @@ export namespace retail_v2beta { */ userId?: string | null; } + /** + * A BigQuery output result. + */ + export interface Schema$GoogleCloudRetailV2BigQueryOutputResult { + /** + * The ID of a BigQuery Dataset. + */ + datasetId?: string | null; + /** + * The ID of a BigQuery Table. + */ + tableId?: string | null; + } /** * Metadata associated with a create operation. */ @@ -3442,6 +3455,41 @@ export namespace retail_v2beta { */ model?: string | null; } + /** + * Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudRetailV2ExportAnalyticsMetricsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * This field is never set. + */ + errorsConfig?: Schema$GoogleCloudRetailV2ExportErrorsConfig; + /** + * Output result indicating where the data were exported to. + */ + outputResult?: Schema$GoogleCloudRetailV2OutputResult; + } + /** + * Configuration of destination for Export related errors. + */ + export interface Schema$GoogleCloudRetailV2ExportErrorsConfig { + /** + * Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message. + */ + gcsPrefix?: string | null; + } + /** + * A Gcs output result. + */ + export interface Schema$GoogleCloudRetailV2GcsOutputResult { + /** + * The uri of Gcs output + */ + outputUri?: string | null; + } /** * Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. */ @@ -3611,6 +3659,19 @@ export namespace retail_v2beta { */ servingConfigIds?: string[] | null; } + /** + * Output result that stores the information about where the exported data is stored. + */ + export interface Schema$GoogleCloudRetailV2OutputResult { + /** + * The BigQuery location where the result is stored. + */ + bigqueryResult?: Schema$GoogleCloudRetailV2BigQueryOutputResult[]; + /** + * The Google Cloud Storage location where the result is stored. + */ + gcsResult?: Schema$GoogleCloudRetailV2GcsOutputResult[]; + } /** * Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field. */ From dc5a54d8e4707ef8f9b7a419032d7a6790d9f65f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:18 +0000 Subject: [PATCH 30/43] feat(run): update the API #### run:v1 The following keys were changed: - schemas.Service.properties.metadata.description #### run:v2 The following keys were added: - schemas.GoogleCloudRunV2Service.properties.defaultUriDisabled.description - schemas.GoogleCloudRunV2Service.properties.defaultUriDisabled.type --- discovery/run-v1.json | 4 ++-- discovery/run-v2.json | 6 +++++- src/apis/run/v1.ts | 2 +- src/apis/run/v2.ts | 4 ++++ 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/discovery/run-v1.json b/discovery/run-v1.json index dd0e641da5..84d2ec4969 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -2609,7 +2609,7 @@ } } }, - "revision": "20240121", + "revision": "20240128", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4590,7 +4590,7 @@ }, "metadata": { "$ref": "ObjectMeta", - "description": "Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal." + "description": "Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal." }, "spec": { "$ref": "ServiceSpec", diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 17fb862dab..26e487b078 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1312,7 +1312,7 @@ } } }, - "revision": "20240121", + "revision": "20240128", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2783,6 +2783,10 @@ }, "type": "array" }, + "defaultUriDisabled": { + "description": "Optional. Disables public resolution of the default URI of this service.", + "type": "boolean" + }, "deleteTime": { "description": "Output only. The deletion time.", "format": "google-datetime", diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 564b3f5717..08f22f1830 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -1671,7 +1671,7 @@ export namespace run_v1 { */ kind?: string | null; /** - * Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. + * Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. */ metadata?: Schema$ObjectMeta; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 1f85002f23..7ef6c170ae 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -1087,6 +1087,10 @@ export namespace run_v2 { * One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. */ customAudiences?: string[] | null; + /** + * Optional. Disables public resolution of the default URI of this service. + */ + defaultUriDisabled?: boolean | null; /** * Output only. The deletion time. */ From 0f6540f4cf0645191d143f483b6f512d241a2d01 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:18 +0000 Subject: [PATCH 31/43] feat(sasportal)!: update the API BREAKING CHANGE: This release has breaking changes. #### sasportal:v1alpha1 The following keys were deleted: - resources.customers.methods.checkHasProvisionedDeployment.description - resources.customers.methods.checkHasProvisionedDeployment.flatPath - resources.customers.methods.checkHasProvisionedDeployment.httpMethod - resources.customers.methods.checkHasProvisionedDeployment.id - resources.customers.methods.checkHasProvisionedDeployment.parameterOrder - resources.customers.methods.checkHasProvisionedDeployment.path - resources.customers.methods.checkHasProvisionedDeployment.response.$ref - resources.customers.methods.checkHasProvisionedDeployment.scopes - schemas.SasPortalCheckHasProvisionedDeploymentResponse.description - schemas.SasPortalCheckHasProvisionedDeploymentResponse.id - schemas.SasPortalCheckHasProvisionedDeploymentResponse.properties.hasProvisionedDeployment.description - schemas.SasPortalCheckHasProvisionedDeploymentResponse.properties.hasProvisionedDeployment.type - schemas.SasPortalCheckHasProvisionedDeploymentResponse.type The following keys were added: - resources.customers.methods.listGcpProjectDeployments.description - resources.customers.methods.listGcpProjectDeployments.flatPath - resources.customers.methods.listGcpProjectDeployments.httpMethod - resources.customers.methods.listGcpProjectDeployments.id - resources.customers.methods.listGcpProjectDeployments.parameterOrder - resources.customers.methods.listGcpProjectDeployments.path - resources.customers.methods.listGcpProjectDeployments.response.$ref - resources.customers.methods.listGcpProjectDeployments.scopes - schemas.SasPortalGcpProjectDeployment.description - schemas.SasPortalGcpProjectDeployment.id - schemas.SasPortalGcpProjectDeployment.properties.deployment.$ref - schemas.SasPortalGcpProjectDeployment.properties.deployment.description - schemas.SasPortalGcpProjectDeployment.properties.hasEnabledAnalytics.description - schemas.SasPortalGcpProjectDeployment.properties.hasEnabledAnalytics.type - schemas.SasPortalGcpProjectDeployment.type - schemas.SasPortalListGcpProjectDeploymentsResponse.description - schemas.SasPortalListGcpProjectDeploymentsResponse.id - schemas.SasPortalListGcpProjectDeploymentsResponse.properties.deployments.description - schemas.SasPortalListGcpProjectDeploymentsResponse.properties.deployments.items.$ref - schemas.SasPortalListGcpProjectDeploymentsResponse.properties.deployments.type - schemas.SasPortalListGcpProjectDeploymentsResponse.type The following keys were changed: - resources.customers.methods.listLegacyOrganizations.description --- discovery/sasportal-v1alpha1.json | 76 ++++++---- src/apis/sasportal/v1alpha1.ts | 227 ++++++++++++++++-------------- 2 files changed, 167 insertions(+), 136 deletions(-) diff --git a/discovery/sasportal-v1alpha1.json b/discovery/sasportal-v1alpha1.json index dd81566102..e0995c04da 100644 --- a/discovery/sasportal-v1alpha1.json +++ b/discovery/sasportal-v1alpha1.json @@ -109,22 +109,6 @@ "resources": { "customers": { "methods": { - "checkHasProvisionedDeployment": { - "description": "Checks whether a SAS deployment for the authentication context exists.", - "flatPath": "v1alpha1/customers:checkHasProvisionedDeployment", - "httpMethod": "GET", - "id": "sasportal.customers.checkHasProvisionedDeployment", - "parameterOrder": [], - "parameters": {}, - "path": "v1alpha1/customers:checkHasProvisionedDeployment", - "response": { - "$ref": "SasPortalCheckHasProvisionedDeploymentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sasportal" - ] - }, "get": { "description": "Returns a requested customer.", "flatPath": "v1alpha1/customers/{customersId}", @@ -179,8 +163,24 @@ "https://www.googleapis.com/auth/sasportal" ] }, + "listGcpProjectDeployments": { + "description": "Returns a list of SAS deployments associated with current GCP project. Includes whether SAS analytics has been enabled or not.", + "flatPath": "v1alpha1/customers:listGcpProjectDeployments", + "httpMethod": "GET", + "id": "sasportal.customers.listGcpProjectDeployments", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha1/customers:listGcpProjectDeployments", + "response": { + "$ref": "SasPortalListGcpProjectDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sasportal" + ] + }, "listLegacyOrganizations": { - "description": "Checks whether account is legacy.", + "description": "Returns a list of legacy organizations.", "flatPath": "v1alpha1/customers:listLegacyOrganizations", "httpMethod": "GET", "id": "sasportal.customers.listLegacyOrganizations", @@ -2652,7 +2652,7 @@ } } }, - "revision": "20240111", + "revision": "20240204", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -2689,17 +2689,6 @@ }, "type": "object" }, - "SasPortalCheckHasProvisionedDeploymentResponse": { - "description": "Response for [CheckHasProvisionedDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.CheckHasProvisionedDeployment].", - "id": "SasPortalCheckHasProvisionedDeploymentResponse", - "properties": { - "hasProvisionedDeployment": { - "description": "Whether a SAS deployment for the authentication context exists.", - "type": "boolean" - } - }, - "type": "object" - }, "SasPortalCreateSignedDeviceRequest": { "description": "Request for CreateSignedDevice.", "id": "SasPortalCreateSignedDeviceRequest", @@ -3148,6 +3137,21 @@ }, "type": "object" }, + "SasPortalGcpProjectDeployment": { + "description": "Deployment associated with the GCP project. Includes whether SAS analytics has been enabled or not.", + "id": "SasPortalGcpProjectDeployment", + "properties": { + "deployment": { + "$ref": "SasPortalDeployment", + "description": "Deployment associated with the GCP project." + }, + "hasEnabledAnalytics": { + "description": "Whether SAS analytics has been enabled.", + "type": "boolean" + } + }, + "type": "object" + }, "SasPortalGenerateSecretRequest": { "description": "Request for GenerateSecret.", "id": "SasPortalGenerateSecretRequest", @@ -3313,6 +3317,20 @@ }, "type": "object" }, + "SasPortalListGcpProjectDeploymentsResponse": { + "description": "Response for [ListGcpProjectDeployments].", + "id": "SasPortalListGcpProjectDeploymentsResponse", + "properties": { + "deployments": { + "description": "Optional. Deployments associated with the GCP project", + "items": { + "$ref": "SasPortalGcpProjectDeployment" + }, + "type": "array" + } + }, + "type": "object" + }, "SasPortalListLegacyOrganizationsResponse": { "description": "Response for [ListLegacyOrganizations]. [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations].", "id": "SasPortalListLegacyOrganizationsResponse", diff --git a/src/apis/sasportal/v1alpha1.ts b/src/apis/sasportal/v1alpha1.ts index aee21519ac..8db54b8616 100644 --- a/src/apis/sasportal/v1alpha1.ts +++ b/src/apis/sasportal/v1alpha1.ts @@ -158,15 +158,6 @@ export namespace sasportal_v1alpha1 { */ score?: number | null; } - /** - * Response for [CheckHasProvisionedDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.CheckHasProvisionedDeployment]. - */ - export interface Schema$SasPortalCheckHasProvisionedDeploymentResponse { - /** - * Whether a SAS deployment for the authentication context exists. - */ - hasProvisionedDeployment?: boolean | null; - } /** * Request for CreateSignedDevice. */ @@ -456,6 +447,19 @@ export namespace sasportal_v1alpha1 { */ lowFrequencyMhz?: number | null; } + /** + * Deployment associated with the GCP project. Includes whether SAS analytics has been enabled or not. + */ + export interface Schema$SasPortalGcpProjectDeployment { + /** + * Deployment associated with the GCP project. + */ + deployment?: Schema$SasPortalDeployment; + /** + * Whether SAS analytics has been enabled. + */ + hasEnabledAnalytics?: boolean | null; + } /** * Request for GenerateSecret. */ @@ -578,6 +582,15 @@ export namespace sasportal_v1alpha1 { */ nextPageToken?: string | null; } + /** + * Response for [ListGcpProjectDeployments]. + */ + export interface Schema$SasPortalListGcpProjectDeploymentsResponse { + /** + * Optional. Deployments associated with the GCP project + */ + deployments?: Schema$SasPortalGcpProjectDeployment[]; + } /** * Response for [ListLegacyOrganizations]. [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. */ @@ -902,101 +915,6 @@ export namespace sasportal_v1alpha1 { this.nodes = new Resource$Customers$Nodes(this.context); } - /** - * Checks whether a SAS deployment for the authentication context 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. - */ - checkHasProvisionedDeployment( - params: Params$Resource$Customers$Checkhasprovisioneddeployment, - options: StreamMethodOptions - ): GaxiosPromise; - checkHasProvisionedDeployment( - params?: Params$Resource$Customers$Checkhasprovisioneddeployment, - options?: MethodOptions - ): GaxiosPromise; - checkHasProvisionedDeployment( - params: Params$Resource$Customers$Checkhasprovisioneddeployment, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - checkHasProvisionedDeployment( - params: Params$Resource$Customers$Checkhasprovisioneddeployment, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - checkHasProvisionedDeployment( - params: Params$Resource$Customers$Checkhasprovisioneddeployment, - callback: BodyResponseCallback - ): void; - checkHasProvisionedDeployment( - callback: BodyResponseCallback - ): void; - checkHasProvisionedDeployment( - paramsOrCallback?: - | Params$Resource$Customers$Checkhasprovisioneddeployment - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Customers$Checkhasprovisioneddeployment; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Customers$Checkhasprovisioneddeployment; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha1/customers:checkHasProvisionedDeployment' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Returns a requested customer. * @@ -1179,7 +1097,102 @@ export namespace sasportal_v1alpha1 { } /** - * Checks whether account is legacy. + * Returns a list of SAS deployments associated with current GCP project. Includes whether SAS analytics has been enabled or not. + * + * @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. + */ + listGcpProjectDeployments( + params: Params$Resource$Customers$Listgcpprojectdeployments, + options: StreamMethodOptions + ): GaxiosPromise; + listGcpProjectDeployments( + params?: Params$Resource$Customers$Listgcpprojectdeployments, + options?: MethodOptions + ): GaxiosPromise; + listGcpProjectDeployments( + params: Params$Resource$Customers$Listgcpprojectdeployments, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listGcpProjectDeployments( + params: Params$Resource$Customers$Listgcpprojectdeployments, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listGcpProjectDeployments( + params: Params$Resource$Customers$Listgcpprojectdeployments, + callback: BodyResponseCallback + ): void; + listGcpProjectDeployments( + callback: BodyResponseCallback + ): void; + listGcpProjectDeployments( + paramsOrCallback?: + | Params$Resource$Customers$Listgcpprojectdeployments + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Listgcpprojectdeployments; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Listgcpprojectdeployments; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha1/customers:listGcpProjectDeployments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns a list of legacy organizations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1640,8 +1653,6 @@ export namespace sasportal_v1alpha1 { } } - export interface Params$Resource$Customers$Checkhasprovisioneddeployment - extends StandardParameters {} export interface Params$Resource$Customers$Get extends StandardParameters { /** * Required. The name of the customer. @@ -1658,6 +1669,8 @@ export namespace sasportal_v1alpha1 { */ pageToken?: string; } + export interface Params$Resource$Customers$Listgcpprojectdeployments + extends StandardParameters {} export interface Params$Resource$Customers$Listlegacyorganizations extends StandardParameters {} export interface Params$Resource$Customers$Migrateorganization From f6955a9683d8565235d44c14b925ed0574942a9c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:18 +0000 Subject: [PATCH 32/43] feat(securitycenter): update the API #### securitycenter:v1 The following keys were added: - schemas.GoogleCloudSecuritycenterV1ResourceValueConfig.properties.sensitiveDataProtectionMapping.$ref - schemas.GoogleCloudSecuritycenterV1ResourceValueConfig.properties.sensitiveDataProtectionMapping.description - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.description - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.id - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.properties.highSensitivityMapping.description - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.properties.highSensitivityMapping.enum - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.properties.highSensitivityMapping.enumDescriptions - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.properties.highSensitivityMapping.type - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.properties.mediumSensitivityMapping.description - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.properties.mediumSensitivityMapping.enum - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.properties.mediumSensitivityMapping.enumDescriptions - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.properties.mediumSensitivityMapping.type - schemas.GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping.type The following keys were changed: - schemas.Cve.description --- discovery/securitycenter-v1.json | 51 ++++++++++++++++++++++++++++++-- src/apis/securitycenter/v1.ts | 19 +++++++++++- 2 files changed, 67 insertions(+), 3 deletions(-) diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index 36b4c70e2f..33c0a680c5 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -5820,7 +5820,7 @@ } } }, - "revision": "20240124", + "revision": "20240130", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6596,7 +6596,7 @@ "type": "object" }, "Cve": { - "description": "CVE stands for Common Vulnerabilities and Exposures. More information: https://cve.mitre.org", + "description": "CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability.", "id": "Cve", "properties": { "cvssv3": { @@ -7799,6 +7799,10 @@ "description": "Project or folder to scope this config to. For example, \"project/456\" would apply this config only to resources in \"project/456\" scope will be checked with \"AND\" of other resources.", "type": "string" }, + "sensitiveDataProtectionMapping": { + "$ref": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping", + "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." + }, "tagValues": { "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" E.g. [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { @@ -7894,6 +7898,49 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping": { + "description": "Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration.", + "id": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping", + "properties": { + "highSensitivityMapping": { + "description": "Resource value mapping for high-sensitivity Sensitive Data Protection findings", + "enum": [ + "RESOURCE_VALUE_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "NONE" + ], + "enumDescriptions": [ + "Unspecific value", + "High resource value", + "Medium resource value", + "Low resource value", + "No resource value, e.g. ignore these resources" + ], + "type": "string" + }, + "mediumSensitivityMapping": { + "description": "Resource value mapping for medium-sensitivity Sensitive Data Protection findings", + "enum": [ + "RESOURCE_VALUE_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "NONE" + ], + "enumDescriptions": [ + "Unspecific value", + "High resource value", + "Medium resource value", + "Low resource value", + "No resource value, e.g. ignore these resources" + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse": { "description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse", diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 9f2ee8b2a9..98a1d5cd7c 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -694,7 +694,7 @@ export namespace securitycenter_v1 { errors?: Schema$CustomModuleValidationError[]; } /** - * CVE stands for Common Vulnerabilities and Exposures. More information: https://cve.mitre.org + * CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. */ export interface Schema$Cve { /** @@ -1666,6 +1666,10 @@ export namespace securitycenter_v1 { * Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources. */ scope?: string | null; + /** + * A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset". + */ + sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping; /** * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ @@ -1721,6 +1725,19 @@ export namespace securitycenter_v1 { */ updateTime?: string | null; } + /** + * Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. + */ + export interface Schema$GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping { + /** + * Resource value mapping for high-sensitivity Sensitive Data Protection findings + */ + highSensitivityMapping?: string | null; + /** + * Resource value mapping for medium-sensitivity Sensitive Data Protection findings + */ + mediumSensitivityMapping?: string | null; + } /** * Request message for grouping by assets. */ From c49c2856711a97548ff05caef0e4fd6da2fd8876 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:18 +0000 Subject: [PATCH 33/43] feat(spanner): update the API #### spanner:v1 The following keys were added: - schemas.CommitRequest.properties.maxCommitDelay.description - schemas.CommitRequest.properties.maxCommitDelay.format - schemas.CommitRequest.properties.maxCommitDelay.type The following keys were changed: - schemas.Binding.properties.role.description - schemas.ReplicaInfo.properties.location.description - schemas.Type.properties.code.enum - schemas.Type.properties.code.enumDescriptions --- discovery/spanner-v1.json | 13 ++++++++++--- src/apis/spanner/v1.ts | 8 ++++++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index acf4b1514b..51af9747c3 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -2729,7 +2729,7 @@ } } }, - "revision": "20240120", + "revision": "20240131", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { @@ -3013,7 +3013,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`.", + "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" } }, @@ -3043,6 +3043,11 @@ "description": "The request for Commit.", "id": "CommitRequest", "properties": { + "maxCommitDelay": { + "description": "Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.", + "format": "google-duration", + "type": "string" + }, "mutations": { "description": "The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.", "items": { @@ -5182,7 +5187,7 @@ "type": "boolean" }, "location": { - "description": "The location of the serving resources, e.g. \"us-central1\".", + "description": "The location of the serving resources, e.g., \"us-central1\".", "type": "string" }, "type": { @@ -5740,6 +5745,7 @@ "BOOL", "INT64", "FLOAT64", + "FLOAT32", "TIMESTAMP", "DATE", "STRING", @@ -5756,6 +5762,7 @@ "Encoded as JSON `true` or `false`.", "Encoded as `string`, in decimal format.", "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or `\"-Infinity\"`.", + "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or `\"-Infinity\"`.", "Encoded as `string` in RFC 3339 timestamp format. The time zone must be present, and must be `\"Z\"`. If the schema has the column option `allow_commit_timestamp=true`, the placeholder string `\"spanner.commit_timestamp()\"` can be used to instruct the system to insert the commit timestamp associated with the transaction commit.", "Encoded as `string` in RFC 3339 date format.", "Encoded as `string`.", diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 663a2eb783..eaad375b84 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -325,7 +325,7 @@ export namespace spanner_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -350,6 +350,10 @@ export namespace spanner_v1 { * The request for Commit. */ export interface Schema$CommitRequest { + /** + * Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms. + */ + maxCommitDelay?: string | null; /** * The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. */ @@ -1864,7 +1868,7 @@ export namespace spanner_v1 { */ defaultLeaderLocation?: boolean | null; /** - * The location of the serving resources, e.g. "us-central1". + * The location of the serving resources, e.g., "us-central1". */ location?: string | null; /** From 162055bfa1c298d38e4f4e3074eec63e7d8204dc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:18 +0000 Subject: [PATCH 34/43] feat(storage)!: update the API BREAKING CHANGE: This release has breaking changes. #### storage:v1 The following keys were deleted: - schemas.Folder.properties.metadata.additionalProperties.description - schemas.Folder.properties.metadata.additionalProperties.type - schemas.Folder.properties.metadata.description - schemas.Folder.properties.metadata.type --- discovery/storage-v1.json | 12 ++---------- src/apis/storage/v1.ts | 4 ---- 2 files changed, 2 insertions(+), 14 deletions(-) diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index fd5daa8612..020a04842f 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -33,7 +33,7 @@ "description": "Regional Endpoint" } ], - "etag": "\"313237363339343230393533383533343231\"", + "etag": "\"36373537363133393131323733353738333730\"", "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" @@ -4040,7 +4040,7 @@ } } }, - "revision": "20240129", + "revision": "20240202", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { @@ -4862,14 +4862,6 @@ "description": "The kind of item this is. For folders, this is always storage#folder.", "type": "string" }, - "metadata": { - "additionalProperties": { - "description": "An individual metadata entry.", - "type": "string" - }, - "description": "User-provided metadata, in key/value pairs.", - "type": "object" - }, "metageneration": { "description": "The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.", "format": "int64", diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 8b0fb1b548..938bb6aab5 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -603,10 +603,6 @@ export namespace storage_v1 { * The kind of item this is. For folders, this is always storage#folder. */ kind?: string | null; - /** - * User-provided metadata, in key/value pairs. - */ - metadata?: {[key: string]: string} | null; /** * The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata. */ From 864af81fef645a5e7af66bb7ee9cc372e0b2a41d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 35/43] fix(sts): update the API #### sts:v1beta The following keys were changed: - schemas.GoogleIamV1Binding.properties.role.description #### sts:v1 The following keys were changed: - schemas.GoogleIamV1Binding.properties.role.description --- discovery/sts-v1.json | 4 ++-- discovery/sts-v1beta.json | 4 ++-- src/apis/sts/v1.ts | 2 +- src/apis/sts/v1beta.ts | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index d65bd54b02..c6cf3a8007 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20240122", + "revision": "20240129", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -165,7 +165,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`.", + "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" } }, diff --git a/discovery/sts-v1beta.json b/discovery/sts-v1beta.json index 4039833a0a..382688fda4 100644 --- a/discovery/sts-v1beta.json +++ b/discovery/sts-v1beta.json @@ -116,7 +116,7 @@ } } }, - "revision": "20240122", + "revision": "20240129", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -135,7 +135,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`.", + "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" } }, diff --git a/src/apis/sts/v1.ts b/src/apis/sts/v1.ts index e576696f86..65cf68da63 100644 --- a/src/apis/sts/v1.ts +++ b/src/apis/sts/v1.ts @@ -137,7 +137,7 @@ export namespace sts_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } diff --git a/src/apis/sts/v1beta.ts b/src/apis/sts/v1beta.ts index 8fb88c1463..2878245e35 100644 --- a/src/apis/sts/v1beta.ts +++ b/src/apis/sts/v1beta.ts @@ -137,7 +137,7 @@ export namespace sts_v1beta { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } From e021b59d3d62920e534e35cb95cc5f579984a5f1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 36/43] feat(tpu): update the API #### tpu:v2alpha1 The following keys were added: - schemas.SchedulingConfig.properties.spot.description - schemas.SchedulingConfig.properties.spot.type #### tpu:v2 The following keys were added: - schemas.SchedulingConfig.properties.spot.description - schemas.SchedulingConfig.properties.spot.type --- discovery/tpu-v2.json | 6 +++++- discovery/tpu-v2alpha1.json | 6 +++++- src/apis/tpu/v2.ts | 4 ++++ src/apis/tpu/v2alpha1.ts | 4 ++++ 4 files changed, 18 insertions(+), 2 deletions(-) diff --git a/discovery/tpu-v2.json b/discovery/tpu-v2.json index ee784c1c44..7f6126c600 100644 --- a/discovery/tpu-v2.json +++ b/discovery/tpu-v2.json @@ -721,7 +721,7 @@ } } }, - "revision": "20240118", + "revision": "20240126", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1399,6 +1399,10 @@ "reserved": { "description": "Whether the node is created under a reservation.", "type": "boolean" + }, + "spot": { + "description": "Optional. Defines whether the node is Spot VM.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/tpu-v2alpha1.json b/discovery/tpu-v2alpha1.json index 1fe525ddd0..f03f7ef9cc 100644 --- a/discovery/tpu-v2alpha1.json +++ b/discovery/tpu-v2alpha1.json @@ -965,7 +965,7 @@ } } }, - "revision": "20240118", + "revision": "20240126", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2019,6 +2019,10 @@ "reserved": { "description": "Whether the node is created under a reservation.", "type": "boolean" + }, + "spot": { + "description": "Optional. Defines whether the node is Spot VM.", + "type": "boolean" } }, "type": "object" diff --git a/src/apis/tpu/v2.ts b/src/apis/tpu/v2.ts index 12f2604d61..e89c088aca 100644 --- a/src/apis/tpu/v2.ts +++ b/src/apis/tpu/v2.ts @@ -582,6 +582,10 @@ export namespace tpu_v2 { * Whether the node is created under a reservation. */ reserved?: boolean | null; + /** + * Optional. Defines whether the node is Spot VM. + */ + spot?: boolean | null; } /** * A service account. diff --git a/src/apis/tpu/v2alpha1.ts b/src/apis/tpu/v2alpha1.ts index 1ade1d679c..dc1d0aa643 100644 --- a/src/apis/tpu/v2alpha1.ts +++ b/src/apis/tpu/v2alpha1.ts @@ -860,6 +860,10 @@ export namespace tpu_v2alpha1 { * Whether the node is created under a reservation. */ reserved?: boolean | null; + /** + * Optional. Defines whether the node is Spot VM. + */ + spot?: boolean | null; } /** * A service account. From a2443fb2b30a49c1d0632ddcb8f2f3263883610a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 37/43] feat(transcoder): update the API #### transcoder:v1 The following keys were added: - schemas.H264CodecSettings.properties.hlg.$ref - schemas.H264CodecSettings.properties.hlg.description - schemas.H264CodecSettings.properties.sdr.$ref - schemas.H264CodecSettings.properties.sdr.description - schemas.H264ColorFormatHLG.description - schemas.H264ColorFormatHLG.id - schemas.H264ColorFormatHLG.type - schemas.H264ColorFormatSDR.description - schemas.H264ColorFormatSDR.id - schemas.H264ColorFormatSDR.type - schemas.H265CodecSettings.properties.hdr10.$ref - schemas.H265CodecSettings.properties.hdr10.description - schemas.H265CodecSettings.properties.hlg.$ref - schemas.H265CodecSettings.properties.hlg.description - schemas.H265CodecSettings.properties.sdr.$ref - schemas.H265CodecSettings.properties.sdr.description - schemas.H265ColorFormatHDR10.description - schemas.H265ColorFormatHDR10.id - schemas.H265ColorFormatHDR10.type - schemas.H265ColorFormatHLG.description - schemas.H265ColorFormatHLG.id - schemas.H265ColorFormatHLG.type - schemas.H265ColorFormatSDR.description - schemas.H265ColorFormatSDR.id - schemas.H265ColorFormatSDR.type - schemas.Vp9CodecSettings.properties.hlg.$ref - schemas.Vp9CodecSettings.properties.hlg.description - schemas.Vp9CodecSettings.properties.sdr.$ref - schemas.Vp9CodecSettings.properties.sdr.description - schemas.Vp9ColorFormatHLG.description - schemas.Vp9ColorFormatHLG.id - schemas.Vp9ColorFormatHLG.type - schemas.Vp9ColorFormatSDR.description - schemas.Vp9ColorFormatSDR.id - schemas.Vp9ColorFormatSDR.type --- discovery/transcoder-v1.json | 72 +++++++++++++++++++++++++++++++++++- src/apis/transcoder/v1.ts | 56 ++++++++++++++++++++++++++++ 2 files changed, 127 insertions(+), 1 deletion(-) diff --git a/discovery/transcoder-v1.json b/discovery/transcoder-v1.json index 9942f96183..c4f3c93671 100644 --- a/discovery/transcoder-v1.json +++ b/discovery/transcoder-v1.json @@ -385,7 +385,7 @@ } } }, - "revision": "20230906", + "revision": "20240124", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { @@ -921,6 +921,10 @@ "format": "int32", "type": "integer" }, + "hlg": { + "$ref": "H264ColorFormatHLG", + "description": "Optional. HLG color format setting for H264." + }, "pixelFormat": { "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format", "type": "string" @@ -937,6 +941,10 @@ "description": "Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor", "type": "string" }, + "sdr": { + "$ref": "H264ColorFormatSDR", + "description": "Optional. SDR color format setting for H264." + }, "tune": { "description": "Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.", "type": "string" @@ -959,6 +967,18 @@ }, "type": "object" }, + "H264ColorFormatHLG": { + "description": "Convert the input video to a Hybrid Log Gamma (HLG) video.", + "id": "H264ColorFormatHLG", + "properties": {}, + "type": "object" + }, + "H264ColorFormatSDR": { + "description": "Convert the input video to a Standard Dynamic Range (SDR) video.", + "id": "H264ColorFormatSDR", + "properties": {}, + "type": "object" + }, "H265CodecSettings": { "description": "H265 codec settings.", "id": "H265CodecSettings", @@ -1010,11 +1030,19 @@ "format": "int32", "type": "integer" }, + "hdr10": { + "$ref": "H265ColorFormatHDR10", + "description": "Optional. HDR10 color format setting for H265." + }, "heightPixels": { "description": "The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.", "format": "int32", "type": "integer" }, + "hlg": { + "$ref": "H265ColorFormatHLG", + "description": "Optional. HLG color format setting for H265." + }, "pixelFormat": { "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format", "type": "string" @@ -1031,6 +1059,10 @@ "description": "Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor", "type": "string" }, + "sdr": { + "$ref": "H265ColorFormatSDR", + "description": "Optional. SDR color format setting for H265." + }, "tune": { "description": "Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.", "type": "string" @@ -1053,6 +1085,24 @@ }, "type": "object" }, + "H265ColorFormatHDR10": { + "description": "Convert the input video to a High Dynamic Range 10 (HDR10) video.", + "id": "H265ColorFormatHDR10", + "properties": {}, + "type": "object" + }, + "H265ColorFormatHLG": { + "description": "Convert the input video to a Hybrid Log Gamma (HLG) video.", + "id": "H265ColorFormatHLG", + "properties": {}, + "type": "object" + }, + "H265ColorFormatSDR": { + "description": "Convert the input video to a Standard Dynamic Range (SDR) video.", + "id": "H265ColorFormatSDR", + "properties": {}, + "type": "object" + }, "Image": { "description": "Overlaid image.", "id": "Image", @@ -1785,6 +1835,10 @@ "format": "int32", "type": "integer" }, + "hlg": { + "$ref": "Vp9ColorFormatHLG", + "description": "Optional. HLG color format setting for VP9." + }, "pixelFormat": { "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format", "type": "string" @@ -1797,6 +1851,10 @@ "description": "Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate", "type": "string" }, + "sdr": { + "$ref": "Vp9ColorFormatSDR", + "description": "Optional. SDR color format setting for VP9." + }, "widthPixels": { "description": "The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.", "format": "int32", @@ -1805,6 +1863,18 @@ }, "type": "object" }, + "Vp9ColorFormatHLG": { + "description": "Convert the input video to a Hybrid Log Gamma (HLG) video.", + "id": "Vp9ColorFormatHLG", + "properties": {}, + "type": "object" + }, + "Vp9ColorFormatSDR": { + "description": "Convert the input video to a Standard Dynamic Range (SDR) video.", + "id": "Vp9ColorFormatSDR", + "properties": {}, + "type": "object" + }, "Widevine": { "description": "Widevine configuration.", "id": "Widevine", diff --git a/src/apis/transcoder/v1.ts b/src/apis/transcoder/v1.ts index 77b72f40b2..43716c2b83 100644 --- a/src/apis/transcoder/v1.ts +++ b/src/apis/transcoder/v1.ts @@ -548,6 +548,10 @@ export namespace transcoder_v1 { * The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output. */ heightPixels?: number | null; + /** + * Optional. HLG color format setting for H264. + */ + hlg?: Schema$H264ColorFormatHLG; /** * Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format */ @@ -564,6 +568,10 @@ export namespace transcoder_v1 { * Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor */ rateControlMode?: string | null; + /** + * Optional. SDR color format setting for H264. + */ + sdr?: Schema$H264ColorFormatSDR; /** * Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message. */ @@ -581,6 +589,14 @@ export namespace transcoder_v1 { */ widthPixels?: number | null; } + /** + * Convert the input video to a Hybrid Log Gamma (HLG) video. + */ + export interface Schema$H264ColorFormatHLG {} + /** + * Convert the input video to a Standard Dynamic Range (SDR) video. + */ + export interface Schema$H264ColorFormatSDR {} /** * H265 codec settings. */ @@ -625,10 +641,18 @@ export namespace transcoder_v1 { * Select the GOP size based on the specified frame count. Must be greater than zero. */ gopFrameCount?: number | null; + /** + * Optional. HDR10 color format setting for H265. + */ + hdr10?: Schema$H265ColorFormatHDR10; /** * The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output. */ heightPixels?: number | null; + /** + * Optional. HLG color format setting for H265. + */ + hlg?: Schema$H265ColorFormatHLG; /** * Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format */ @@ -645,6 +669,10 @@ export namespace transcoder_v1 { * Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor */ rateControlMode?: string | null; + /** + * Optional. SDR color format setting for H265. + */ + sdr?: Schema$H265ColorFormatSDR; /** * Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message. */ @@ -662,6 +690,18 @@ export namespace transcoder_v1 { */ widthPixels?: number | null; } + /** + * Convert the input video to a High Dynamic Range 10 (HDR10) video. + */ + export interface Schema$H265ColorFormatHDR10 {} + /** + * Convert the input video to a Hybrid Log Gamma (HLG) video. + */ + export interface Schema$H265ColorFormatHLG {} + /** + * Convert the input video to a Standard Dynamic Range (SDR) video. + */ + export interface Schema$H265ColorFormatSDR {} /** * Overlaid image. */ @@ -1201,6 +1241,10 @@ export namespace transcoder_v1 { * The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output. */ heightPixels?: number | null; + /** + * Optional. HLG color format setting for VP9. + */ + hlg?: Schema$Vp9ColorFormatHLG; /** * Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format */ @@ -1213,11 +1257,23 @@ export namespace transcoder_v1 { * Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate */ rateControlMode?: string | null; + /** + * Optional. SDR color format setting for VP9. + */ + sdr?: Schema$Vp9ColorFormatSDR; /** * The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output. */ widthPixels?: number | null; } + /** + * Convert the input video to a Hybrid Log Gamma (HLG) video. + */ + export interface Schema$Vp9ColorFormatHLG {} + /** + * Convert the input video to a Standard Dynamic Range (SDR) video. + */ + export interface Schema$Vp9ColorFormatSDR {} /** * Widevine configuration. */ From 95e5c9b9abfe5ce871540ef7a64c1fffcd48175a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 38/43] fix(vmwareengine): update the API #### vmwareengine:v1 The following keys were changed: - schemas.Binding.properties.role.description --- discovery/vmwareengine-v1.json | 4 ++-- src/apis/vmwareengine/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/vmwareengine-v1.json b/discovery/vmwareengine-v1.json index 522afb4b27..40377e6958 100644 --- a/discovery/vmwareengine-v1.json +++ b/discovery/vmwareengine-v1.json @@ -3173,7 +3173,7 @@ } } }, - "revision": "20240116", + "revision": "20240126", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AuditConfig": { @@ -3240,7 +3240,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`.", + "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" } }, diff --git a/src/apis/vmwareengine/v1.ts b/src/apis/vmwareengine/v1.ts index 776ce57e65..6fc7aceba1 100644 --- a/src/apis/vmwareengine/v1.ts +++ b/src/apis/vmwareengine/v1.ts @@ -163,7 +163,7 @@ export namespace vmwareengine_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } From 8f9c36a12977f3c90c4d61b9b0bd073ba821625f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 39/43] feat(walletobjects)!: update the API BREAKING CHANGE: This release has breaking changes. #### walletobjects:v1 The following keys were deleted: - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.description - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.flatPath - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.httpMethod - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.id - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.parameterOrder - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.path - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.request.$ref - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.response.$ref - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.scopes - schemas.SetPassUpdateNoticeRequest.description - schemas.SetPassUpdateNoticeRequest.id - schemas.SetPassUpdateNoticeRequest.type - schemas.SetPassUpdateNoticeResponse.description - schemas.SetPassUpdateNoticeResponse.id - schemas.SetPassUpdateNoticeResponse.type The following keys were added: - schemas.AppLinkDataAppLinkInfoAppTarget.properties.targetUri.description --- discovery/walletobjects-v1.json | 35 +--------- src/apis/walletobjects/v1.ts | 113 +------------------------------- 2 files changed, 6 insertions(+), 142 deletions(-) diff --git a/discovery/walletobjects-v1.json b/discovery/walletobjects-v1.json index d5d7168ea3..c6c1b5c632 100644 --- a/discovery/walletobjects-v1.json +++ b/discovery/walletobjects-v1.json @@ -2632,24 +2632,6 @@ "resources": { "privateContent": { "methods": { - "setPassUpdateNotice": { - "description": "Provide Google with information about awaiting private pass update. This will allow Google to provide the update notification to the device that currently holds this pass.", - "flatPath": "walletobjects/v1/privateContent/setPassUpdateNotice", - "httpMethod": "POST", - "id": "walletobjects.walletobjects.v1.privateContent.setPassUpdateNotice", - "parameterOrder": [], - "parameters": {}, - "path": "walletobjects/v1/privateContent/setPassUpdateNotice", - "request": { - "$ref": "SetPassUpdateNoticeRequest" - }, - "response": { - "$ref": "SetPassUpdateNoticeResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/wallet_object.issuer" - ] - }, "uploadPrivateData": { "description": "Upload private data (text or URI) and returns an Id to be used in its place.", "flatPath": "walletobjects/v1/privateContent/uploadPrivateData", @@ -2675,7 +2657,7 @@ } } }, - "revision": "20240201", + "revision": "20240206", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -2805,7 +2787,8 @@ "id": "AppLinkDataAppLinkInfoAppTarget", "properties": { "targetUri": { - "$ref": "Uri" + "$ref": "Uri", + "description": "URI for AppTarget. The description on the URI must be set." } }, "type": "object" @@ -8090,18 +8073,6 @@ }, "type": "object" }, - "SetPassUpdateNoticeRequest": { - "description": "Request to send a private pass update notice information to Google, so that devices can then fetch the notice prompting the user to update a pass.", - "id": "SetPassUpdateNoticeRequest", - "properties": {}, - "type": "object" - }, - "SetPassUpdateNoticeResponse": { - "description": "A response to a request to notify Google of an awaiting update to a private pass.", - "id": "SetPassUpdateNoticeResponse", - "properties": {}, - "type": "object" - }, "SignUpInfo": { "id": "SignUpInfo", "properties": { diff --git a/src/apis/walletobjects/v1.ts b/src/apis/walletobjects/v1.ts index 66cefa19de..33288044d0 100644 --- a/src/apis/walletobjects/v1.ts +++ b/src/apis/walletobjects/v1.ts @@ -242,6 +242,9 @@ export namespace walletobjects_v1 { title?: Schema$LocalizedString; } export interface Schema$AppLinkDataAppLinkInfoAppTarget { + /** + * URI for AppTarget. The description on the URI must be set. + */ targetUri?: Schema$Uri; } export interface Schema$AuthenticationKey { @@ -3292,14 +3295,6 @@ export namespace walletobjects_v1 { */ animationType?: string | null; } - /** - * Request to send a private pass update notice information to Google, so that devices can then fetch the notice prompting the user to update a pass. - */ - export interface Schema$SetPassUpdateNoticeRequest {} - /** - * A response to a request to notify Google of an awaiting update to a private pass. - */ - export interface Schema$SetPassUpdateNoticeResponse {} export interface Schema$SignUpInfo { /** * ID of the class the user can sign up for. @@ -13704,101 +13699,6 @@ export namespace walletobjects_v1 { this.context = context; } - /** - * Provide Google with information about awaiting private pass update. This will allow Google to provide the update notification to the device that currently holds this pass. - * - * @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. - */ - setPassUpdateNotice( - params: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, - options: StreamMethodOptions - ): GaxiosPromise; - setPassUpdateNotice( - params?: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, - options?: MethodOptions - ): GaxiosPromise; - setPassUpdateNotice( - params: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setPassUpdateNotice( - params: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setPassUpdateNotice( - params: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, - callback: BodyResponseCallback - ): void; - setPassUpdateNotice( - callback: BodyResponseCallback - ): void; - setPassUpdateNotice( - paramsOrCallback?: - | Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://walletobjects.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/walletobjects/v1/privateContent/setPassUpdateNotice' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Upload private data (text or URI) and returns an Id to be used in its place. * @@ -13895,13 +13795,6 @@ export namespace walletobjects_v1 { } } - export interface Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice - extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$SetPassUpdateNoticeRequest; - } export interface Params$Resource$Walletobjects$V1$Privatecontent$Uploadprivatedata extends StandardParameters { /** From e085fb32687c3903436c421d4800808057db982f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 40/43] fix(workflowexecutions): update the API #### workflowexecutions:v1 The following keys were changed: - resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.orderBy.description - schemas.PubsubMessage.properties.messageId.description - schemas.PubsubMessage.properties.publishTime.description --- discovery/workflowexecutions-v1.json | 10 +++++----- src/apis/workflowexecutions/v1.ts | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/workflowexecutions-v1.json b/discovery/workflowexecutions-v1.json index 7a998a33cd..2b7e8bb784 100644 --- a/discovery/workflowexecutions-v1.json +++ b/discovery/workflowexecutions-v1.json @@ -274,12 +274,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `startTime>\"2023-08-01\" AND state=\"FAILED\"`", + "description": "Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `startTime>\"2023-08-01\" AND state=\"FAILED\"`", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Comma-separated list of fields that specify the ordering applied to the `[Executions.ListExecutions]` results. By default the ordering is based on descending `startTime`. The following fields are supported for ordering: `executionId`, `state`, `startTime`, `endTime`, `duration`, and `workflowRevisionId`. For details, see AIP-132.", + "description": "Optional. Comma-separated list of fields that specify the ordering applied to the `[Executions.ListExecutions]` results. By default the ordering is based on descending `createTime`. The following fields are supported for ordering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, and `workflowRevisionId`. For details, see AIP-132.", "location": "query", "type": "string" }, @@ -457,7 +457,7 @@ } } }, - "revision": "20240122", + "revision": "20240129", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -781,7 +781,7 @@ "type": "string" }, "messageId": { - "description": "Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", + "description": "ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", "type": "string" }, "orderingKey": { @@ -789,7 +789,7 @@ "type": "string" }, "publishTime": { - "description": "Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", + "description": "The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", "format": "google-datetime", "type": "string" } diff --git a/src/apis/workflowexecutions/v1.ts b/src/apis/workflowexecutions/v1.ts index e34fb72c8c..043af00f24 100644 --- a/src/apis/workflowexecutions/v1.ts +++ b/src/apis/workflowexecutions/v1.ts @@ -343,7 +343,7 @@ export namespace workflowexecutions_v1 { */ data?: string | null; /** - * Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. + * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ messageId?: string | null; /** @@ -351,7 +351,7 @@ export namespace workflowexecutions_v1 { */ orderingKey?: string | null; /** - * Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. + * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ publishTime?: string | null; } @@ -1146,11 +1146,11 @@ export namespace workflowexecutions_v1 { export interface Params$Resource$Projects$Locations$Workflows$Executions$List extends StandardParameters { /** - * Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `startTime\>"2023-08-01" AND state="FAILED"` + * Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `startTime\>"2023-08-01" AND state="FAILED"` */ filter?: string; /** - * Optional. Comma-separated list of fields that specify the ordering applied to the `[Executions.ListExecutions]` results. By default the ordering is based on descending `startTime`. The following fields are supported for ordering: `executionId`, `state`, `startTime`, `endTime`, `duration`, and `workflowRevisionId`. For details, see AIP-132. + * Optional. Comma-separated list of fields that specify the ordering applied to the `[Executions.ListExecutions]` results. By default the ordering is based on descending `createTime`. The following fields are supported for ordering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, and `workflowRevisionId`. For details, see AIP-132. */ orderBy?: string; /** From 16b6d9b6ec9205b6da2e835661011c890644a463 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 41/43] feat(workloadmanager): update the API #### workloadmanager:v1 The following keys were added: - schemas.Rule.properties.tags.description - schemas.Rule.properties.tags.items.type - schemas.Rule.properties.tags.type - schemas.ScannedResource.properties.type.description - schemas.ScannedResource.properties.type.type --- discovery/workloadmanager-v1.json | 13 ++++++++++++- src/apis/workloadmanager/v1.ts | 8 ++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index 1df5a9e4d8..8689805982 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -707,7 +707,7 @@ } } }, - "revision": "20240103", + "revision": "20240117", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "BigQueryDestination": { @@ -1329,6 +1329,13 @@ "description": "the severity of the rule", "type": "string" }, + "tags": { + "description": "List of user-defined tags", + "items": { + "type": "string" + }, + "type": "array" + }, "uri": { "description": "the docuement url for the rule", "type": "string" @@ -1696,6 +1703,10 @@ "resource": { "description": "resource name", "type": "string" + }, + "type": { + "description": "resource type", + "type": "string" } }, "type": "object" diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index 1e1d07bfc8..75995077fc 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -571,6 +571,10 @@ export namespace workloadmanager_v1 { * the severity of the rule */ severity?: string | null; + /** + * List of user-defined tags + */ + tags?: string[] | null; /** * the docuement url for the rule */ @@ -806,6 +810,10 @@ export namespace workloadmanager_v1 { * resource name */ resource?: string | null; + /** + * resource type + */ + type?: string | null; } /** * A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data. From 81bbc269b886147d53031360f1db9a840852e0d5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 42/43] feat(workstations): update the API #### workstations:v1beta The following keys were added: - schemas.GceInstance.properties.disableSsh.description - schemas.GceInstance.properties.disableSsh.type The following keys were changed: - schemas.Binding.properties.role.description #### workstations:v1 The following keys were changed: - schemas.Binding.properties.role.description --- discovery/workstations-v1.json | 4 ++-- discovery/workstations-v1beta.json | 8 ++++++-- src/apis/workstations/v1.ts | 2 +- src/apis/workstations/v1beta.ts | 6 +++++- 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index 442adecce6..f136b5d5b1 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -1195,7 +1195,7 @@ } } }, - "revision": "20240117", + "revision": "20240130", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "AuditConfig": { @@ -1262,7 +1262,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`.", + "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" } }, diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index e3849758c0..08b0fb4b40 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -1127,7 +1127,7 @@ } } }, - "revision": "20240117", + "revision": "20240130", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1210,7 +1210,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`.", + "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" } }, @@ -1362,6 +1362,10 @@ "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.", "type": "boolean" diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index 2c43996079..fbcd4061f3 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -163,7 +163,7 @@ export namespace workstations_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index 1993019707..6bf51455b7 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -176,7 +176,7 @@ export namespace workstations_v1beta { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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; } @@ -298,6 +298,10 @@ export namespace workstations_v1beta { * 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). */ disablePublicIpAddresses?: boolean | null; + /** + * Optional. Whether to disable SSH access to the VM. + */ + 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. */ From 3b14c4a34294fe93e88859212f3a97cec791ea42 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 7 Feb 2024 01:29:19 +0000 Subject: [PATCH 43/43] feat: regenerate index files --- discovery/aiplatform-v1.json | 110 +++++++++++++------------- discovery/aiplatform-v1beta1.json | 104 ++++++++++++------------ discovery/chat-v1.json | 4 +- discovery/dataportability-v1beta.json | 82 ++++++++++++++++--- discovery/index.json | 6 +- 5 files changed, 181 insertions(+), 125 deletions(-) diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 26748fc21d..7cf0266c33 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -20,39 +20,39 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "location": "asia-east1", + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/" + "location": "asia-east1" }, { - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", "location": "asia-east2" }, { + "location": "asia-northeast1", "description": "Locational Endpoint", - "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", - "location": "asia-northeast1" + "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/" }, { - "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", - "description": "Locational Endpoint" + "location": "asia-northeast3" }, { "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "asia-south1" + "location": "asia-south1", + "description": "Locational Endpoint" }, { + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", "location": "asia-southeast1", - "description": "Locational Endpoint", - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { "location": "asia-southeast2", @@ -60,8 +60,8 @@ "description": "Locational Endpoint" }, { - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "location": "australia-southeast1" }, { @@ -70,9 +70,9 @@ "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" }, { - "location": "europe-central2", "description": "Locational Endpoint", - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", + "location": "europe-central2" }, { "location": "europe-north1", @@ -80,114 +80,114 @@ "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "location": "europe-southwest1", - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" }, { "location": "europe-west1", - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", - "location": "europe-west2" + "location": "europe-west2", + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "europe-west3", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/" }, { - "location": "europe-west4", + "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/" + "location": "europe-west4" }, { - "location": "europe-west6", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", + "location": "europe-west6" }, { - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "europe-west8" + "location": "europe-west8", + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" }, { "location": "europe-west9", - "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", - "location": "me-west1" + "location": "me-west1", + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/" }, { "location": "northamerica-northeast1", - "description": "Locational Endpoint", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", - "location": "northamerica-northeast2" + "location": "northamerica-northeast2", + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" }, { "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", - "location": "southamerica-east1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "southamerica-east1" }, { - "description": "Locational Endpoint", "location": "southamerica-west1", + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" }, { "location": "us-central1", - "description": "Locational Endpoint", - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-central2", - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" + "location": "us-central2" }, { - "location": "us-east1", + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/" + "location": "us-east1" }, { - "description": "Locational Endpoint", "location": "us-east4", + "description": "Locational Endpoint", "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" }, { - "location": "us-south1", + "description": "Locational Endpoint", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-south1" }, { - "location": "us-west1", "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-west1" }, { + "location": "us-west2", "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "us-west2" + "description": "Locational Endpoint" }, { - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", "location": "us-west3", + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", - "location": "us-west4", - "description": "Locational Endpoint" + "location": "us-west4" } ], "fullyEncodeReservedExpansion": true, diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 77f23cd3ed..dde459c211 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -20,29 +20,29 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "asia-east1", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/" }, { + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "asia-east2", - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" + "location": "asia-east2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", - "location": "asia-northeast1", - "description": "Locational Endpoint" + "location": "asia-northeast1" }, { - "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "location": "asia-northeast2" + "location": "asia-northeast2", + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "asia-northeast3", - "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { "location": "asia-south1", @@ -50,18 +50,18 @@ "description": "Locational Endpoint" }, { - "location": "asia-southeast1", "description": "Locational Endpoint", - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", + "location": "asia-southeast1" }, { - "description": "Locational Endpoint", "location": "asia-southeast2", + "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "australia-southeast1" }, { @@ -70,13 +70,13 @@ "description": "Locational Endpoint" }, { - "location": "europe-central2", + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" + "location": "europe-central2" }, { - "description": "Locational Endpoint", "location": "europe-north1", + "description": "Locational Endpoint", "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" }, { @@ -90,29 +90,29 @@ "description": "Locational Endpoint" }, { + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "europe-west2", - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" + "location": "europe-west2" }, { + "location": "europe-west3", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "location": "europe-west3" + "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/" }, { "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "europe-west4" + "location": "europe-west4", + "description": "Locational Endpoint" }, { + "location": "europe-west6", "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "europe-west6" + "description": "Locational Endpoint" }, { "location": "europe-west8", - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" }, { "location": "europe-west9", @@ -120,64 +120,64 @@ "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "me-west1", - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { + "location": "northamerica-northeast1", "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "northamerica-northeast1" + "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Locational Endpoint" + "location": "northamerica-northeast2" }, { - "description": "Locational Endpoint", "location": "southamerica-east1", + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "southamerica-west1", - "description": "Locational Endpoint" + "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" }, { - "location": "us-central1", "description": "Locational Endpoint", - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", + "location": "us-central1" }, { "location": "us-central2", - "description": "Locational Endpoint", - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "location": "us-east1", - "description": "Locational Endpoint" + "location": "us-east1" }, { - "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-east4" + "location": "us-east4", + "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", - "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "location": "us-south1" + "location": "us-south1", + "endpointUrl": "https://us-south1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", - "location": "us-west1" + "location": "us-west1", + "description": "Locational Endpoint" }, { "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "location": "us-west2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-west2" }, { "description": "Locational Endpoint", @@ -185,9 +185,9 @@ "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", "location": "us-west4", - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" + "description": "Locational Endpoint" } ], "fullyEncodeReservedExpansion": true, diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index cf7e02ca82..8a52d928ec 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -39,7 +39,7 @@ "description": "View messages and reactions in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces": { - "description": "Create conversations and spaces and view or update metadata (including history settings) in Google Chat" + "description": "Create conversations and spaces and see or edit metadata (including history settings and access settings) in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces.create": { "description": "Create new conversations in Google Chat" @@ -990,7 +990,7 @@ } } }, - "revision": "20240128", + "revision": "20240201", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { diff --git a/discovery/dataportability-v1beta.json b/discovery/dataportability-v1beta.json index ed621367dc..112e9a834c 100644 --- a/discovery/dataportability-v1beta.json +++ b/discovery/dataportability-v1beta.json @@ -5,6 +5,30 @@ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": { "description": "Move a copy of messages between you and the businesses you have conversations with." }, + "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 search activity." }, @@ -21,40 +45,40 @@ "description": "Move a copy of reviews you wrote about products or online stores." }, "https://www.googleapis.com/auth/dataportability.youtube.channel": { - "description": "Move a copy of information about your 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 comments." + "description": "Move a copy of your YouTube comments." }, "https://www.googleapis.com/auth/dataportability.youtube.live_chat": { - "description": "Move a copy of your messages in 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." + "description": "Move a copy of your uploaded YouTube music tracks and your YouTube music library." }, "https://www.googleapis.com/auth/dataportability.youtube.private_playlists": { - "description": "Move a copy of your 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 videos and information about them." + "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 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 videos and information about them." + "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 YouTube Shopping Wishlists, and wishlist items." + "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 channel subscriptions, even if they're private." + "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 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 videos and information about them." + "description": "Move a copy of your unlisted YouTube videos and information about them." } } } @@ -181,6 +205,14 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "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", @@ -226,6 +258,14 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "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", @@ -265,6 +305,14 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "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", @@ -304,6 +352,14 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "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", @@ -326,7 +382,7 @@ } } }, - "revision": "20240131", + "revision": "20240204", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/index.json b/discovery/index.json index e0a0cded7b..9ee2847c9a 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -772,7 +772,7 @@ "name": "batch", "version": "v1", "title": "Batch API", - "description": "An API to manage the running of batch jobs on Google Cloud Platform.", + "description": "An API to manage the running of batch resources on Google Cloud Platform.", "discoveryRestUrl": "https://batch.googleapis.com/$discovery/rest?version=v1", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", @@ -2559,8 +2559,8 @@ "id": "dlp:v2", "name": "dlp", "version": "v2", - "title": "Cloud Data Loss Prevention (DLP)", - "description": "Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.", + "title": "Sensitive Data Protection (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.", "discoveryRestUrl": "https://dlp.googleapis.com/$discovery/rest?version=v2", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",